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 in its permanent home (it will always be available at this URL). 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-location | Version: 1.0.0 | |||
Active as of 2023-08-17 | Computable Name: USPublicHealthLocation |
This Location profile represents the location/facility in which care was provided.
It is based on the US Core Location profile and further constrains it:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreLocation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USCoreLocation | Details and position information for a physical place | |
![]() ![]() ![]() | S | 0..* | Identifier | Facility ID Number |
![]() ![]() ![]() | S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() ![]() | 1..1 | Address | Physical location | |
![]() ![]() ![]() ![]() | 1..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() | 1..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep | |
![]() |
Path | Conformance | ValueSet |
Location.type | extensible | ServiceDeliveryLocationRoleType |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USCoreLocation | Details and position information for a physical place | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | Facility ID Number |
![]() ![]() ![]() | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() ![]() | SΣ | 1..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() ![]() | S | 1..1 | Address | Physical location |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() | 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 |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() | SΣ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep |
![]() |
Path | Conformance | ValueSet |
Location.status | required | LocationStatus |
Location.type | extensible | ServiceDeliveryLocationRoleType |
Location.address.use | required | AddressUse |
Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | USCoreLocation | Details and position information for a physical place | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣ | 0..* | Identifier | Facility ID Number | ||||
![]() ![]() ![]() | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
![]() ![]() ![]() | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
![]() ![]() ![]() | SΣ | 1..1 | string | Name of the location as used by humans | ||||
![]() ![]() ![]() | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() ![]() | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() ![]() | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType | ||||
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location | ||||
![]() ![]() ![]() | S | 1..1 | Address | Physical location | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
![]() ![]() ![]() | 0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() ![]() | SΣ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
![]() ![]() ![]() | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | The Location is open all day | |||||
![]() ![]() ![]() ![]() | 0..1 | time | Time that the Location opens | |||||
![]() ![]() ![]() ![]() | 0..1 | time | Time that the Location closes | |||||
![]() ![]() ![]() | 0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
![]() |
Path | Conformance | ValueSet | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.status | required | LocationStatus | ||||
Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
Location.mode | required | LocationMode | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.address.use | required | AddressUse | ||||
Location.address.type | required | AddressType | ||||
Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) | ||||
Location.physicalType | example | LocationType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
This structure is derived from USCoreLocation
Differential View
This structure is derived from USCoreLocation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USCoreLocation | Details and position information for a physical place | |
![]() ![]() ![]() | S | 0..* | Identifier | Facility ID Number |
![]() ![]() ![]() | S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() ![]() | 1..1 | Address | Physical location | |
![]() ![]() ![]() ![]() | 1..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() | 1..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep | |
![]() |
Path | Conformance | ValueSet |
Location.type | extensible | ServiceDeliveryLocationRoleType |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USCoreLocation | Details and position information for a physical place | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | Facility ID Number |
![]() ![]() ![]() | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() ![]() | SΣ | 1..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() ![]() | S | 1..1 | Address | Physical location |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() | 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 |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() | SΣ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep |
![]() |
Path | Conformance | ValueSet |
Location.status | required | LocationStatus |
Location.type | extensible | ServiceDeliveryLocationRoleType |
Location.address.use | required | AddressUse |
Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | USCoreLocation | Details and position information for a physical place | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣ | 0..* | Identifier | Facility ID Number | ||||
![]() ![]() ![]() | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
![]() ![]() ![]() | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
![]() ![]() ![]() | SΣ | 1..1 | string | Name of the location as used by humans | ||||
![]() ![]() ![]() | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() ![]() | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() ![]() | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType | ||||
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location | ||||
![]() ![]() ![]() | S | 1..1 | Address | Physical location | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
![]() ![]() ![]() | 0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() ![]() | SΣ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
![]() ![]() ![]() | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | The Location is open all day | |||||
![]() ![]() ![]() ![]() | 0..1 | time | Time that the Location opens | |||||
![]() ![]() ![]() ![]() | 0..1 | time | Time that the Location closes | |||||
![]() ![]() ![]() | 0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
![]() |
Path | Conformance | ValueSet | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.status | required | LocationStatus | ||||
Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
Location.mode | required | LocationMode | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.address.use | required | AddressUse | ||||
Location.address.type | required | AddressType | ||||
Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) | ||||
Location.physicalType | example | LocationType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
This structure is derived from USCoreLocation
Other representations of profile: CSV, Excel, Schematron