QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communication | Version: 7.0.0 | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: QICoreCommunication |
Profile of Communication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
The Communication profile defines the conformance expectations for a Communication event, regardless of whether it is a positive or negative statement. To ensure instances retrieved meet positive intent, applications should check the status as illustrated in this example:
define "Lab results communicated":
["Communication": "report-labs"] LabReport
where LabReport.topic = 'report-labs'
and LabReport.status = 'completed'
and LabReport.reasonCode = 'Serum pregnancy test negative (finding)'
Alternatively, applications may make use of the positive and negative profiles to address status. The CommunicationDone and CommunicationNotDone profiles represent the positive and negative statements for a communication event.
To create an expression indicating existence of a communication, use the profile QICoreCommunicationDone; to specifically request information that a communication intentionally did not occur for a medical, patient or system reason, use the profile QICoreCommunicationNotDone.
See the patterns page for implementation and usage patterns.
Written Alert Example |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management com-1: to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(QICore Patient | Group) | (QI) Focus of message ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | (QI) Description of the purpose/content Binding: CommunicationTopic (1.0.0) (preferred) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | (QI) Url of a value set of candidate topics URL: http://hl7.org/fhir/StructureDefinition/codeOptions ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When sent ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When received ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
0..* | Reference(QICore CareTeam | QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group) | (QI) Message recipient ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender ele-1: All FHIR elements must have a @value or children | |
![]() |
Path | Conformance | ValueSet | URI |
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Communication.topic | preferred | CommunicationTopichttp://terminology.hl7.org/ValueSet/communication-topic|1.0.0 |
Id | Grade | Path(s) | Details | Requirements |
com-1 | error | Communication | to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided : topic.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor (topic.coding.exists() or topic.text.exists()) | |
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver com-1: to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided |
![]() ![]() ![]() |
1..1 | code | (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown | |
![]() ![]() ![]() |
0..1 | Reference(QICore Patient | Group) | (QI) Focus of message | |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | (QI) Description of the purpose/content Binding: CommunicationTopic (1.0.0) (preferred) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | (QI) Url of a value set of candidate topics URL: http://hl7.org/fhir/StructureDefinition/codeOptions |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When sent | |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When received | |
![]() ![]() ![]() |
0..* | Reference(QICore CareTeam | QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group) | (QI) Message recipient | |
![]() ![]() ![]() |
0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender | |
![]() |
Path | Conformance | ValueSet | URI |
Communication.topic | preferred | CommunicationTopichttp://terminology.hl7.org/ValueSet/communication-topic|1.0.0 |
Id | Grade | Path(s) | Details | Requirements |
com-1 | error | Communication | to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided : topic.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor (topic.coding.exists() or topic.text.exists()) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver com-1: to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
![]() ![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(QICore Patient | Group) | (QI) Focus of message | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | (QI) Description of the purpose/content Binding: CommunicationTopic (1.0.0) (preferred) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | (QI) Url of a value set of candidate topics URL: http://hl7.org/fhir/StructureDefinition/codeOptions | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
0..1 | dateTime | (QI) When sent | |||||
![]() ![]() ![]() |
0..1 | dateTime | (QI) When received | |||||
![]() ![]() ![]() |
0..* | Reference(QICore CareTeam | QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group) | (QI) Message recipient | |||||
![]() ![]() ![]() |
0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.topic | preferred | CommunicationTopichttp://terminology.hl7.org/ValueSet/communication-topic|1.0.0 | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
com-1 | error | Communication | to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided : topic.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor (topic.coding.exists() or topic.text.exists()) | |
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Communication
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management com-1: to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(QICore Patient | Group) | (QI) Focus of message ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | (QI) Description of the purpose/content Binding: CommunicationTopic (1.0.0) (preferred) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | (QI) Url of a value set of candidate topics URL: http://hl7.org/fhir/StructureDefinition/codeOptions ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When sent ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When received ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
0..* | Reference(QICore CareTeam | QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group) | (QI) Message recipient ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender ele-1: All FHIR elements must have a @value or children | |
![]() |
Path | Conformance | ValueSet | URI |
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Communication.topic | preferred | CommunicationTopichttp://terminology.hl7.org/ValueSet/communication-topic|1.0.0 |
Id | Grade | Path(s) | Details | Requirements |
com-1 | error | Communication | to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided : topic.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor (topic.coding.exists() or topic.text.exists()) | |
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver com-1: to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided |
![]() ![]() ![]() |
1..1 | code | (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown | |
![]() ![]() ![]() |
0..1 | Reference(QICore Patient | Group) | (QI) Focus of message | |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | (QI) Description of the purpose/content Binding: CommunicationTopic (1.0.0) (preferred) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | (QI) Url of a value set of candidate topics URL: http://hl7.org/fhir/StructureDefinition/codeOptions |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When sent | |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When received | |
![]() ![]() ![]() |
0..* | Reference(QICore CareTeam | QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group) | (QI) Message recipient | |
![]() ![]() ![]() |
0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender | |
![]() |
Path | Conformance | ValueSet | URI |
Communication.topic | preferred | CommunicationTopichttp://terminology.hl7.org/ValueSet/communication-topic|1.0.0 |
Id | Grade | Path(s) | Details | Requirements |
com-1 | error | Communication | to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided : topic.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor (topic.coding.exists() or topic.text.exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Communication | A record of information transmitted from a sender to a receiver com-1: to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
![]() ![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(QICore Patient | Group) | (QI) Focus of message | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | (QI) Description of the purpose/content Binding: CommunicationTopic (1.0.0) (preferred) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | (QI) Url of a value set of candidate topics URL: http://hl7.org/fhir/StructureDefinition/codeOptions | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
0..1 | dateTime | (QI) When sent | |||||
![]() ![]() ![]() |
0..1 | dateTime | (QI) When received | |||||
![]() ![]() ![]() |
0..* | Reference(QICore CareTeam | QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group) | (QI) Message recipient | |||||
![]() ![]() ![]() |
0..1 | Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson) | (QI) Message sender | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reason from the FHIR Standard | ||||
Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category from the FHIR Standard | ||||
Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
Communication.topic | preferred | CommunicationTopichttp://terminology.hl7.org/ValueSet/communication-topic|1.0.0 | ||||
Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
com-1 | error | Communication | to indicate what communication, either at least one coding in the topic or a codeOptions extension shall be provided : topic.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor (topic.coding.exists() or topic.text.exists()) | |
dom-2 | error | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Communication
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron