Clinical Practice Guidelines
2.0.0-ballot - ballot International flag

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

Resource Profile: CPG Communication

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communication Version: 2.0.0-ballot
Active as of 2023-12-19 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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG 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

... identifier S0..*IdentifierUnique identifier
... instantiatesCanonical S0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Source
... basedOn S0..*Reference(CPG Communication Request)Request fulfilled by this communication
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... statusReason S0..1CodeableConceptReason for current status
... category S0..*CodeableConceptMessage category
... priority S0..1coderoutine | urgent | asap | stat
... subject S0..1Reference(Patient | Group)Focus of message
... about S0..*Reference(Resource)Pertinent information
... encounter S0..1Reference(Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeaturePertinence S0..1codeCPG 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..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique 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..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.

... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

... subject SΣ0..1Reference(Patient | Group)Focus of message
... about S0..*Reference(Resource)Pertinent information
... encounter SΣ0..1Reference(Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG 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 S0..1codeCPG 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..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... instantiatesCanonical SΣ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Source
... instantiatesUri Σ0..*uriInstantiates 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..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.

... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject SΣ0..1Reference(Patient | Group)Focus of message
... topic 0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.

... about S0..*Reference(Resource)Pertinent information
... encounter SΣ0..1Reference(Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode Σ0..*CodeableConceptIndication 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..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexampleParticipationMode
Communication.topicexampleCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG 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

... identifier S0..*IdentifierUnique identifier
... instantiatesCanonical S0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Source
... basedOn S0..*Reference(CPG Communication Request)Request fulfilled by this communication
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... statusReason S0..1CodeableConceptReason for current status
... category S0..*CodeableConceptMessage category
... priority S0..1coderoutine | urgent | asap | stat
... subject S0..1Reference(Patient | Group)Focus of message
... about S0..*Reference(Resource)Pertinent information
... encounter S0..1Reference(Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeaturePertinence S0..1codeCPG 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..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique 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..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.

... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

... subject SΣ0..1Reference(Patient | Group)Focus of message
... about S0..*Reference(Resource)Pertinent information
... encounter SΣ0..1Reference(Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... instantiatesCaseFeature S0..1canonical(CPG Case Feature Definition)CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... caseFeatureType S0..1codeCPG 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 S0..1codeCPG 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..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... instantiatesCanonical SΣ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Source
... instantiatesUri Σ0..*uriInstantiates 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..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.

... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.


... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject SΣ0..1Reference(Patient | Group)Focus of message
... topic 0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.

... about S0..*Reference(Resource)Pertinent information
... encounter SΣ0..1Reference(Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender S0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode Σ0..*CodeableConceptIndication 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..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexampleParticipationMode
Communication.topicexampleCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationIf 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-4errorCommunicationIf 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-5errorCommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron