HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

EncounterModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-encounter-Encounter-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>ODH Encounter Logical Model</b></p>
  <p>A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-encounter-Encounter-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/odh"/>
    <value value="cimi.encounter.Encounter"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="EncounterModel"/>
  <title value="ODH Encounter Logical Model"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher value="HL7"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://standardhealthrecord.org"/>
    </telecom>
  </contact>
  <description
               value="A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-encounter-Encounter-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-encounter-Encounter-model">
      <path value="cimi-encounter-Encounter-model"/>
      <definition
                  value="A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-encounter-Encounter-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.personOfRecord">
      <path value="cimi-encounter-Encounter-model.personOfRecord"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0027361"/>
      </code>
      <short value="The person this entry belongs to."/>
      <definition value="The person this entry belongs to."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.personOfRecord"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Person-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.recorded">
      <path value="cimi-encounter-Encounter-model.recorded"/>
      <short
             value="The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order."/>
      <definition
                  value="The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.recorded"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-Attribution-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.signed">
      <path value="cimi-encounter-Encounter-model.signed"/>
      <short
             value="Provenance information specific to the signing of the clinical statement."/>
      <definition
                  value="Provenance information specific to the signing of the clinical statement."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.signed"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-Attribution-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.additionalText">
      <path value="cimi-encounter-Encounter-model.additionalText"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0947611"/>
      </code>
      <short
             value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <definition
                  value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.additionalText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.encounterClass">
      <path value="cimi-encounter-Encounter-model.encounterClass"/>
      <short
             value="Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations."/>
      <definition
                  value="Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.encounterClass"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.encounterType">
      <path value="cimi-encounter-Encounter-model.encounterType"/>
      <short
             value="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."/>
      <definition
                  value="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-encounter-Encounter-model.encounterType"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-ActEncounterCode"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-encounter-Encounter-model.timePeriod">
      <path value="cimi-encounter-Encounter-model.timePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1948053"/>
      </code>
      <short
             value="A period of time defined by a start and end time, date, or year."/>
      <definition
                  value="A period of time defined by a start and end time, date, or year.
