FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.xver-r2.r4b
Resource TypeCodeSystem
IdCodeSystem-v3-AddressUse.json
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/xver-r2.r4b/0.0.1-snapshot-2/CodeSystem-v3-AddressUse.html
URLhttp://hl7.org/fhir/v3/AddressUse
Version1.0.2
Statusdraft
Date2025-09-13T15:10:02-04:00
Namev3-AddressUse
Realmuv
Authorityhl7
Contentcomplete

Resources that use this resource

ConceptMap
EmailSoortCodelijst-to-ContactPointSystemEmailSoortCodelijst-to-ContactPointSystem
EmailSoortCodelijst-to-ContactPointUseEmailSoortCodelijst-to-ContactPointUse
NummerSoortCodelijst-to-ContactPointUseNummerSoortCodelijst-to-ContactPointUse
TelecomTypeCodelijst-to-ContactPointSystemTelecomTypeCodelijst-to-ContactPointSystem
TelecomTypeCodelijst-to-ContactPointUseTelecomTypeCodelijst-to-ContactPointUse
ValueSet
R2-postal-address-use-for-R4BCross-version VS for R2.PostalAddressUse for use in FHIR R4B
R2-v3-AddressUse-for-R4BCross-version VS for R2.v3 Code System AddressUse for use in FHIR R4B
R2-postal-address-use-for-R4Cross-version VS for R2.PostalAddressUse for use in FHIR R4
R3-postal-address-use-for-R4BCross-version VS for R3.PostalAddressUse for use in FHIR R4B
R3-v3-AddressUse-for-R4BCross-version VS for R3.v3 Code System AddressUse for use in FHIR R4B
R2-postal-address-use-for-R5Cross-version VS for R2.PostalAddressUse for use in FHIR R5
R2-v3-AddressUse-for-R5Cross-version VS for R2.v3 Code System AddressUse for use in FHIR R5
R3-postal-address-use-for-R5Cross-version VS for R3.PostalAddressUse for use in FHIR R5
R3-v3-AddressUse-for-R5Cross-version VS for R3.v3 Code System AddressUse for use in FHIR R5
2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3--20171231000000AdresSoortCodelijst
2.16.840.1.113883.2.4.3.11.60.40.2.20.6.3--20171231000000EmailSoortCodelijst
2.16.840.1.113883.2.4.3.11.60.40.2.20.6.2--20171231000000NummerSoortCodelijst
2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20171231000000TelecomTypeCodelijst

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CodeSystem v3-AddressUse

Properties

This code system defines the following properties for its concepts

NameCodeURIType
statusstatushttp://hl7.org/fhir/concept-properties#statuscode
Inactiveinactivehttp://hl7.org/fhir/concept-properties#inactiveboolean
effectiveDateeffectiveDatehttp://hl7.org/fhir/concept-properties#effectiveDatedateTime
deprecationDatedeprecationDatehttp://hl7.org/fhir/concept-properties#deprecationDatedateTime
retirementDateretirementDatehttp://hl7.org/fhir/concept-properties#retirementDatedateTime
Not SelectablenotSelectablehttp://hl7.org/fhir/concept-properties#notSelectableboolean
Parentparenthttp://hl7.org/fhir/concept-properties#parentcode
Childchildhttp://hl7.org/fhir/concept-properties#childcode
partOfpartOfhttp://hl7.org/fhir/concept-properties#partOfcode
synonymsynonymhttp://hl7.org/fhir/concept-properties#synonymcode
commentcommenthttp://hl7.org/fhir/concept-properties#commentstring
itemWeightitemWeighthttp://hl7.org/fhir/concept-properties#itemWeightdecimal

Concepts

This case-sensitive code system http://hl7.org/fhir/v3/AddressUse defines the following codes in an undefined hierarchy:

