Communication.profile.xml

Profile for communication

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <id value="Communication"/>
  <meta>
    <lastUpdated value="2015-02-23T09:07:27.665+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/Profile/Communication"/>
  <name value="Communication"/>
  <publisher value="HL7 FHIR Project"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="Base Profile for Communication Resource"/>
  <status value="draft"/>
  <date value="2015-02-23T09:07:27+11:00"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="Communication"/>
  <snapshot>
    <element>
      <path value="Communication"/>
      <short value="Communication"/>
      <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="1"/>
      <max value="1"/>
    </element>
    <element>
      <path value="Communication.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. 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"/>
      <type>
        <code value="id"/>
      </type>
    </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"/>
      <type>
        <code value="Meta"/>
      </type>
    </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"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier 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"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="A human language"/>
        <referenceUri 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 &quot;clinically
       safe&quot; 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."/>
      <synonym value="narrative"/>
      <synonym value="html"/>
      <synonym value="xhtml"/>
      <synonym value="display"/>
      <min value="0"/>
      <max value="1"/>
      <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."/>
      <synonym value="inline resources"/>
      <synonym value="anonymous resources"/>
      <synonym value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Communication.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 resource. 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <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="*"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="Communication.category"/>
      <short value="Message category"/>
      <definition value="The type of message such as alert, notification, reminder, instruction, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="Communication.sender"/>
      <short value="Message sender"/>
      <definition value="The entity (e.g., person, organization, clinical information system, or device) which
       is the source of the communication."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Device"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
    </element>
    <element>
      <path value="Communication.recipient"/>
      <short value="Message recipient"/>
      <definition value="The entity (e.g., person, organization, clinical information system, or device) which
       is the target of the communication."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Device"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
    </element>
    <element>
      <path value="Communication.payload"/>
      <short value="Message payload"/>
      <definition value="Text, attachment(s), or resource(s) to be communicated to the recipient."/>
      <min value="0"/>
      <max value="*"/>
    </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"/>
      <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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <synonym value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Communication.payload.content[x]"/>
      <short value="Message part content"/>
      <definition value="An individual message part for multi-part messages."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <type>
        <code value="Attachment"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Any"/>
      </type>
    </element>
    <element>
      <path value="Communication.medium"/>
      <short value="Communication medium"/>
      <definition value="The communication medium, e.g., email, fax."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </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"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="CommunicationStatus"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="The status of the communication"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/communication-status"/>
        </referenceReference>
      </binding>
    </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"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Encounter"/>
      </type>
    </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"/>
      <type>
        <code value="dateTime"/>
      </type>
    </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"/>
      <type>
        <code value="dateTime"/>
      </type>
    </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="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="Communication.subject"/>
      <short value="Focus of message"/>
      <definition value="The patient who is the focus of this communication."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Communication"/>
      <short value="Communication"/>
      <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="1"/>
      <max value="1"/>
    </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="*"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="Communication.category"/>
      <short value="Message category"/>
      <definition value="The type of message such as alert, notification, reminder, instruction, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="Communication.sender"/>
      <short value="Message sender"/>
      <definition value="The entity (e.g., person, organization, clinical information system, or device) which
       is the source of the communication."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Device"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
    </element>
    <element>
      <path value="Communication.recipient"/>
      <short value="Message recipient"/>
      <definition value="The entity (e.g., person, organization, clinical information system, or device) which
       is the target of the communication."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Device"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
    </element>
    <element>
      <path value="Communication.payload"/>
      <short value="Message payload"/>
      <definition value="Text, attachment(s), or resource(s) to be communicated to the recipient."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="Communication.payload.content[x]"/>
      <short value="Message part content"/>
      <definition value="An individual message part for multi-part messages."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <type>
        <code value="Attachment"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Any"/>
      </type>
    </element>
    <element>
      <path value="Communication.medium"/>
      <short value="Communication medium"/>
      <definition value="The communication medium, e.g., email, fax."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </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"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="CommunicationStatus"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="The status of the communication"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/communication-status"/>
        </referenceReference>
      </binding>
    </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"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Encounter"/>
      </type>
    </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"/>
      <type>
        <code value="dateTime"/>
      </type>
    </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"/>
      <type>
        <code value="dateTime"/>
      </type>
    </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="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="Communication.subject"/>
      <short value="Focus of message"/>
      <definition value="The patient who is the focus of this communication."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
    </element>
  </differential>
</Profile>