Communication

ResourceClinical · Request & ResponseTrial useMaturity 2

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

14 of 15 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Unique identifier
instantiatesCanonicalΣ	0..*	canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)	Instantiates FHIR protocol or definition
instantiatesUriΣ	0..*	uri	Instantiates external protocol or definition
basedOnΣ	0..*	Reference(Resource)	Request fulfilled by this communication
partOfΣ	0..*	Reference(Resource)	Part of this action
inResponseTo	0..*	Reference(Communication)	Reply to
statusRequired?!Σ	1..1	code	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknownBinding (required): event-status
statusReasonΣ	0..1	CodeableConcept	Reason for current statusBinding (example): communication-not-done-reason
category	0..*	CodeableConcept	Message categoryBinding (example): communication-category
priorityΣ	0..1	code	routine | urgent | asap | statBinding (required): request-priority
medium	0..*	CodeableConcept	A channel of communicationBinding (example): v3-ParticipationMode
subjectΣ	0..1	Reference(Patient | Group)	Focus of message
topic	0..1	CodeableConcept	Description of the purpose/contentBinding (example): communication-topic
about	0..*	Reference(Resource)	Resources that pertain to this communication
encounterΣ	0..1	Reference(Encounter)	Encounter created as part of
sent	0..1	dateTime	When sent
received	0..1	dateTime	When received
recipient	0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	Message recipient
sender	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	Message sender
reasonCodeΣ	0..*	CodeableConcept	Indication for messageBinding (example): clinical-findings
reasonReferenceΣ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why was communication done?
payload	0..*	BackboneElement	Message payload
content[x]Required	1..1	string | Attachment | Reference(Resource)	Message part content
note	0..*	Annotation	Comments made about the communication

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Communication?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
based-on	reference	Request fulfilled by this communication Communication.basedOn
category	token	Message category Communication.category
encounter	reference	Encounter created as part of Communication.encounter
identifier	token	Unique identifier Communication.identifier
instantiates-canonical	reference	Instantiates FHIR protocol or definition Communication.instantiatesCanonical
instantiates-uri	uri	Instantiates external protocol or definition Communication.instantiatesUri
medium	token	A channel of communication Communication.medium
part-of	reference	Part of this action Communication.partOf
patient	reference	Focus of message Communication.subject.where(resolve() is Patient)
received	date	When received Communication.received
recipient	reference	Message recipient Communication.recipient
sender	reference	Message sender Communication.sender
sent	date	When sent Communication.sent
status	token	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Communication.status
subject	reference	Focus of message Communication.subject

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition