Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: R4B R4 R3 R2

Example ValueSet/postal-address-use (XML)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Value SetPostalAddressUse

<?xml version="1.0" encoding="UTF-8"?>

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="postal-address-use"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <ul> 
        <li> Include these codes as defined in 
          <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-AddressUse</code> 
          </a> 
          <table class="none">
            <tr> 
              <td style="white-space:nowrap">
                <b> Code</b> 
              </td> 
              <td> 
                <b> Display</b> 
              </td> 
              <td> 
                <b> Definition</b> 
              </td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-BAD">BAD</a> 
              </td> 
              <td> bad address</td> 
              <td> A flag indicating that the address is bad, in fact, useless.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-CONF">CONF</a> 
              </td> 
              <td> confidential address</td> 
              <td> 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.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-HP">HP</a> 
              </td> 
              <td> primary home</td> 
              <td> The primary home, to reach a person after business hours.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-HV">HV</a> 
              </td> 
              <td> vacation home</td> 
              <td> A vacation home, to reach a person while on vacation.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-DIR">DIR</a> 
              </td> 
              <td> direct</td> 
              <td> 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'.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-PUB">PUB</a> 
              </td> 
              <td> public</td> 
              <td> 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.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-PHYS">PHYS</a> 
              </td> 
              <td> physical visit address</td> 
              <td> Used primarily to visit an address.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html#v3-AddressUse-PST">PST</a> 
              </td> 
              <td> postal address</td> 
              <td> Used to send mail.</td> 
            </tr> 
          </table> 
        </li> 
      </ul> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/postal-address-use"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.908"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="PostalAddressUse"/> 
  <title value="PostalAddressUse"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2022-09-07T10:58:29+10:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Uses of an address not included in Address.use."/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-AddressUse"/> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="A flag indicating that the address is bad, in fact, useless."/> 
        </extension> 
        <code value="BAD"/> 
        <display value="bad address"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="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."/> 
        </extension> 
        <code value="CONF"/> 
        <display value="confidential address"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="The primary home, to reach a person after business hours."/> 
        </extension> 
        <code value="HP"/> 
        <display value="primary home"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="A vacation home, to reach a person while on vacation."/> 
        </extension> 
        <code value="HV"/> 
        <display value="vacation home"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="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'."/> 
        </extension> 
        <code value="DIR"/> 
        <display value="direct"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="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."/> 
        </extension> 
        <code value="PUB"/> 
        <display value="public"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Used primarily to visit an address."/> 
        </extension> 
        <code value="PHYS"/> 
        <display value="physical visit address"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Used to send mail."/> 
        </extension> 
        <code value="PST"/> 
        <display value="postal address"/> 
      </concept> 
    </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.