QI-Core Implementation Guide: STU 3.2 (v3.2.0 for FHIR 3.0.1)

This page is part of the Quality Improvement Core Framework (v3.2.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-qicore-communication

Examples:

Written Alert Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communication

Profile of Communication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on Communication.

This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*
... id 0..1id
... basedOn 0..*Reference(Resource)
... status S1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDoneReason 0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... medium S0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject S0..1Reference(QICore-Patient)Focus of message
... recipient S0..*Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson | Group)Message recipient
... context S0..1Reference(QICore-Encounter | EpisodeOfCare)Encounter or episode leading to message
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... sender S0..1Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson)Message sender
... reasonCode 0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(Resource)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... status ?!SΣ1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... medium S0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject SΣ0..1Reference(QICore-Patient)Focus of message
... recipient S0..*Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson | Group)Message recipient
... topic 0..*Reference(Resource)Focal resources
... context SΣ0..1Reference(QICore-Encounter | EpisodeOfCare)Encounter or episode leading to message
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... sender S0..1Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson)Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition | Observation)Why was communication done?
... payload I0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1string, Attachment, Reference(Resource)Message part content
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*
... id 0..1id
... basedOn 0..*Reference(Resource)
... status S1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDoneReason 0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... medium S0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject S0..1Reference(QICore-Patient)Focus of message
... recipient S0..*Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson | Group)Message recipient
... context S0..1Reference(QICore-Encounter | EpisodeOfCare)Encounter or episode leading to message
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... sender S0..1Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson)Message sender
... reasonCode 0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(Resource)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... status ?!SΣ1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... medium S0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject SΣ0..1Reference(QICore-Patient)Focus of message
... recipient S0..*Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson | Group)Message recipient
... topic 0..*Reference(Resource)Focal resources
... context SΣ0..1Reference(QICore-Encounter | EpisodeOfCare)Encounter or episode leading to message
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... sender S0..1Reference(QICore-Device | QICore-Organization | QICore-Patient | QICore-Practitioner | QICore-RelatedPerson)Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition | Observation)Why was communication done?
... payload I0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1string, Attachment, Reference(Resource)Message part content
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Communication.statusrequiredEventStatus
Communication.categoryexampleCommunicationCategory
Communication.mediumexamplev3 Code System ParticipationMode

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-1CommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.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-3CommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
com-1CommunicationNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())