This page is part of the US Public Health Profiles Library (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension | Version: 1.0.0-ballot | |||
Active as of 2022-08-05 | 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).
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.
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..1 | Extension | US Public Health Address Extension | |
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..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
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
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..1 | Extension | US Public Health Address Extension | |
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..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
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
Path | Conformance | ValueSet |
Extension.value[x].use | required | AddressUse |
Extension.value[x].type | required | AddressType |
Extension.value[x].state | preferred | UspsTwoLetterAlphabeticCodes |
Id | Grade | Path | Details | Requirements |
ele-1 | error | Extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Extension.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Extension.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Extension.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Extension.value[x].extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Extension.value[x].use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Extension.value[x].period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |