QI-Core Implementation Guide
5.0.0 - STU5 United States of America flag

QI-Core Implementation Guide, published by http://www.hl7.org/Special/committees/cqi/index.cfm. This is not an authorized publication; it is the continuous build for version 5.0.0). 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

Resource Profile: QICore Communication

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communication Version: 5.0.0
Active as of 2018-08-22 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.

Usage

See the patterns page for implementation and usage patterns.

To create an expression specifically requesting information that a communication intentionally did not occur for a medical, patient or system reason, use the profile QICore-communicationnotdone.

The Communication and CommunicationNotDone profiles represent the positive and negative statements for a communication event. To ensure instances retrieved meet positive intent, applications should check the status as illustrated in this example:

define Communication:
  [Communication] C
    where C.status in { 'preparation', 'in-progress', 'on-hold', 'completed' }

Examples

Written Alert Example

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
... status S1..1codepreparation | in-progress | on-hold | stopped | completed | entered-in-error | unknown
Binding: Non-Negative Event Status (required)
... statusReason S0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (preferred)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (preferred)
... subject S0..1Reference(QICore Patient | Group)Focus of message
... topic S0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (preferred)
... encounter S0..1Reference(QICore Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group)Message recipient
... sender S0..1Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson)Message sender

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Communication.statusrequiredNonNegativeEventStatus
Communication.statusReasonpreferredCommunicationNotDoneReason
Communication.categorypreferredCommunicationCategory
Communication.topicpreferredCommunicationTopic
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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codepreparation | in-progress | on-hold | stopped | completed | entered-in-error | unknown
Binding: Non-Negative Event Status (required)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (preferred)
... medium S0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject SΣ0..1Reference(QICore Patient | Group)Focus of message
... topic S0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (preferred)
... encounter SΣ0..1Reference(QICore Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group)Message recipient
... sender S0..1Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson)Message sender

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Communication.statusrequiredNonNegativeEventStatus
Communication.statusReasonpreferredCommunicationNotDoneReason
Communication.categorypreferredCommunicationCategory
Communication.mediumexampleParticipationMode
Communication.topicpreferredCommunicationTopic

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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource)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 | on-hold | stopped | completed | entered-in-error | unknown
Binding: Non-Negative Event Status (required)
... statusReason SΣ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (preferred)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (preferred)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

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


... subject SΣ0..1Reference(QICore Patient | Group)Focus of message
... topic S0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (preferred)
... about 0..*Reference(Resource)Resources that pertain to this communication
... encounter SΣ0..1Reference(QICore Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group)Message recipient
... sender S0..1Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson)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.statusrequiredNonNegativeEventStatus
Communication.statusReasonpreferredCommunicationNotDoneReason
Communication.categorypreferredCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexampleParticipationMode
Communication.topicpreferredCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

IdGradePath(s)DetailsRequirements
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
... status S1..1codepreparation | in-progress | on-hold | stopped | completed | entered-in-error | unknown
Binding: Non-Negative Event Status (required)
... statusReason S0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (preferred)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (preferred)
... subject S0..1Reference(QICore Patient | Group)Focus of message
... topic S0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (preferred)
... encounter S0..1Reference(QICore Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group)Message recipient
... sender S0..1Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson)Message sender

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Communication.statusrequiredNonNegativeEventStatus
Communication.statusReasonpreferredCommunicationNotDoneReason
Communication.categorypreferredCommunicationCategory
Communication.topicpreferredCommunicationTopic

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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codepreparation | in-progress | on-hold | stopped | completed | entered-in-error | unknown
Binding: Non-Negative Event Status (required)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (preferred)
... medium S0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject SΣ0..1Reference(QICore Patient | Group)Focus of message
... topic S0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (preferred)
... encounter SΣ0..1Reference(QICore Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group)Message recipient
... sender S0..1Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson)Message sender

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Communication.statusrequiredNonNegativeEventStatus
Communication.statusReasonpreferredCommunicationNotDoneReason
Communication.categorypreferredCommunicationCategory
Communication.mediumexampleParticipationMode
Communication.topicpreferredCommunicationTopic

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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource)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 | on-hold | stopped | completed | entered-in-error | unknown
Binding: Non-Negative Event Status (required)
... statusReason SΣ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (preferred)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (preferred)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.

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


... subject SΣ0..1Reference(QICore Patient | Group)Focus of message
... topic S0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (preferred)
... about 0..*Reference(Resource)Resources that pertain to this communication
... encounter SΣ0..1Reference(QICore Encounter)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... recipient S0..*Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson | Group)Message recipient
... sender S0..1Reference(QICore Device | US Core Implantable Device Profile | QICore Organization | QICore Patient | QICore Practitioner | QICore RelatedPerson)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.statusrequiredNonNegativeEventStatus
Communication.statusReasonpreferredCommunicationNotDoneReason
Communication.categorypreferredCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexampleParticipationMode
Communication.topicpreferredCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

IdGradePath(s)DetailsRequirements
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