Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communication | Version: 2.0.0-ballot | |||
| Active as of 2024-04-14 | Computable Name: CPGCommunication | |||
Documents a communication with a patient or other participant as an activity within the context of a computable clinical practice guideline
This is an activity event profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 instantiatesCaseFeature |
S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
| caseFeatureType |
S | 0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred |
| caseFeaturePertinence |
S | 0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature |
 identifier |
S | 0..* | Identifier | Unique identifier |
| instantiatesCanonical |
S | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Source |
 basedOn |
S | 0..* | Reference(CPG Communication Request) | Request fulfilled by this communication |
| status |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status |
| category |
S | 0..* | CodeableConcept | Message category |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| subject |
S | 0..1 | Reference(Patient | Group) | Focus of message |
| about |
S | 0..* | Reference(Resource) | Pertinent information |
| encounter |
S | 0..1 | Reference(Encounter) | Encounter created as part of |
| sent |
S | 0..1 | dateTime | When sent |
| received |
S | 0..1 | dateTime | When received |
| recipient |
S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
 sender |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| instantiatesCaseFeature |
S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
| caseFeatureType |
S | 0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred |
| caseFeaturePertinence |
S | 0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | Unique identifier |
| instantiatesCanonical |
SΣ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Source |
| basedOn |
SΣ | 0..* | Reference(CPG Communication Request) | Request fulfilled by this communication |
| status |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
| statusReason |
SΣ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. |
| category |
S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. |
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. |
| subject |
SΣ | 0..1 | Reference(Patient | Group) | Focus of message |
| about |
S | 0..* | Reference(Resource) | Pertinent information |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
| sent |
S | 0..1 | dateTime | When sent |
| received |
S | 0..1 | dateTime | When received |
| recipient |
S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | |
| Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reasonfrom the FHIR Standard | |
| Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | |
| Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| instantiatesCaseFeature |
S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | ||||
| caseFeatureType |
S | 0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred | ||||
| caseFeaturePertinence |
S | 0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | Unique identifier | ||||
| instantiatesCanonical |
SΣ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Source | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
SΣ | 0..* | Reference(CPG Communication Request) | Request fulfilled by this communication | ||||
| partOf |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
| inResponseTo |
0..* | Reference(Communication) | Reply to | |||||
| status |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
| statusReason |
SΣ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
| category |
S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | ||||
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
| medium |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject |
SΣ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| topic |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
| about |
S | 0..* | Reference(Resource) | Pertinent information | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| sent |
S | 0..1 | dateTime | When sent | ||||
| received |
S | 0..1 | dateTime | When received | ||||
| recipient |
S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | ||||
| sender |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
 payload |
0..* | BackboneElement | Message payload | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
  content[x] |
1..1 | Message part content | ||||||
 contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| note |
0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | ||||
| Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reasonfrom the FHIR Standard | ||||
| Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | ||||
| Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
| Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topicfrom the FHIR Standard | ||||
| Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Differential View
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| instantiatesCaseFeature |
S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
| caseFeatureType |
S | 0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred |
| caseFeaturePertinence |
S | 0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature |
| identifier |
S | 0..* | Identifier | Unique identifier |
| instantiatesCanonical |
S | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Source |
| basedOn |
S | 0..* | Reference(CPG Communication Request) | Request fulfilled by this communication |
| status |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status |
| category |
S | 0..* | CodeableConcept | Message category |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| subject |
S | 0..1 | Reference(Patient | Group) | Focus of message |
| about |
S | 0..* | Reference(Resource) | Pertinent information |
| encounter |
S | 0..1 | Reference(Encounter) | Encounter created as part of |
| sent |
S | 0..1 | dateTime | When sent |
| received |
S | 0..1 | dateTime | When received |
| recipient |
S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| instantiatesCaseFeature |
S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature |
| caseFeatureType |
S | 0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred |
| caseFeaturePertinence |
S | 0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Unique identifier |
| instantiatesCanonical |
SΣ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Source |
| basedOn |
SΣ | 0..* | Reference(CPG Communication Request) | Request fulfilled by this communication |
| status |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
| statusReason |
SΣ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. |
| category |
S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. |
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. |
| subject |
SΣ | 0..1 | Reference(Patient | Group) | Focus of message |
| about |
S | 0..* | Reference(Resource) | Pertinent information |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
| sent |
S | 0..1 | dateTime | When sent |
| received |
S | 0..1 | dateTime | When received |
| recipient |
S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | |
| Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reasonfrom the FHIR Standard | |
| Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | |
| Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| instantiatesCaseFeature |
S | 0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | ||||
| caseFeatureType |
S | 0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred | ||||
| caseFeaturePertinence |
S | 0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | Unique identifier | ||||
| instantiatesCanonical |
SΣ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Source | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
SΣ | 0..* | Reference(CPG Communication Request) | Request fulfilled by this communication | ||||
| partOf |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
| inResponseTo |
0..* | Reference(Communication) | Reply to | |||||
| status |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
| statusReason |
SΣ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
| category |
S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | ||||
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
| medium |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject |
SΣ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| topic |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
| about |
S | 0..* | Reference(Resource) | Pertinent information | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| sent |
S | 0..1 | dateTime | When sent | ||||
| received |
S | 0..1 | dateTime | When received | ||||
| recipient |
S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | ||||
| sender |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
| payload |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] |
1..1 | Message part content | ||||||
| contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| note |
0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Communication.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | ||||
| Communication.statusReason | example | CommunicationNotDoneReasonhttp://hl7.org/fhir/ValueSet/communication-not-done-reasonfrom the FHIR Standard | ||||
| Communication.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | ||||
| Communication.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Communication.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
| Communication.topic | example | CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topicfrom the FHIR Standard | ||||
| Communication.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cpg#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change