US Public Health Profiles Library
1.0.0 - STU1

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ 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: 1.0.0
Active as of 2023-10-04 | Computable Name: USPublicHealthAddressExtension

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

This extension may be used on the following element(s):

- Element ID Observation.component
- Element ID Observation

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

Usage:

- Use this Extension: US Public Health Exposure Contact Information and US Public Health Travel History
- Examples for this Extension: Observation/us-ph-travel-history-eve-everywoman-201610

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from Extension

Summary

Simple Extension of 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).

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | 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: USPS Two Letter Alphabetic Codes (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)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | US Public Health Address Extension
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"
value[x] | S | 0..1 | Address | Value of extension Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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: USPS Two Letter Alphabetic Codes (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"}
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of 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).

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | 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: USPS Two Letter Alphabetic Codes (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)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | US Public Health Address Extension
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"
value[x] | S | 0..1 | Address | Value of extension Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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: USPS Two Letter Alphabetic Codes (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"}
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
Extension.value[x].use | required | AddressUse
Extension.value[x].type | required | AddressType
Extension.value[x].state | preferred | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)