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

PersonModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-entity-Person-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>ODH Person Logical Model</b></p>
  <p>A person relevant to the health or social situation of the subject (including the person of record him or herself).</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Person-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/odh"/>
    <value value="cimi.entity.Person"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="PersonModel"/>
  <title value="ODH Person 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 person relevant to the health or social situation of the subject (including the person of record him or herself)."/>
  <keyword>
    <system value="http://ncimeta.nci.nih.gov"/>
    <code value="C0027361"/>
  </keyword>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-entity-Person-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-entity-Person-model">
      <path value="cimi-entity-Person-model"/>
      <definition
                  value="A person relevant to the health or social situation of the subject (including the person of record him or herself)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.humanName">
      <path value="cimi-entity-Person-model.humanName"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1547383"/>
      </code>
      <short value="The CIMI person name, constrained to map correctly to FHIR."/>
      <definition
                  value="The CIMI person name, constrained to map correctly to FHIR."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.humanName"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.dateOfBirth">
      <path value="cimi-entity-Person-model.dateOfBirth"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2919018"/>
      </code>
      <code>
        <system value="http://loinc.org"/>
        <code value="21112-8"/>
      </code>
      <short
             value="A date of birth or approximate year or period (year or date range), if estimated."/>
      <definition
                  value="A date of birth or approximate year or period (year or date range), if estimated."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.dateOfBirth"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="date"/>
      </type>
      <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-entity-Person-model.administrativeGender">
      <path value="cimi-entity-Person-model.administrativeGender"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1550327"/>
      </code>
      <short
             value="A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender."/>
      <definition
                  value="A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.administrativeGender"/>
        <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/administrative-gender"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Person-model.address">
      <path value="cimi-entity-Person-model.address"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0682130"/>
      </code>
      <short
             value="An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR)."/>
      <definition
                  value="An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.address"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.headshot">
      <path value="cimi-entity-Person-model.headshot"/>
      <short value="A photograph showing a person&#39;s face."/>
      <definition value="A photograph showing a person&#39;s face."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.headshot"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-datatypes-Media-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.contactPoint">
      <path value="cimi-entity-Person-model.contactPoint"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2986441"/>
      </code>
      <short
             value="An electronic means of contacting an organization or individual."/>
      <definition
                  value="An electronic means of contacting an organization or individual."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.contactPoint"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.languageUsed">
      <path value="cimi-entity-Person-model.languageUsed"/>
      <short
             value="Language used for communication by a human, either the subject of record, parent, or other involved person."/>
      <definition
                  value="Language used for communication by a human, either the subject of record, parent, or other involved person."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.languageUsed"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.activeFlag">
      <path value="cimi-entity-Person-model.activeFlag"/>
      <short
             value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <definition
                  value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.activeFlag"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.maritalStatus">
      <path value="cimi-entity-Person-model.maritalStatus"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0024819"/>
      </code>
      <short value="The most recent marital status of a person."/>
      <definition value="The most recent marital status of a person."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.maritalStatus"/>
        <min value="0"/>
        <max value="1"/>
      </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/marital-status"/>
        </valueSetReference>
      </binding>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-entity-Person-model">
      <path value="cimi-entity-Person-model"/>
      <definition
                  value="A person relevant to the health or social situation of the subject (including the person of record him or herself)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.humanName">
      <path value="cimi-entity-Person-model.humanName"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1547383"/>
      </code>
      <short value="The CIMI person name, constrained to map correctly to FHIR."/>
      <definition
                  value="The CIMI person name, constrained to map correctly to FHIR."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.humanName"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.dateOfBirth">
      <path value="cimi-entity-Person-model.dateOfBirth"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2919018"/>
      </code>
      <code>
        <system value="http://loinc.org"/>
        <code value="21112-8"/>
      </code>
      <short
             value="A date of birth or approximate year or period (year or date range), if estimated."/>
      <definition
                  value="A date of birth or approximate year or period (year or date range), if estimated."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.dateOfBirth"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="date"/>
      </type>
      <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-entity-Person-model.administrativeGender">
      <path value="cimi-entity-Person-model.administrativeGender"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1550327"/>
      </code>
      <short
             value="A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender."/>
      <definition
                  value="A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.administrativeGender"/>
        <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/administrative-gender"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Person-model.address">
      <path value="cimi-entity-Person-model.address"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0682130"/>
      </code>
      <short
             value="An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR)."/>
      <definition
                  value="An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.address"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.headshot">
      <path value="cimi-entity-Person-model.headshot"/>
      <short value="A photograph showing a person&#39;s face."/>
      <definition value="A photograph showing a person&#39;s face."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.headshot"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-datatypes-Media-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.contactPoint">
      <path value="cimi-entity-Person-model.contactPoint"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2986441"/>
      </code>
      <short
             value="An electronic means of contacting an organization or individual."/>
      <definition
                  value="An electronic means of contacting an organization or individual."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.contactPoint"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.languageUsed">
      <path value="cimi-entity-Person-model.languageUsed"/>
      <short
             value="Language used for communication by a human, either the subject of record, parent, or other involved person."/>
      <definition
                  value="Language used for communication by a human, either the subject of record, parent, or other involved person."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Person-model.languageUsed"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.activeFlag">
      <path value="cimi-entity-Person-model.activeFlag"/>
      <short
             value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <definition
                  value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.activeFlag"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Person-model.maritalStatus">
      <path value="cimi-entity-Person-model.maritalStatus"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0024819"/>
      </code>
      <short value="The most recent marital status of a person."/>
      <definition value="The most recent marital status of a person."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Person-model.maritalStatus"/>
        <min value="0"/>
        <max value="1"/>
      </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/marital-status"/>
        </valueSetReference>
      </binding>
    </element>
  </differential>
</StructureDefinition>