US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

This page is part of the US Public Health Profiles Library (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, 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-08-17 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:

Formal Views of Extension Content

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

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Public Health Address Extension
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
... value[x] S0..1AddressValue of extension
Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... type S0..1codepostal | physical | both
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... district S0..1stringDistrict name (aka county)
.... state S0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred): USPS Two Letter Alphabetic Codes

.... postalCode S0..1stringPostal code for area
.... country S1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Public Health Address Extension
... id 0..1stringUnique id for inter-element referencing
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred): USPS Two Letter Alphabetic Codes

.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Public Health Address Extension
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
... value[x] S0..1AddressValue of extension
Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... type S0..1codepostal | physical | both
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... district S0..1stringDistrict name (aka county)
.... state S0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred): USPS Two Letter Alphabetic Codes

.... postalCode S0..1stringPostal code for area
.... country S1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Public Health Address Extension
... id 0..1stringUnique id for inter-element referencing
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred): USPS Two Letter Alphabetic Codes

.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.value[x].userequiredAddressUse
Extension.value[x].typerequiredAddressType
Extension.value[x].statepreferredUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)