Skip to main content

Communication

PropertyValue
Publisher
NameCommunication
URLhttp://hl7.org/fhir/StructureDefinition/Communication
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Communication0..*CommunicationAn 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.
Communication.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Communication.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Communication.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Communication.language0..1codeThe base language in which the resource is written.
Communication.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Communication.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Communication.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Communication.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Communication.identifier0..*IdentifierBusiness identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Communication.instantiatesCanonical0..*canonicalThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
Communication.instantiatesUri0..*uriThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
Communication.basedOn0..*ReferenceAn order, proposal or plan fulfilled in whole or in part by this Communication.
Communication.partOf0..*ReferencePart of this action.
Communication.inResponseTo0..*ReferencePrior communication that this communication is in response to.
Communication.status1..1codeThe status of the transmission.
Communication.statusReason0..1CodeableConceptCaptures the reason for the current state of the Communication.
Communication.category0..*CodeableConceptThe type of message conveyed such as alert, notification, reminder, instruction, etc.
Communication.priority0..1codeCharacterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
Communication.medium0..*CodeableConceptA channel that was used for this communication (e.g. email, fax).
Communication.subject0..1ReferenceThe patient or group that was the focus of this communication.
Communication.topic0..1CodeableConceptDescription of the purpose/content, similar to a subject line in an email.
Communication.about0..*ReferenceOther resources that pertain to this communication and to which this communication should be associated.
Communication.encounter0..1ReferenceThe Encounter during which this Communication was created or to which the creation of this record is tightly associated.
Communication.sent0..1dateTimeThe time when this communication was sent.
Communication.received0..1dateTimeThe time when this communication arrived at the destination.
Communication.recipient0..*ReferenceThe entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Communication.sender0..1ReferenceThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
Communication.reasonCode0..*CodeableConceptThe reason or justification for the communication.
Communication.reasonReference0..*ReferenceIndicates another resource whose existence justifies this communication.
Communication.payload0..*BackboneElementText, attachment(s), or resource(s) that was communicated to the recipient.
Communication.payload.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Communication.payload.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Communication.payload.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Communication.payload.content[x]1..1stringA communicated content (or for multi-part communications, one portion of the communication).
Communication.note0..*AnnotationAdditional notes or commentary about the communication by the sender, receiver or other interested parties.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
based-onreferenceRequest fulfilled by this communicationCommunication.basedOn
categorytokenMessage categoryCommunication.category
encounterreferenceEncounter created as part ofCommunication.encounter
identifiertokenUnique identifierCommunication.identifier
instantiates-canonicalreferenceInstantiates FHIR protocol or definitionCommunication.instantiatesCanonical
instantiates-uriuriInstantiates external protocol or definitionCommunication.instantiatesUri
mediumtokenA channel of communicationCommunication.medium
part-ofreferencePart of this actionCommunication.partOf
patientreferenceFocus of messageCommunication.subject.where(resolve() is Patient)
receiveddateWhen receivedCommunication.received
recipientreferenceMessage recipientCommunication.recipient
senderreferenceMessage senderCommunication.sender
sentdateWhen sentCommunication.sent
statustokenpreparation / in-progress / not-done / on-hold / stopped / completed / entered-in-error / unknownCommunication.status
subjectreferenceFocus of messageCommunication.subject