QI-Core Implementation Guide
5.0.0 - STU5
QI-Core Implementation Guide
5.0.0 - STU5
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
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationnotdone | Version: 5.0.0 | |||
| Active as of 2018-08-22 | Computable Name: QICoreCommunicationNotDone | |||
Profile of CommunicationNotDone for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
The Communication and CommunicationNotDone profiles represent the positive and negative statements for a communication event.
| Negation Example using a single coded concept | Communication of finding of Macular Edema absent not done because patient moved away. |
This example meets measure intent for exclusion as defined in the following example CQL:
[CommunicationNotDone: "Macular edema absent (finding)"] MacularEdemaAbsentNotCommunicated
with "Diabetic Retinopathy Encounter" EncounterDiabeticRetinopathy
such that MacularEdemaAbsentNotCommunicated.sent during EncounterDiabeticRetinopathy.period
and ( MacularEdemaAbsentNotCommunicated.statusReason in "Medical Reason"
or MacularEdemaAbsentNotCommunicated.statusReason in "Patient Reason"
)For a more complete discussion of representation of negation within QICore and quality improvement artifacts, see the Negation in QI Core topic.
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 | C | 0..* | Communication | A record of information transmitted from a sender to a receiver cnd-1: to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided |
  recorded | S | 1..1 | dateTime | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded |
 status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: not-done |
 statusReason | S | 1..1 | CodeableConcept | Reason for current status Binding: QICore Negation Reason Codes (extensible) |
 subject | S | 0..1 | Reference(QICore Patient | Group) | Focus of message |
 topic | S | 1..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (preferred): Codes describing the purpose or content of the communication. |
  notDoneValueSet | S | 0..1 | canonical(ValueSet) | Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Communication.statusReason | extensible | NegationReasonCodes |
| Communication.topic | preferred | CommunicationTopic |
| Id | Grade | Path(s) | Details | Requirements |
| cnd-1 | error | Communication | to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided : topic.extension("http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet").exists() xor topic.coding.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | C | 0..* | Communication | A record of information transmitted from a sender to a receiver cnd-1: to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| recorded | S | 1..1 | dateTime | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. Fixed Value: not-done |
 statusReason | SΣ | 1..1 | CodeableConcept | Reason for current status Binding: QICore Negation Reason Codes (extensible) |
| subject | SΣ | 0..1 | Reference(QICore Patient | Group) | Focus of message |
| topic | S | 1..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (preferred): Codes describing the purpose or content of the communication. |
| notDoneValueSet | S | 0..1 | canonical(ValueSet) | Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Communication.status | required | Fixed Value: not-done |
| Communication.statusReason | extensible | NegationReasonCodes |
| Communication.topic | preferred | CommunicationTopic |
| Id | Grade | Path(s) | Details | Requirements |
| cnd-1 | error | Communication | to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided : topic.extension("http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet").exists() xor topic.coding.exists() | |
| 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 | C | 0..* | Communication | A record of information transmitted from a sender to a receiver cnd-1: to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided | ||||
| 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 | |||||
| recorded | S | 1..1 | dateTime | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique identifier | ||||
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates 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..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. Fixed Value: not-done | ||||
| statusReason | SΣ | 1..1 | CodeableConcept | Reason for current status Binding: QICore Negation Reason Codes (extensible) | ||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| priority | Σ | 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(QICore Patient | Group) | Focus of message | ||||
 topic | S | 1..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (preferred): Codes describing the purpose or content of the communication. | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| notDoneValueSet | S | 0..1 | canonical(ValueSet) | Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| sent | 0..1 | dateTime | When sent | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 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 / Code | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | Fixed Value: not-done | ||||
| Communication.statusReason | extensible | NegationReasonCodes | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | example | ParticipationMode | ||||
| Communication.topic | preferred | CommunicationTopic | ||||
| Communication.reasonCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | C | 0..* | Communication | A record of information transmitted from a sender to a receiver cnd-1: to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided |
| recorded | S | 1..1 | dateTime | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded |
| status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: not-done |
| statusReason | S | 1..1 | CodeableConcept | Reason for current status Binding: QICore Negation Reason Codes (extensible) |
| subject | S | 0..1 | Reference(QICore Patient | Group) | Focus of message |
| topic | S | 1..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (preferred): Codes describing the purpose or content of the communication. |
| notDoneValueSet | S | 0..1 | canonical(ValueSet) | Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Communication.statusReason | extensible | NegationReasonCodes |
| Communication.topic | preferred | CommunicationTopic |
| Id | Grade | Path(s) | Details | Requirements |
| cnd-1 | error | Communication | to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided : topic.extension("http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet").exists() xor topic.coding.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | C | 0..* | Communication | A record of information transmitted from a sender to a receiver cnd-1: to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| recorded | S | 1..1 | dateTime | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. Fixed Value: not-done |
| statusReason | SΣ | 1..1 | CodeableConcept | Reason for current status Binding: QICore Negation Reason Codes (extensible) |
| subject | SΣ | 0..1 | Reference(QICore Patient | Group) | Focus of message |
| topic | S | 1..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (preferred): Codes describing the purpose or content of the communication. |
| notDoneValueSet | S | 0..1 | canonical(ValueSet) | Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Communication.status | required | Fixed Value: not-done |
| Communication.statusReason | extensible | NegationReasonCodes |
| Communication.topic | preferred | CommunicationTopic |
| Id | Grade | Path(s) | Details | Requirements |
| cnd-1 | error | Communication | to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided : topic.extension("http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet").exists() xor topic.coding.exists() | |
| 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 | C | 0..* | Communication | A record of information transmitted from a sender to a receiver cnd-1: to indicate what communication was not carried out, either at least one coding in the topic or a notDoneValueSet extension shall be provided | ||||
| 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 | |||||
| recorded | S | 1..1 | dateTime | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique identifier | ||||
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates 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..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. Fixed Value: not-done | ||||
| statusReason | SΣ | 1..1 | CodeableConcept | Reason for current status Binding: QICore Negation Reason Codes (extensible) | ||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| priority | Σ | 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(QICore Patient | Group) | Focus of message | ||||
| topic | S | 1..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (preferred): Codes describing the purpose or content of the communication. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| notDoneValueSet | S | 0..1 | canonical(ValueSet) | Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| sent | 0..1 | dateTime | When sent | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 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 / Code | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | Fixed Value: not-done | ||||
| Communication.statusReason | extensible | NegationReasonCodes | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | example | ParticipationMode | ||||
| Communication.topic | preferred | CommunicationTopic | ||||
| Communication.reasonCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| 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 © 2019+ http://www.hl7.org/Special/committees/cqi/index.cfm. Package hl7.fhir.us.qicore#5.0.0 based on FHIR 4.0.1. Generated 2023-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change