If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.timePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-TimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.status">
      <path value="cimi-encounter-Encounter-model.status"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0449438"/>
      </code>
      <slicing>
        <discriminator>
          <type value="type"/>
          <path value="$this"/>
        </discriminator>
        <ordered value="false"/>
        <rules value="open"/>
      </slicing>
      <short value="The current standing or state."/>
      <definition value="The current standing or state."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.status"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.status.valueCode:code">
      <path value="cimi-encounter-Encounter-model.status.valueCode"/>
      <sliceName value="code"/>
      <short value="Choice of types representing the current standing or state."/>
      <definition
                  value="Choice of types representing the current standing or state."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.status.valueCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/encounter-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-encounter-Encounter-model.partOf">
      <path value="cimi-encounter-Encounter-model.partOf"/>
      <short
             value="The larger entity that this is a portion of. For example, an organization might be part of a larger organization, or an encounter with a hospitalist might be part of a larger hospitalization encounter."/>
      <definition
                  value="The larger entity that this is a portion of. For example, an organization might be part of a larger organization, or an encounter with a hospitalist might be part of a larger hospitalization encounter."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.partOf"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-encounter-Encounter-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.diagnosis">
      <path value="cimi-encounter-Encounter-model.diagnosis"/>
      <short
             value="A diagnosis, which is a disease or injury determined to be present through evaluation of patient history, examination, and/or review of laboratory data."/>
      <definition
                  value="A diagnosis, which is a disease or injury determined to be present through evaluation of patient history, examination, and/or review of laboratory data."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-encounter-Encounter-model.diagnosis"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-encounter-Diagnosis-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.clinicalNote">
      <path value="cimi-encounter-Encounter-model.clinicalNote"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0747978"/>
        <display value="Progress Note"/>
      </code>
      <short
             value="An entry concerning a patient where the result is a narrative text."/>
      <definition
                  value="An entry concerning a patient where the result is a narrative text."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.clinicalNote"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-statement-ClinicalNote-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-encounter-Encounter-model">
      <path value="cimi-encounter-Encounter-model"/>
      <definition
                  value="A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-encounter-Encounter-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.personOfRecord">
      <path value="cimi-encounter-Encounter-model.personOfRecord"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0027361"/>
      </code>
      <short value="The person this entry belongs to."/>
      <definition value="The person this entry belongs to."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.personOfRecord"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Person-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.recorded">
      <path value="cimi-encounter-Encounter-model.recorded"/>
      <short
             value="The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order."/>
      <definition
                  value="The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.recorded"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-Attribution-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.signed">
      <path value="cimi-encounter-Encounter-model.signed"/>
      <short
             value="Provenance information specific to the signing of the clinical statement."/>
      <definition
                  value="Provenance information specific to the signing of the clinical statement."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.signed"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-Attribution-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.additionalText">
      <path value="cimi-encounter-Encounter-model.additionalText"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0947611"/>
      </code>
      <short
             value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <definition
                  value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.additionalText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.encounterClass">
      <path value="cimi-encounter-Encounter-model.encounterClass"/>
      <short
             value="Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations."/>
      <definition
                  value="Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.encounterClass"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.encounterType">
      <path value="cimi-encounter-Encounter-model.encounterType"/>
      <short
             value="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."/>
      <definition
                  value="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-encounter-Encounter-model.encounterType"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-ActEncounterCode"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-encounter-Encounter-model.timePeriod">
      <path value="cimi-encounter-Encounter-model.timePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1948053"/>
      </code>
      <short
             value="A period of time defined by a start and end time, date, or year."/>
      <definition
                  value="A period of time defined by a start and end time, date, or year.
If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.timePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-TimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.status">
      <path value="cimi-encounter-Encounter-model.status"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0449438"/>
      </code>
      <slicing>
        <discriminator>
          <type value="type"/>
          <path value="$this"/>
        </discriminator>
        <ordered value="false"/>
        <rules value="open"/>
      </slicing>
      <short value="The current standing or state."/>
      <definition value="The current standing or state."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.status"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.status.valueCode:code">
      <path value="cimi-encounter-Encounter-model.status.valueCode"/>
      <sliceName value="code"/>
      <short value="Choice of types representing the current standing or state."/>
      <definition
                  value="Choice of types representing the current standing or state."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.status.valueCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/encounter-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-encounter-Encounter-model.partOf">
      <path value="cimi-encounter-Encounter-model.partOf"/>
      <short
             value="The larger entity that this is a portion of. For example, an organization might be part of a larger organization, or an encounter with a hospitalist might be part of a larger hospitalization encounter."/>
      <definition
                  value="The larger entity that this is a portion of. For example, an organization might be part of a larger organization, or an encounter with a hospitalist might be part of a larger hospitalization encounter."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.partOf"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-encounter-Encounter-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.diagnosis">
      <path value="cimi-encounter-Encounter-model.diagnosis"/>
      <short
             value="A diagnosis, which is a disease or injury determined to be present through evaluation of patient history, examination, and/or review of laboratory data."/>
      <definition
                  value="A diagnosis, which is a disease or injury determined to be present through evaluation of patient history, examination, and/or review of laboratory data."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-encounter-Encounter-model.diagnosis"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-encounter-Diagnosis-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-encounter-Encounter-model.clinicalNote">
      <path value="cimi-encounter-Encounter-model.clinicalNote"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0747978"/>
        <display value="Progress Note"/>
      </code>
      <short
             value="An entry concerning a patient where the result is a narrative text."/>
      <definition
                  value="An entry concerning a patient where the result is a narrative text."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-encounter-Encounter-model.clinicalNote"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-statement-ClinicalNote-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>