R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3

V3-AddressPartType.cs.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

Description: Code that specifies whether an address part names the street, city, country, postal code, post box, etc. Discussion: The hierarchical nature of these concepts shows composition. E.g. "Street Name" is part of "Street Address Line"

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-AddressPartType"/> 
  <meta> 
    <lastUpdated value="2017-07-31T00:00:00.000+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Release Date: 2017-07-31</p> 

      <table class="grid">
 
        <tr> 
          <td> 
            <b> Level</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
          <td> 
            <b> PartOf</b> 
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> ADL
            <a name="v3-AddressPartType-ADL"> </a> 
          </td> 
          <td> additional locator</td> 
          <td> 
                        This can be a unit designator, such as apartment number, suite
               number, or floor. There may be several unit designators in an address (e.g., &quot;3rd
               floor, Appt. 342&quot;). This can also be a designator pointing away from the location,
               rather than specifying a smaller location within some larger one (e.g., Dutch &quot;t.o.&quot;
               means &quot;opposite to&quot; for house boats located across the street facing houses).
            <br/>  

                     
          </td> 
          <td> AL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> AL
            <a name="v3-AddressPartType-AL"> </a> 
          </td> 
          <td> address line</td> 
          <td> 
                        
                           Description: An address line is for either an additional locator,
               a delivery address or a street address.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   DAL
            <a name="v3-AddressPartType-DAL"> </a> 
          </td> 
          <td> delivery address line</td> 
          <td> 
                        A delivery address line is frequently used instead of breaking
               out delivery mode, delivery installation, etc.  An address generally has only a delivery
               address line or a street address line, but not both.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   SAL
            <a name="v3-AddressPartType-SAL"> </a> 
          </td> 
          <td> street address line</td> 
          <td> 
                        
                           Description: A street address line is frequently used instead
               of breaking out build number, street name, street type, etc. An address generally has
               only a delivery address line or a street address line, but not both.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> BNN
            <a name="v3-AddressPartType-BNN"> </a> 
          </td> 
          <td> building number numeric</td> 
          <td> 
                        The numeric portion of a building number
            <br/>  

                     
          </td> 
          <td> BNR</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> BNR
            <a name="v3-AddressPartType-BNR"> </a> 
          </td> 
          <td> building number</td> 
          <td> 
                        The number of a building, house or lot alongside the street. 
               Also known as &quot;primary street number&quot;.  This does not number the street but
               rather the building.
            <br/>  

                     
          </td> 
          <td> SAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> BNS
            <a name="v3-AddressPartType-BNS"> </a> 
          </td> 
          <td> building number suffix</td> 
          <td> 
                        Any alphabetic character, fraction or other text that may appear
               after the numeric portion of a building number
            <br/>  

                     
          </td> 
          <td> BNR</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> CAR
            <a name="v3-AddressPartType-CAR"> </a> 
          </td> 
          <td> care of</td> 
          <td> 
                        The name of the party who will take receipt at the specified address,
               and will take on responsibility for ensuring delivery to the target recipient
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> CEN
            <a name="v3-AddressPartType-CEN"> </a> 
          </td> 
          <td> census tract</td> 
          <td> 
                        A geographic sub-unit delineated for demographic purposes.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> CNT
            <a name="v3-AddressPartType-CNT"> </a> 
          </td> 
          <td> country</td> 
          <td> 
                        Country
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> CPA
            <a name="v3-AddressPartType-CPA"> </a> 
          </td> 
          <td> county or parish</td> 
          <td> 
                        A sub-unit of a state or province. (49 of the United States of
               America use the term &quot;county;&quot; Louisiana uses the term &quot;parish&quot;.)
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> CTY
            <a name="v3-AddressPartType-CTY"> </a> 
          </td> 
          <td> municipality</td> 
          <td> 
                        The name of the city, town, village, or other community or delivery
               center
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DEL
            <a name="v3-AddressPartType-DEL"> </a> 
          </td> 
          <td> delimiter</td> 
          <td> 
                        Delimiters are printed without framing white space.  If no value
               component is provided, the delimiter appears as a line break.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DINST
            <a name="v3-AddressPartType-DINST"> </a> 
          </td> 
          <td> delivery installation type</td> 
          <td> 
                        Indicates the type of delivery installation (the facility to which
               the mail will be delivered prior to final shipping via the delivery mode.) Example: post
               office, letter carrier depot, community mail center, station, etc.
            <br/>  

                     
          </td> 
          <td> DAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DINSTA
            <a name="v3-AddressPartType-DINSTA"> </a> 
          </td> 
          <td> delivery installation area</td> 
          <td> 
                        The location of the delivery installation, usually a town or city,
               and is only required if the area is different from the municipality. Area to which mail
               delivery service is provided from any postal facility or service such as an individual
               letter carrier, rural route, or postal route.
            <br/>  

                     
          </td> 
          <td> DAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DINSTQ
            <a name="v3-AddressPartType-DINSTQ"> </a> 
          </td> 
          <td> delivery installation qualifier</td> 
          <td> 
                        A number, letter or name identifying a delivery installation.
                E.g., for Station A, the delivery installation qualifier would be 'A'.
            <br/>  

                     
          </td> 
          <td> DAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DIR
            <a name="v3-AddressPartType-DIR"> </a> 
          </td> 
          <td> direction</td> 
          <td> 
                        Direction (e.g., N, S, W, E)
            <br/>  

                     
          </td> 
          <td> SAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DMOD
            <a name="v3-AddressPartType-DMOD"> </a> 
          </td> 
          <td> delivery mode</td> 
          <td> 
                        Indicates the type of service offered, method of delivery.  For
               example: post office box, rural route, general delivery, etc.
            <br/>  

                     
          </td> 
          <td> DAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DMODID
            <a name="v3-AddressPartType-DMODID"> </a> 
          </td> 
          <td> delivery mode identifier</td> 
          <td> 
                        Represents the routing information such as a letter carrier route
               number.  It is the identifying number of the designator (the box number or rural route
               number).
            <br/>  

                     
          </td> 
          <td> DAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> DPID
            <a name="v3-AddressPartType-DPID"> </a> 
          </td> 
          <td> delivery point identifier</td> 
          <td> 
                        A value that uniquely identifies the postal address.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> INT
            <a name="v3-AddressPartType-INT"> </a> 
          </td> 
          <td> intersection</td> 
          <td> 
                        
                           Description:An intersection denotes that the actual address
               is located AT or CLOSE TO the intersection OF two or more streets.
            <br/>  

                     
          </td> 
          <td> AL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> POB
            <a name="v3-AddressPartType-POB"> </a> 
          </td> 
          <td> post box</td> 
          <td> 
                        A numbered box located in a post station.
            <br/>  

                     
          </td> 
          <td> DMODID</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> PRE
            <a name="v3-AddressPartType-PRE"> </a> 
          </td> 
          <td> precinct</td> 
          <td> 
                        A subsection of a municipality
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> STA
            <a name="v3-AddressPartType-STA"> </a> 
          </td> 
          <td> state or province</td> 
          <td> 
                        A sub-unit of a country with limited sovereignty in a federally
               organized country.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> STB
            <a name="v3-AddressPartType-STB"> </a> 
          </td> 
          <td> street name base</td> 
          <td> 
                        The base name of a roadway or artery recognized by a municipality
               (excluding street type and direction)
            <br/>  

                     
          </td> 
          <td> STR</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> STR
            <a name="v3-AddressPartType-STR"> </a> 
          </td> 
          <td> street name</td> 
          <td/>  
          <td> SAL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> STTYP
            <a name="v3-AddressPartType-STTYP"> </a> 
          </td> 
          <td> street type</td> 
          <td> 
                        The designation given to the street.  (e.g. Street, Avenue, Crescent,
               etc.)
            <br/>  

                     
          </td> 
          <td> STR</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> UNID
            <a name="v3-AddressPartType-UNID"> </a> 
          </td> 
          <td> unit identifier</td> 
          <td> 
                        The number or name of a specific unit contained within a building
               or complex, as assigned by that building or complex.
            <br/>  

                     
          </td> 
          <td> ADL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> UNIT
            <a name="v3-AddressPartType-UNIT"> </a> 
          </td> 
          <td> unit designator</td> 
          <td> 
                        Indicates the type of specific unit contained within a building
               or complex.  E.g. Appartment, Floor
            <br/>  

                     
          </td> 
          <td> ADL</td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> ZIP
            <a name="v3-AddressPartType-ZIP"> </a> 
          </td> 
          <td> postal code</td> 
          <td> 
                        A postal code designating a region defined by the postal service.
            <br/>  

                     
          </td> 
          <td/>  
        </tr> 

      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status">
    <valueString value="External"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/v3/AddressPartType"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.5.16"/> 
  </identifier> 
  <version value="2017-07-31"/> 
  <name value="v3 Code System AddressPartType"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2017-07-31T00:00:00+10:00"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="  Description:
