FHIR Clinical Guidelines (v1.0.0) (STU1)

This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-cpg-communication

Introduction:

This is an activity event profile

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communication

Documents a communication with a patient or other participant as an activity within the context of a computable clinical practice guideline

This profile builds on Communication.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred

... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature

... identifier S0..*IdentifierUnique identifier
... instantiatesCanonical S0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Source
... basedOn S0..*Reference(CPGCommunicationRequest)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
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred


... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (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(CPGCommunicationRequest)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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred

... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature

... identifier S0..*IdentifierUnique identifier
... instantiatesCanonical S0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Source
... basedOn S0..*Reference(CPGCommunicationRequest)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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-instantiatesCaseFeature S0..1canonical(StructureDefinition)Definition of this case feature
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
... cpg-caseFeatureType S0..1codeasserted | inferred
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred


... cpg-caseFeaturePertinence S0..1codeweakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence (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(CPGCommunicationRequest)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

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexampleParticipationMode
Communication.topicexampleCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CommunicationIf 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-4CommunicationIf 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-5CommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Communication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:instantiatesCaseFeatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extension:instantiatesCaseFeatureMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:caseFeatureTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extension:caseFeatureTypeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:caseFeaturePertinenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extension:caseFeaturePertinenceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.inResponseToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.mediumAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.aboutAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.sentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.receivedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.recipientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payload.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.payload.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payload.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.payload.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payload.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())