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

AddressModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="shr-core-Address-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>ODH Address Logical Model</b></p>
  <p>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).</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/odh"/>
    <value value="shr.core.Address"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="AddressModel"/>
  <title value="ODH Address 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="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)."/>
  <keyword>
    <system value="http://ncimeta.nci.nih.gov"/>
    <code value="C0682130"/>
  </keyword>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="shr-core-Address-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="shr-core-Address-model">
      <path value="shr-core-Address-model"/>
      <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="shr-core-Address-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.purpose">
      <path value="shr-core-Address-model.purpose"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0805701"/>
      </code>
      <short value="Why the item is used."/>
      <definition value="Why the item is used."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.purpose"/>
        <min value="0"/>
        <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/address-use"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="shr-core-Address-model.type">
      <path value="shr-core-Address-model.type"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0332307"/>
      </code>
      <short
             value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.type"/>
        <min value="0"/>
        <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/address-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="shr-core-Address-model.displayText">
      <path value="shr-core-Address-model.displayText"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1548311"/>
      </code>
      <short
             value="A string meant for reading by a person, for example, accompanying a code."/>
      <definition
                  value="A string meant for reading by a person, for example, accompanying a code."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.displayText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.addressLine">
      <path value="shr-core-Address-model.addressLine"/>
      <short
             value="Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR)."/>
      <definition
                  value="Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="shr-core-Address-model.addressLine"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.city">
      <path value="shr-core-Address-model.city"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1555315"/>
      </code>
      <short
             value="The name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR)."/>
      <definition
                  value="The name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.city"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.district">
      <path value="shr-core-Address-model.district"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0079170"/>
      </code>
      <short
             value="The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR)."/>
      <definition
                  value="The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.district"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.state">
      <path value="shr-core-Address-model.state"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1552743"/>
      </code>
      <short
             value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR)."/>
      <definition
                  value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.state"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.postalCode">
      <path value="shr-core-Address-model.postalCode"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1514254"/>
      </code>
      <short
             value="A sequence of letters and digits used as part of a postal address, often designating a geographic region"/>
      <definition
                  value="A sequence of letters and digits used as part of a postal address, often designating a geographic region"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.postalCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.country">
      <path value="shr-core-Address-model.country"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0454664"/>
      </code>
      <short
             value="Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes."/>
      <definition
                  value="Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.country"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.effectiveTimePeriod">
      <path value="shr-core-Address-model.effectiveTimePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2985763"/>
      </code>
      <short
             value="The date and time span for which something is active, valid, or in force."/>
      <definition
                  value="The date and time span for which something is active, valid, or in force."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.effectiveTimePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-EffectiveTimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="shr-core-Address-model">
      <path value="shr-core-Address-model"/>
      <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="shr-core-Address-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.purpose">
      <path value="shr-core-Address-model.purpose"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0805701"/>
      </code>
      <short value="Why the item is used."/>
      <definition value="Why the item is used."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.purpose"/>
        <min value="0"/>
        <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/address-use"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="shr-core-Address-model.type">
      <path value="shr-core-Address-model.type"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0332307"/>
      </code>
      <short
             value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.type"/>
        <min value="0"/>
        <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/address-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="shr-core-Address-model.displayText">
      <path value="shr-core-Address-model.displayText"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1548311"/>
      </code>
      <short
             value="A string meant for reading by a person, for example, accompanying a code."/>
      <definition
                  value="A string meant for reading by a person, for example, accompanying a code."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.displayText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.addressLine">
      <path value="shr-core-Address-model.addressLine"/>
      <short
             value="Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR)."/>
      <definition
                  value="Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="shr-core-Address-model.addressLine"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.city">
      <path value="shr-core-Address-model.city"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1555315"/>
      </code>
      <short
             value="The name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR)."/>
      <definition
                  value="The name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.city"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.district">
      <path value="shr-core-Address-model.district"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0079170"/>
      </code>
      <short
             value="The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR)."/>
      <definition
                  value="The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.district"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.state">
      <path value="shr-core-Address-model.state"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1552743"/>
      </code>
      <short
             value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR)."/>
      <definition
                  value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.state"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.postalCode">
      <path value="shr-core-Address-model.postalCode"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1514254"/>
      </code>
      <short
             value="A sequence of letters and digits used as part of a postal address, often designating a geographic region"/>
      <definition
                  value="A sequence of letters and digits used as part of a postal address, often designating a geographic region"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.postalCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.country">
      <path value="shr-core-Address-model.country"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0454664"/>
      </code>
      <short
             value="Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes."/>
      <definition
                  value="Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.country"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-Address-model.effectiveTimePeriod">
      <path value="shr-core-Address-model.effectiveTimePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2985763"/>
      </code>
      <short
             value="The date and time span for which something is active, valid, or in force."/>
      <definition
                  value="The date and time span for which something is active, valid, or in force."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-Address-model.effectiveTimePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-EffectiveTimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>