FHIR Belgium Base IG
0.1.0 -

FHIR Belgium Base IG - Local Development build (v0.1.0). See the Directory of published versions

StructureDefinition: CommunicationLogicalModel - XML Profile

XML representation of the model-communication Profile.

Narrative view of the profile 


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="model-communication"/>
  <text>
    <status value="additional"/>
    <div xmlns="http://www.w3.org/1999/xhtml">This Logical Model represents the core attributes of a Diary Note or Communication used in Belgium.</div>
  </text>
  <url
       value="https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/model-communication"/>
  <version value="0.1.0"/>
  <name value="CommunicationLogicalModel"/>
  <status value="draft"/>
  <date value="2019-12-29T09:41:09+01:00"/>
  <publisher value="HL7 Belgium"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <description
               value="This is the Logical Data Model for Communications. Communications can be:

* Messages between healthcare professionals
* Messages between professionals and the patient
* A journal of notes and communications about a patient, a patient&#39;s care or a healthcare team&#39;s activities.

This Logical Data Model is compatible with both FHIR Communication and KMEHR Diary Note, namely the selection of attributes that are supported, and the maximum length of the payload (320 characters)."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="056"/>
    </coding>
    <text value="Belgium"/>
  </jurisdiction>
  <purpose
           value="This logical model can be instantiated in the technical standards that are used in Belgium - KMEHR and FHIR. This ensures semantic compatibility between systems and standards."/>
  <fhirVersion value="4.0.1"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="BECommunication"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="BECommunication">
      <path value="BECommunication"/>
      <short value="Communication"/>
      <definition
                  value="The Communication object represents a message sent or note entered in a diary, in the context of care."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Element"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <condition value="ele-1"/>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression value="hasValue() or (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="BECommunication.id">
      <path value="BECommunication.id"/>
      <representation value="xmlAttr"/>
      <short value="Unique id for inter-element referencing"/>
      <definition
                  value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Element.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="string"/>
        </extension>
        <code value="http://hl7.org/fhirpath/System.String"/>
      </type>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="BECommunication.extension">
      <path value="BECommunication.extension"/>
      <slicing>
        <discriminator>
          <type value="value"/>
          <path value="url"/>
        </discriminator>
        <description value="Extensions are always sliced by (at least) url"/>
        <rules value="open"/>
      </slicing>
      <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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
      <comment
               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>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression value="hasValue() or (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <constraint>
        <key value="ext-1"/>
        <severity value="error"/>
        <human value="Must have either extensions or value[x], not both"/>
        <expression value="extension.exists() != value.exists()"/>
        <xpath
               value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
      </constraint>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="BECommunication.identifier">
      <path value="BECommunication.identifier"/>
      <short value="Identifier for this communication"/>
      <definition value="A unique identifier for this communication."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.identifier"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Identifier"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Identifier"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.status">
      <path value="BECommunication.status"/>
      <short value="Status of the communication"/>
      <definition value="The status of this communication entry."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="BECommunication.status"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/code"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.validated">
      <path value="BECommunication.validated"/>
      <short value="Validation status"/>
      <definition
                  value="The validation status of the communication - whether this note is validated or not."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="BECommunication.validated"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/code"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.dateTimeEntered">
      <path value="BECommunication.dateTimeEntered"/>
      <short value="Time and Date of Communication entered"/>
      <definition
                  value="Date or timestamp of entering the communication in its current status"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.dateTimeEntered"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="dateTime"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/dateTime"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.basedOn">
      <path value="BECommunication.basedOn"/>
      <short value="The trigger for this communication"/>
      <definition
                  value="What is the trigger data element for this communication - whether it is an updated medication, or an encounter..."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.basedOn"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
      </type>
    </element>
    <element id="BECommunication.inReponseTo">
      <path value="BECommunication.inReponseTo"/>
      <short value="Communication for which this communication is a response"/>
      <definition
                  value="The message that this communication is responding to. Similar to a &quot;quote&quot; in chats, or &quot;forward/reply&quot; in mail."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.inReponseTo"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile value="BeCommunication"/>
      </type>
    </element>
    <element id="BECommunication.sender">
      <path value="BECommunication.sender"/>
      <short value="Sender of the communication"/>
      <definition value="Sender of the communication"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.sender"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Person"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.recipient">
      <path value="BECommunication.recipient"/>
      <short value="Recipient(s) of the communication"/>
      <definition
                  value="The addressees of this communication, the ones to whom the message is destined."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.recipient"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Person"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/>
      </type>
    </element>
    <element id="BECommunication.topic">
      <path value="BECommunication.topic"/>
      <short value="Topic of the communication"/>
      <definition
                  value="The topic of this communication. Should be coded e.g. &quot;medication&quot;, or &quot;vaccines&quot;"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.topic"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/CodeableConcept"/>
      </type>
      <binding>
        <strength value="example"/>
        <description value="Communication Topic"/>
        <valueSet value="http://hl7.org/fhir/ValueSet/communication-topic"/>
      </binding>
    </element>
    <element id="BECommunication.context">
      <path value="BECommunication.context"/>
      <short value="The context (e.g. subject) for this communications"/>
      <definition value="Normally the context is a patient, or a plan"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.context"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="BackboneElement"/>
      </type>
    </element>
    <element id="BECommunication.context.patient">
      <path value="BECommunication.context.patient"/>
      <short value="The patient or subject of care"/>
      <definition
                  value="The Patient or Subject of Care. This is a reference to a Patient resource, following the Logical Model for Belgian Patients."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.context.patient"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile value="BEPatient"/>
      </type>
    </element>
    <element id="BECommunication.content">
      <path value="BECommunication.content"/>
      <short value="Message payload"/>
      <definition value="The content of the message"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.content"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="BackboneElement"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.content.text">
      <path value="BECommunication.content.text"/>
      <short value="Communication text"/>
      <definition value="The text of the communication. Maximum 320 characters"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.content.text"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
        <profile
                 value="https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/string320"/>
      </type>
    </element>
    <element id="BECommunication.content.attachment">
      <path value="BECommunication.content.attachment"/>
      <short value="Attachment (e.g. image)"/>
      <definition
                  value="An encoded attachment such as an image, video or audio recording"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.content.attachment"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Attachment"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Attachment"/>
      </type>
    </element>
    <element id="BECommunication.content.link">
      <path value="BECommunication.content.link"/>
      <short
             value="Link to message content - an attachment, an online video, a document in another server or vault"/>
      <definition
                  value="A link to the message content e.g. an online video or an attachment that resides on a server or content in another vault"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="BECommunication.content.link"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="BECommunication">
      <path value="BECommunication"/>
      <short value="Communication"/>
      <definition
                  value="The Communication object represents a message sent or note entered in a diary, in the context of care."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element id="BECommunication.identifier">
      <path value="BECommunication.identifier"/>
      <short value="Identifier for this communication"/>
      <definition value="A unique identifier for this communication."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Identifier"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.status">
      <path value="BECommunication.status"/>
      <short value="Status of the communication"/>
      <definition value="The status of this communication entry."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/code"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.validated">
      <path value="BECommunication.validated"/>
      <short value="Validation status"/>
      <definition
                  value="The validation status of the communication - whether this note is validated or not."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/code"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.dateTimeEntered">
      <path value="BECommunication.dateTimeEntered"/>
      <short value="Time and Date of Communication entered"/>
      <definition
                  value="Date or timestamp of entering the communication in its current status"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="dateTime"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/dateTime"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.basedOn">
      <path value="BECommunication.basedOn"/>
      <short value="The trigger for this communication"/>
      <definition
                  value="What is the trigger data element for this communication - whether it is an updated medication, or an encounter..."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
      </type>
    </element>
    <element id="BECommunication.inReponseTo">
      <path value="BECommunication.inReponseTo"/>
      <short value="Communication for which this communication is a response"/>
      <definition
                  value="The message that this communication is responding to. Similar to a &quot;quote&quot; in chats, or &quot;forward/reply&quot; in mail."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="BeCommunication"/>
      </type>
    </element>
    <element id="BECommunication.sender">
      <path value="BECommunication.sender"/>
      <short value="Sender of the communication"/>
      <definition value="Sender of the communication"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Person"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.recipient">
      <path value="BECommunication.recipient"/>
      <short value="Recipient(s) of the communication"/>
      <definition
                  value="The addressees of this communication, the ones to whom the message is destined."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Person"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/>
      </type>
    </element>
    <element id="BECommunication.topic">
      <path value="BECommunication.topic"/>
      <short value="Topic of the communication"/>
      <definition
                  value="The topic of this communication. Should be coded e.g. &quot;medication&quot;, or &quot;vaccines&quot;"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/CodeableConcept"/>
      </type>
      <binding>
        <strength value="example"/>
        <description value="Communication Topic"/>
        <valueSet value="http://hl7.org/fhir/ValueSet/communication-topic"/>
      </binding>
    </element>
    <element id="BECommunication.context">
      <path value="BECommunication.context"/>
      <short value="The context (e.g. subject) for this communications"/>
      <definition value="Normally the context is a patient, or a plan"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="BackboneElement"/>
      </type>
    </element>
    <element id="BECommunication.context.patient">
      <path value="BECommunication.context.patient"/>
      <short value="The patient or subject of care"/>
      <definition
                  value="The Patient or Subject of Care. This is a reference to a Patient resource, following the Logical Model for Belgian Patients."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="BEPatient"/>
      </type>
    </element>
    <element id="BECommunication.content">
      <path value="BECommunication.content"/>
      <short value="Message payload"/>
      <definition value="The content of the message"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="BackboneElement"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element id="BECommunication.content.text">
      <path value="BECommunication.content.text"/>
      <short value="Communication text"/>
      <definition value="The text of the communication. Maximum 320 characters"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="string"/>
        <profile
                 value="https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/string320"/>
      </type>
    </element>
    <element id="BECommunication.content.attachment">
      <path value="BECommunication.content.attachment"/>
      <short value="Attachment (e.g. image)"/>
      <definition
                  value="An encoded attachment such as an image, video or audio recording"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Attachment"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Attachment"/>
      </type>
    </element>
    <element id="BECommunication.content.link">
      <path value="BECommunication.content.link"/>
      <short
             value="Link to message content - an attachment, an online video, a document in another server or vault"/>
      <definition
                  value="A link to the message content e.g. an online video or an attachment that resides on a server or content in another vault"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
      </type>
    </element>
  </differential>
</StructureDefinition>