HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . 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>BC 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/breastcancer/StructureDefinition/cimi-encounter-Encounter-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.encounter.Encounter"/>
  </identifier>
  <version value="0.2.0"/>
  <name value="EncounterModel"/>
  <title value="BC Encounter Logical Model"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic/index.cfm"/>
    </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"/>
      <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/breastcancer/StructureDefinition/cimi-core-PersonOfRecord-model"/>
      </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/breastcancer/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>
      <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="Coding"/>
      </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>
  </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"/>
      <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/breastcancer/StructureDefinition/cimi-core-PersonOfRecord-model"/>
      </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/breastcancer/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>
      <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="Coding"/>
      </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>
  </differential>
</StructureDefinition>