This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
QICore-Communication
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="qicore-communication"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <url value="http://hl7.org/fhir/StructureDefinition/qicore-communication"/> <name value="QICore-Communication"/> <status value="draft"/> <publisher value="Health Level Seven International (Clinical Quality Information - QICore)"/> <contact> <telecom> <system value="other"/> <value value="http://hl7.org/special/committees/CQI"/> </telecom> </contact> <date value="2015-02-27"/> <description value="Profile of Communication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors."/> <fhirVersion value="1.4.0"/> <mapping> <identity value="qdm"/> <uri value="http://www.healthit.gov/quality-data-model"/> <name value="Quality Data Model"/> </mapping> <kind value="resource"/> <abstract value="false"/> <baseType value="Communication"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Communication"/> <derivation value="constraint"/> <snapshot> <element> <path value="Communication"/> <name value="QICore-Communication"/> <short value="A record of information transmitted from a sender to a receiver"/> <definition value="An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition."/> <min value="0"/> <max value="*"/> <base> <path value="Communication"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Communication"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="workflow.encounter"/> </mapping> <mapping> <identity value="qdm"/> <map value=""Communication: From Patient to Provider" and "Communication: From Provider to Patient" and "Communication: From Provider to Provider"; "Intervention, Performed" (when Communication.status="completed")"/> </mapping> </element> <element> <path value="Communication.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element> <path value="Communication.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element> <path value="Communication.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element> <path value="Communication.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="*"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="Communication.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="Communication.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Communication.extension"/> <name value="Communication.reasonNotPerformed"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/communication-reasonNotPerformed"/> </type> <binding> <strength value="example"/> <description value="Reason communication was not performed"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/qicore-communication-reason-not-performed"/> </valueSetReference> </binding> <mapping> <identity value="qdm"/> <map value="negation rationale (when Communication.status="rejected")"/> </mapping> </element> <element> <path value="Communication.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Communication.identifier"/> <short value="Unique identifier"/> <definition value="Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."/> <min value="0"/> <max value="*"/> <base> <path value="Communication.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element> <path value="Communication.category"/> <short value="Message category"/> <definition value="The type of message conveyed such as alert, notification, reminder, instruction, etc."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.category"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="example"/> <description value="Codes for general categories of communications such as alerts, instruction, etc."/> </binding> <mapping> <identity value="w5"/> <map value="class"/> </mapping> <mapping> <identity value="qdm"/> <map value="primary code"/> </mapping> </element> <element> <path value="Communication.sender"/> <short value="Message sender"/> <definition value="The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.sender"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-relatedperson"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-organization"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="who.actor"/> </mapping> </element> <element> <path value="Communication.recipient"/> <short value="Message recipient"/> <definition value="The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Â Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time)."/> <min value="0"/> <max value="*"/> <base> <path value="Communication.recipient"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-organization"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-relatedperson"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element> <path value="Communication.payload"/> <short value="Message payload"/> <definition value="Text, attachment(s), or resource(s) that was communicated to the recipient."/> <min value="0"/> <max value="*"/> <base> <path value="Communication.payload"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <isSummary value="true"/> </element> <element> <path value="Communication.payload.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Communication.payload.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Communication.payload.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Communication.payload.content[x]"/> <short value="Message part content"/> <definition value="A communicated content (or for multi-part communications, one portion of the communication)."/> <min value="1"/> <max value="1"/> <base> <path value="Communication.payload.content[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <isSummary value="true"/> </element> <element> <path value="Communication.medium"/> <short value="A channel of communication"/> <definition value="A channel that was used for this communication (e.g. email, fax)."/> <min value="0"/> <max value="*"/> <base> <path value="Communication.medium"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="example"/> <description value="The type of channel used for the communication, for example, telephone, fax, email."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/qicore-communication-medium"/> </valueSetReference> </binding> </element> <element> <path value="Communication.status"/> <short value="in-progress | completed | suspended | rejected | failed"/> <definition value="The status of the transmission."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.status"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The status of the communication."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/communication-status"/> </valueSetReference> </binding> <mapping> <identity value="w5"/> <map value="status"/> </mapping> <mapping> <identity value="qdm"/> <map value="status"/> </mapping> </element> <element> <path value="Communication.encounter"/> <short value="Encounter leading to message"/> <definition value="The encounter within which the communication was sent."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-encounter"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="context"/> </mapping> </element> <element> <path value="Communication.sent"/> <short value="When sent"/> <definition value="The time when this communication was sent."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.sent"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="when.init"/> </mapping> <mapping> <identity value="qdm"/> <map value="start datetime"/> </mapping> </element> <element> <path value="Communication.received"/> <short value="When received"/> <definition value="The time when this communication arrived at the destination."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.received"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> <mapping> <identity value="qdm"/> <map value="stop datetime"/> </mapping> </element> <element> <path value="Communication.reason"/> <short value="Indication for message"/> <definition value="The reason or justification for the communication."/> <min value="0"/> <max value="*"/> <base> <path value="Communication.reason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="example"/> <description value="Codes for describing reasons for the occurrence of a communication."/> </binding> <mapping> <identity value="qdm"/> <map value="reason"/> </mapping> </element> <element> <path value="Communication.subject"/> <short value="Focus of message"/> <definition value="The patient who was the focus of this communication."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.subject"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-patient"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element> <path value="Communication.requestDetail"/> <short value="CommunicationRequest producing this message"/> <definition value="The communication request that was responsible for producing this communication."/> <min value="0"/> <max value="1"/> <base> <path value="Communication.requestDetail"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/CommunicationRequest"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="context"/> </mapping> </element> </snapshot> <differential> <element> <path value="Communication"/> <name value="QICore-Communication"/> <min value="0"/> <max value="*"/> <type> <code value="Communication"/> </type> <mapping> <identity value="qdm"/> <map value=""Communication: From Patient to Provider" and "Communication: From Provider to Patient" and "Communication: From Provider to Provider"; "Intervention, Performed" (when Communication.status="completed")"/> </mapping> </element> <element> <path value="Communication.extension"/> <name value="Communication.reasonNotPerformed"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/communication-reasonNotPerformed"/> </type> <binding> <strength value="example"/> <description value="Reason communication was not performed"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/qicore-communication-reason-not-performed"/> </valueSetReference> </binding> <mapping> <identity value="qdm"/> <map value="negation rationale (when Communication.status="rejected")"/> </mapping> </element> <element> <path value="Communication.category"/> <mustSupport value="true"/> <mapping> <identity value="qdm"/> <map value="primary code"/> </mapping> </element> <element> <path value="Communication.sender"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-relatedperson"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-organization"/> </type> <mustSupport value="true"/> </element> <element> <path value="Communication.recipient"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-organization"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-relatedperson"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <mustSupport value="true"/> </element> <element> <path value="Communication.medium"/> <binding> <strength value="example"/> <description value="The type of channel used for the communication, for example, telephone, fax, email."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/qicore-communication-medium"/> </valueSetReference> </binding> </element> <element> <path value="Communication.status"/> <mustSupport value="true"/> <mapping> <identity value="qdm"/> <map value="status"/> </mapping> </element> <element> <path value="Communication.encounter"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-encounter"/> </type> <mustSupport value="true"/> </element> <element> <path value="Communication.sent"/> <mustSupport value="true"/> <mapping> <identity value="qdm"/> <map value="start datetime"/> </mapping> </element> <element> <path value="Communication.received"/> <mustSupport value="true"/> <mapping> <identity value="qdm"/> <map value="stop datetime"/> </mapping> </element> <element> <path value="Communication.reason"/> <mapping> <identity value="qdm"/> <map value="reason"/> </mapping> </element> <element> <path value="Communication.subject"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/qicore-patient"/> </type> <mustSupport value="true"/> </element> </differential> </StructureDefinition>