This resource is a record of a communication. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The sender and receivers may be patients, practitioners, related persons, organizations, or devices.
Communication | I | Communication | There are no (further) constraints on this element Element idCommunication A record of information transmitted from a sender to a receiver DefinitionAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCommunication.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idCommunication.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCommunication.identifier Unique identifier DefinitionIdentifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
|
definition | Σ I | 0..* | Reference(PlanDefinition | ActivityDefinition) | There are no (further) constraints on this element Element idCommunication.definition Instantiates protocol or definition DefinitionA protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(PlanDefinition | ActivityDefinition) Constraints
|
basedOn | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOn Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc.
|
partOf | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOf Part of this action Alternate namescontainer DefinitionPart of this action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.status preparation | in-progress | suspended | aborted | completed | entered-in-error DefinitionThe status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. The status of the communication. EventStatus (required)Constraints
|
notDone | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.notDone Communication did not occur DefinitionIf true, indicates that the described communication event did not actually occur. Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is.
|
notDoneReason | Σ I | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.notDoneReason Why communication did not occur DefinitionDescribes why the communication event did not occur in coded and/or textual form. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for the reason why a communication was not done. CommunicationNotDoneReason (example)Constraints
|
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.category Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instruction, etc. CommunicationCategory (example)Constraints
| |
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.medium A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for communication mediums such as phone, fax, email, in person, etc. v3 Code System ParticipationMode (example)Constraints
| |
subject | Σ I | 0..1 | Reference(Group | CareConnect-Patient-1) | Element idCommunication.subject Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Group | CareConnect-Patient-1) Constraints
|
recipient | I | 0..* | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | Element idCommunication.recipient Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) Constraints
|
topic | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.topic Focal resources DefinitionThe resources which were responsible for or related to producing this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
context | Σ I | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Element idCommunication.context Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter within which the communication was sent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) Constraints
|
sent | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sent When sent DefinitionThe time when this communication was sent.
| |
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.received When received DefinitionThe time when this communication arrived at the destination.
| |
sender | I | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | Element idCommunication.sender Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCode Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be caprued using reasonCode.text. Codes for describing reasons for the occurrence of a communication. SNOMED CT Clinical Findings (example)Constraints
|
reasonReference | Σ I | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Element idCommunication.reasonReference Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Observation-1 | CareConnect-Condition-1) Constraints
|
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunication.payload Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.payload.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x] Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication).
| ||
contentString | string | There are no (further) constraints on this element Data type | ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idCommunication.note Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Communication | I | Communication | There are no (further) constraints on this element Element idCommunication A record of information transmitted from a sender to a receiver DefinitionAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCommunication.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idCommunication.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCommunication.identifier Unique identifier DefinitionIdentifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
|
definition | Σ I | 0..* | Reference(PlanDefinition | ActivityDefinition) | There are no (further) constraints on this element Element idCommunication.definition Instantiates protocol or definition DefinitionA protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(PlanDefinition | ActivityDefinition) Constraints
|
basedOn | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOn Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc.
|
partOf | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOf Part of this action Alternate namescontainer DefinitionPart of this action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.status preparation | in-progress | suspended | aborted | completed | entered-in-error DefinitionThe status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. The status of the communication. EventStatus (required)Constraints
|
notDone | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.notDone Communication did not occur DefinitionIf true, indicates that the described communication event did not actually occur. Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is.
|
notDoneReason | Σ I | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.notDoneReason Why communication did not occur DefinitionDescribes why the communication event did not occur in coded and/or textual form. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for the reason why a communication was not done. CommunicationNotDoneReason (example)Constraints
|
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.category Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instruction, etc. CommunicationCategory (example)Constraints
| |
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.medium A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for communication mediums such as phone, fax, email, in person, etc. v3 Code System ParticipationMode (example)Constraints
| |
subject | Σ I | 0..1 | Reference(Group | CareConnect-Patient-1) | Element idCommunication.subject Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Group | CareConnect-Patient-1) Constraints
|
recipient | I | 0..* | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | Element idCommunication.recipient Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) Constraints
|
topic | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.topic Focal resources DefinitionThe resources which were responsible for or related to producing this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
context | Σ I | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Element idCommunication.context Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter within which the communication was sent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) Constraints
|
sent | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sent When sent DefinitionThe time when this communication was sent.
| |
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.received When received DefinitionThe time when this communication arrived at the destination.
| |
sender | I | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | Element idCommunication.sender Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCode Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be caprued using reasonCode.text. Codes for describing reasons for the occurrence of a communication. SNOMED CT Clinical Findings (example)Constraints
|
reasonReference | Σ I | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Element idCommunication.reasonReference Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Observation-1 | CareConnect-Condition-1) Constraints
|
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunication.payload Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.payload.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x] Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication).
| ||
contentString | string | There are no (further) constraints on this element Data type | ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idCommunication.note Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Communication | I | Communication | There are no (further) constraints on this element Element idCommunication A record of information transmitted from a sender to a receiver DefinitionAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCommunication.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idCommunication.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCommunication.identifier Unique identifier DefinitionIdentifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
|
definition | Σ I | 0..* | Reference(PlanDefinition | ActivityDefinition) | There are no (further) constraints on this element Element idCommunication.definition Instantiates protocol or definition DefinitionA protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(PlanDefinition | ActivityDefinition) Constraints
|
basedOn | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOn Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc.
|
partOf | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOf Part of this action Alternate namescontainer DefinitionPart of this action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.status preparation | in-progress | suspended | aborted | completed | entered-in-error DefinitionThe status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. The status of the communication. EventStatus (required)Constraints
|
notDone | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.notDone Communication did not occur DefinitionIf true, indicates that the described communication event did not actually occur. Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is.
|
notDoneReason | Σ I | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.notDoneReason Why communication did not occur DefinitionDescribes why the communication event did not occur in coded and/or textual form. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for the reason why a communication was not done. CommunicationNotDoneReason (example)Constraints
|
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.category Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instruction, etc. CommunicationCategory (example)Constraints
| |
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.medium A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for communication mediums such as phone, fax, email, in person, etc. v3 Code System ParticipationMode (example)Constraints
| |
subject | Σ I | 0..1 | Reference(Group | CareConnect-Patient-1) | Element idCommunication.subject Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Group | CareConnect-Patient-1) Constraints
|
recipient | I | 0..* | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | Element idCommunication.recipient Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) Constraints
|
topic | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.topic Focal resources DefinitionThe resources which were responsible for or related to producing this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
context | Σ I | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Element idCommunication.context Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter within which the communication was sent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) Constraints
|
sent | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sent When sent DefinitionThe time when this communication was sent.
| |
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.received When received DefinitionThe time when this communication arrived at the destination.
| |
sender | I | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | Element idCommunication.sender Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCode Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be caprued using reasonCode.text. Codes for describing reasons for the occurrence of a communication. SNOMED CT Clinical Findings (example)Constraints
|
reasonReference | Σ I | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | Element idCommunication.reasonReference Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Observation-1 | CareConnect-Condition-1) Constraints
|
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunication.payload Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.payload.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.payload.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x] Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication).
| ||
contentString | string | There are no (further) constraints on this element Data type | ||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idCommunication.note Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Communication | .. | |
Communication.subject | Reference(Group | CareConnect-Patient-1) | .. |
Communication.recipient | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | .. |
Communication.context | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | .. |
Communication.sender | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | .. |
Communication.reasonReference | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | .. |
There is no specific guidance for this profile.