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 R2

V3-AddressUse.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

Codes that provide guidance around the circumstances in which a given address should be used.

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-AddressUse"/> 
  <meta> 
    <lastUpdated value="2017-07-31T00:00:00.000+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </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> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (_GeneralAddressUse)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-AddressUse-_GeneralAddressUse"> </a> 
          </td> 
          <td> 
                        
                           Description: Address uses that can apply to both postal and
               telecommunication addresses.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   BAD
            <a name="v3-AddressUse-BAD"> </a> 
          </td> 
          <td> bad address</td> 
          <td> 
                        
                           Description: A flag indicating that the address is bad, in
               fact, useless.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   CONF
            <a name="v3-AddressUse-CONF"> </a> 
          </td> 
          <td> confidential address</td> 
          <td> 
                        
                           Description: Indicates that the address is considered sensitive
               and should only be shared or published in accordance with organizational controls governing
               patient demographic information with increased sensitivity. Uses of Addresses.   Lloyd
               to supply more complete description.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   H
            <a name="v3-AddressUse-H"> </a> 
          </td> 
          <td> home address</td> 
          <td> 
                        
                           Description: A communication address at a home, attempted contacts
               for business purposes might intrude privacy and chances are one will contact family or
               other household members instead of the person one wishes to call. Typically used with
               urgent cases, or if no other contacts are available.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     HP
            <a name="v3-AddressUse-HP"> </a> 
          </td> 
          <td> primary home</td> 
          <td> 
                        
                           Description: The primary home, to reach a person after business
               hours.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     HV
            <a name="v3-AddressUse-HV"> </a> 
          </td> 
          <td> vacation home</td> 
          <td> 
                        
                           Description: A vacation home, to reach a person while on vacation.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   OLD
            <a name="v3-AddressUse-OLD"> </a> 
          </td> 
          <td> no longer in use</td> 
          <td> 
                        This address is no longer in use.
            <br/>  

                        
                           Usage Note: Address may also carry valid time ranges. This
               code is used to cover the situations where it is known that the address is no longer valid,
               but no particular time range for its use is known.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   TMP
            <a name="v3-AddressUse-TMP"> </a> 
          </td> 
          <td> temporary address</td> 
          <td> 
                        
                           Description: A temporary address, may be good for visit or
               mailing. Note that an address history can provide more detailed information.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   WP
            <a name="v3-AddressUse-WP"> </a> 
          </td> 
          <td> work place</td> 
          <td> 
                        
                           Description: An office address. First choice for business related
               contacts during business hours.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     DIR
            <a name="v3-AddressUse-DIR"> </a> 
          </td> 
          <td> direct</td> 
          <td> 
                        
                           Description: Indicates a work place address or telecommunication
               address that reaches the individual or organization directly without intermediaries. For
               phones, often referred to as a 'private line'.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     PUB
            <a name="v3-AddressUse-PUB"> </a> 
          </td> 
          <td> public</td> 
          <td> 
                        
                           Description: Indicates a work place address or telecommunication
               address that is a 'standard' address which may reach a reception service, mail-room, or
               other intermediary prior to the target entity.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (_PostalAddressUse)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-AddressUse-_PostalAddressUse"> </a> 
          </td> 
          <td> 
                        
                           Description: Address uses that only apply to postal addresses,
               not telecommunication addresses.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   PHYS
            <a name="v3-AddressUse-PHYS"> </a> 
          </td> 
          <td> physical visit address</td> 
          <td> 
                        
                           Description: Used primarily to visit an address.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   PST
            <a name="v3-AddressUse-PST"> </a> 
          </td> 
          <td> postal address</td> 
          <td> 
                        
                           Description: Used to send mail.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (_TelecommunicationAddressUse)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-AddressUse-_TelecommunicationAddressUse"> </a> 
          </td> 
          <td> 
                        
                           Description: Address uses that only apply to telecommunication
               addresses, not postal addresses.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   AS
            <a name="v3-AddressUse-AS"> </a> 
          </td> 
          <td> answering service</td> 
          <td> 
                        
                           Description: An automated answering machine used for less urgent
               cases and if the main purpose of contact is to leave a message or access an automated
               announcement.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   EC
            <a name="v3-AddressUse-EC"> </a> 
          </td> 
          <td> emergency contact</td> 
          <td> 
                        
                           Description: A contact specifically designated to be used for
               emergencies. This is the first choice in emergencies, independent of any other use codes.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   MC
            <a name="v3-AddressUse-MC"> </a> 
          </td> 
          <td> mobile contact)</td> 
          <td> 
                        
                           Description: A telecommunication device that moves and stays
               with its owner. May have characteristics of all other use codes, suitable for urgent matters,
               not the first choice for routine business.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   PG
            <a name="v3-AddressUse-PG"> </a> 
          </td> 
          <td> pager</td> 
          <td> 
                        
                           Description: A paging device suitable to solicit a callback
               or to leave a very short message.
            <br/>  

                     
          </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> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueString value="vocab"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/v3-AddressUse"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.1.11.190"/> 
  </identifier> 
  <version value="2017-07-31"/> 
  <name value="v3 Code System AddressUse"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2017-07-31"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value=" Codes that provide guidance around the circumstances in which a given address should
     be used."/> 
  <immutable value="true"/> 
  <compose> 
    <include> 
      <system value="http://hl7.org/fhir/v3/AddressUse"/> 
    </include> 
  </compose> 
</ValueSet> 

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.