Code that specifies whether an address part names the street, city, country, postal code,
     post box, etc. Discussion: The hierarchical nature of these concepts shows composition.
      E.g. &quot;Street Name&quot; is part of &quot;Street Address Line&quot;"/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/v3-AddressPartType"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <property> 
    <code value="partOf"/> 
    <uri value="http://hl7.org/fhir/codesystem-hierarchy-meaning#part-of"/> 
    <description value="This relationship indicates that the source concept is a component of the target concept"/> 
    <type value="code"/> 
  </property> 
  <concept> 
    <code value="ADL"/> 
    <display value="additional locator"/> 
    <definition value="This can be a unit designator, such as apartment number, suite number, or floor. There
       may be several unit designators in an address (e.g., &quot;3rd floor, Appt. 342&quot;).
       This can also be a designator pointing away from the location, rather than specifying
       a smaller location within some larger one (e.g., Dutch &quot;t.o.&quot; means &quot;opposite
       to&quot; for house boats located across the street facing houses)."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="AL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="AL"/> 
    <display value="address line"/> 
    <definition value="Description: An address line is for either an additional locator, a delivery address or
       a street address."/> 
    <concept> 
      <code value="DAL"/> 
      <display value="delivery address line"/> 
      <definition value="A delivery address line is frequently used instead of breaking out delivery mode, delivery
         installation, etc.  An address generally has only a delivery address line or a street
         address line, but not both."/> 
    </concept> 
    <concept> 
      <code value="SAL"/> 
      <display value="street address line"/> 
      <definition value="Description: A street address line is frequently used instead of breaking out build number,
         street name, street type, etc. An address generally has only a delivery address line or
         a street address line, but not both."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="BNN"/> 
    <display value="building number numeric"/> 
    <definition value="The numeric portion of a building number"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="BNR"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="BNR"/> 
    <display value="building number"/> 
    <definition value="The number of a building, house or lot alongside the street.  Also known as &quot;primary
       street number&quot;.  This does not number the street but rather the building."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="SAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="BNS"/> 
    <display value="building number suffix"/> 
    <definition value="Any alphabetic character, fraction or other text that may appear after the numeric portion
       of a building number"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="BNR"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="CAR"/> 
    <display value="care of"/> 
    <definition value="The name of the party who will take receipt at the specified address, and will take on
       responsibility for ensuring delivery to the target recipient"/> 
  </concept> 
  <concept> 
    <code value="CEN"/> 
    <display value="census tract"/> 
    <definition value="A geographic sub-unit delineated for demographic purposes."/> 
  </concept> 
  <concept> 
    <code value="CNT"/> 
    <display value="country"/> 
    <definition value="Country"/> 
  </concept> 
  <concept> 
    <code value="CPA"/> 
    <display value="county or parish"/> 
    <definition value="A sub-unit of a state or province. (49 of the United States of America use the term &quot;county;&qu
      ot; Louisiana uses the term &quot;parish&quot;.)"/> 
  </concept> 
  <concept> 
    <code value="CTY"/> 
    <display value="municipality"/> 
    <definition value="The name of the city, town, village, or other community or delivery center"/> 
  </concept> 
  <concept> 
    <code value="DEL"/> 
    <display value="delimiter"/> 
    <definition value="Delimiters are printed without framing white space.  If no value component is provided,
       the delimiter appears as a line break."/> 
  </concept> 
  <concept> 
    <code value="DINST"/> 
    <display value="delivery installation type"/> 
    <definition value="Indicates the type of delivery installation (the facility to which the mail will be delivered
       prior to final shipping via the delivery mode.) Example: post office, letter carrier depot,
       community mail center, station, etc."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="DAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="DINSTA"/> 
    <display value="delivery installation area"/> 
    <definition value="The location of the delivery installation, usually a town or city, and is only required
       if the area is different from the municipality. Area to which mail delivery service is
       provided from any postal facility or service such as an individual letter carrier, rural
       route, or postal route."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="DAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="DINSTQ"/> 
    <display value="delivery installation qualifier"/> 
    <definition value="A number, letter or name identifying a delivery installation.  E.g., for Station A, the
       delivery installation qualifier would be 'A'."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="DAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="DIR"/> 
    <display value="direction"/> 
    <definition value="Direction (e.g., N, S, W, E)"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="SAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="DMOD"/> 
    <display value="delivery mode"/> 
    <definition value="Indicates the type of service offered, method of delivery.  For example: post office box,
       rural route, general delivery, etc."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="DAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="DMODID"/> 
    <display value="delivery mode identifier"/> 
    <definition value="Represents the routing information such as a letter carrier route number.  It is the identifying
       number of the designator (the box number or rural route number)."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="DAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="DPID"/> 
    <display value="delivery point identifier"/> 
    <definition value="A value that uniquely identifies the postal address."/> 
  </concept> 
  <concept> 
    <code value="INT"/> 
    <display value="intersection"/> 
    <definition value="Description:An intersection denotes that the actual address is located AT or CLOSE TO
       the intersection OF two or more streets."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="AL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="POB"/> 
    <display value="post box"/> 
    <definition value="A numbered box located in a post station."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="DMODID"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="PRE"/> 
    <display value="precinct"/> 
    <definition value="A subsection of a municipality"/> 
  </concept> 
  <concept> 
    <code value="STA"/> 
    <display value="state or province"/> 
    <definition value="A sub-unit of a country with limited sovereignty in a federally organized country."/> 
  </concept> 
  <concept> 
    <code value="STB"/> 
    <display value="street name base"/> 
    <definition value="The base name of a roadway or artery recognized by a municipality (excluding street type
       and direction)"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="STR"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="STR"/> 
    <display value="street name"/> 
    <definition value="street name"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="SAL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="STTYP"/> 
    <display value="street type"/> 
    <definition value="The designation given to the street.  (e.g. Street, Avenue, Crescent, etc.)"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="STR"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="UNID"/> 
    <display value="unit identifier"/> 
    <definition value="The number or name of a specific unit contained within a building or complex, as assigned
       by that building or complex."/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="ADL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="UNIT"/> 
    <display value="unit designator"/> 
    <definition value="Indicates the type of specific unit contained within a building or complex.  E.g. Appartment,
       Floor"/> 
    <property> 
      <code value="partOf"/> 
      <valueCode value="ADL"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="ZIP"/> 
    <display value="postal code"/> 
    <definition value="A postal code designating a region defined by the postal service."/> 
  </concept> 
</CodeSystem>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.