LvlCodeDisplayDefinitionNot Selectable
1_GeneralAddressUse _GeneralAddressUseDescription: Address uses that can apply to both postal and telecommunication addresses.true
2  BAD bad addressDescription: A flag indicating that the address is bad, in fact, useless.false
2  CONF confidential addressDescription: 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.false
2  H home addressDescription: 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.false
3    HP primary homeDescription: The primary home, to reach a person after business hours.false
3    HV vacation homeDescription: A vacation home, to reach a person while on vacation.false
2  OLD no longer in useThis address is no longer in use. 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.false
2  TMP temporary addressDescription: A temporary address, may be good for visit or mailing. Note that an address history can provide more detailed information.false
2  WP work placeDescription: An office address. First choice for business related contacts during business hours.false
3    DIR directDescription: 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'.false
3    PUB publicDescription: 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.false
1_PostalAddressUse _PostalAddressUseDescription: Address uses that only apply to postal addresses, not telecommunication addresses.true
2  PHYS physical visit addressDescription: Used primarily to visit an address.false
2  PST postal addressDescription: Used to send mail.false
1_TelecommunicationAddressUse _TelecommunicationAddressUseDescription: Address uses that only apply to telecommunication addresses, not postal addresses.true
2  AS answering serviceDescription: 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.false
2  EC emergency contactDescription: A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes.false
2  MC mobile contact)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.false
2  PG pagerDescription: A paging device suitable to solicit a callback or to leave a very short message.false

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-AddressUse",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
      "valueUri": "urn:oid:2.16.840.1.113883.5.1119"
    },
    {
      "extension": [
        {
          "url": "packageId",
          "valueId": "hl7.fhir.uv.xver-r2.r4b"
        },
        {
          "url": "version",
          "valueString": "0.0.1-snapshot-2"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/v3/AddressUse",
  "version": "1.0.2",
  "name": "v3-AddressUse",
  "status": "draft",
  "date": "2025-09-13T15:10:02-04:00",
  "publisher": "FHIR Infrastructure",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "caseSensitive": true,
  "content": "complete",
  "property": [
    {
      "code": "status",
      "uri": "http://hl7.org/fhir/concept-properties#status",
      "type": "code"
    },
    {
      "code": "inactive",
      "uri": "http://hl7.org/fhir/concept-properties#inactive",
      "type": "boolean"
    },
    {
      "code": "effectiveDate",
      "uri": "http://hl7.org/fhir/concept-properties#effectiveDate",
      "type": "dateTime"
    },
    {
      "code": "deprecationDate",
      "uri": "http://hl7.org/fhir/concept-properties#deprecationDate",
      "type": "dateTime"
    },
    {
      "code": "retirementDate",
      "uri": "http://hl7.org/fhir/concept-properties#retirementDate",
      "type": "dateTime"
    },
    {
      "code": "notSelectable",
      "uri": "http://hl7.org/fhir/concept-properties#notSelectable",
      "type": "boolean"
    },
    {
      "code": "parent",
      "uri": "http://hl7.org/fhir/concept-properties#parent",
      "type": "code"
    },
    {
      "code": "child",
      "uri": "http://hl7.org/fhir/concept-properties#child",
      "type": "code"
    },
    {
      "code": "partOf",
      "uri": "http://hl7.org/fhir/concept-properties#partOf",
      "type": "code"
    },
    {
      "code": "synonym",
      "uri": "http://hl7.org/fhir/concept-properties#synonym",
      "type": "code"
    },
    {
      "code": "comment",
      "uri": "http://hl7.org/fhir/concept-properties#comment",
      "type": "string"
    },
    {
      "code": "itemWeight",
      "uri": "http://hl7.org/fhir/concept-properties#itemWeight",
      "type": "decimal"
    }
  ],
  "concept": [
    {
      "code": "_GeneralAddressUse",
      "display": "_GeneralAddressUse",
      "definition": "Description: Address uses that can apply to both postal and telecommunication addresses.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": true
        }
      ],
      "concept": [
        {
          "code": "BAD",
          "display": "bad address",
          "definition": "Description: A flag indicating that the address is bad, in fact, useless.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "CONF",
          "display": "confidential address",
          "definition": "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.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "H",
          "display": "home address",
          "definition": "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.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ],
          "concept": [
            {
              "code": "HP",
              "display": "primary home",
              "definition": "Description: The primary home, to reach a person after business hours.",
              "property": [
                {
                  "code": "notSelectable",
                  "valueBoolean": false
                }
              ]
            },
            {
              "code": "HV",
              "display": "vacation home",
              "definition": "Description: A vacation home, to reach a person while on vacation.",
              "property": [
                {
                  "code": "notSelectable",
                  "valueBoolean": false
                }
              ]
            }
          ]
        },
        {
          "code": "OLD",
          "display": "no longer in use",
          "definition": "This address is no longer in use.                                                      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.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "TMP",
          "display": "temporary address",
          "definition": "Description: A temporary address, may be good for visit or mailing. Note that an address history can provide more detailed information.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "WP",
          "display": "work place",
          "definition": "Description: An office address. First choice for business related contacts during business hours.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ],
          "concept": [
            {
              "code": "DIR",
              "display": "direct",
              "definition": "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'.",
              "property": [
                {
                  "code": "notSelectable",
                  "valueBoolean": false
                }
              ]
            },
            {
              "code": "PUB",
              "display": "public",
              "definition": "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.",
              "property": [
                {
                  "code": "notSelectable",
                  "valueBoolean": false
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "code": "_PostalAddressUse",
      "display": "_PostalAddressUse",
      "definition": "Description: Address uses that only apply to postal addresses, not telecommunication addresses.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": true
        }
      ],
      "concept": [
        {
          "code": "PHYS",
          "display": "physical visit address",
          "definition": "Description: Used primarily to visit an address.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "PST",
          "display": "postal address",
          "definition": "Description: Used to send mail.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "_TelecommunicationAddressUse",
      "display": "_TelecommunicationAddressUse",
      "definition": "Description: Address uses that only apply to telecommunication addresses, not postal addresses.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": true
        }
      ],
      "concept": [
        {
          "code": "AS",
          "display": "answering service",
          "definition": "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.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "EC",
          "display": "emergency contact",
          "definition": "Description: A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "MC",
          "display": "mobile contact)",
          "definition": "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.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "PG",
          "display": "pager",
          "definition": "Description: A paging device suitable to solicit a callback or to leave a very short message.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    }
  ]
}