US Public Health Profiles Library
​2.0.0 - United States of America flag

US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Extension: US Public Health Address Extension

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension Version: 2.0.0
Standards status: Trial-use Active as of 2025-10-23 Maturity Level: 3 Computable Name: USPublicHealthAddressExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.1

This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).

Context of Use

At the least, address must contain the country. State is required if the country is US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Address Extension
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
... value[x] S 0..1 Address Value of extension
Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
.... type S 0..1 code postal | physical | both
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (preferred): USPS Two Letter Alphabetic Codes
.... postalCode S 0..1 string Postal code for area
.... country S 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.value[x].state Base preferred USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Address Extension
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (preferred): USPS Two Letter Alphabetic Codes
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Extension.value[x].type Base required AddressType 📍4.0.1 FHIR Std.
Extension.value[x].state Base preferred USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
ele-1 error Extension, Extension.value[x], Extension.value[x].extension, Extension.value[x].use, Extension.value[x].type, Extension.value[x].text, Extension.value[x].line, Extension.value[x].city, Extension.value[x].district, Extension.value[x].state, Extension.value[x].postalCode, Extension.value[x].country, Extension.value[x].period All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Extension, Extension.value[x].extension Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Extension with the type Address: This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).

Maturity: 3

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Address Extension
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
... value[x] S 0..1 Address Value of extension
Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
.... type S 0..1 code postal | physical | both
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (preferred): USPS Two Letter Alphabetic Codes
.... postalCode S 0..1 string Postal code for area
.... country S 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.value[x].state Base preferred USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Address Extension
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (preferred): USPS Two Letter Alphabetic Codes
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Extension.value[x].type Base required AddressType 📍4.0.1 FHIR Std.
Extension.value[x].state Base preferred USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
ele-1 error Extension, Extension.value[x], Extension.value[x].extension, Extension.value[x].use, Extension.value[x].type, Extension.value[x].text, Extension.value[x].line, Extension.value[x].city, Extension.value[x].district, Extension.value[x].state, Extension.value[x].postalCode, Extension.value[x].country, Extension.value[x].period All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Extension, Extension.value[x].extension Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Extension with the type Address: This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron