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

## Resource Profile: US Public Health Location

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location | Version: 1.0.0
Active as of 2023-10-04 | 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:

- adds must support identifier
- adds a required type
- adds required addr.city and addr.state
- further constrain managingOrganization to US Public Health Organization

Usage:

- Refer to this Resource Profile: US Public Health Encounter, US Public Health Exposure Contact Information and US Public Health PractitionerRole
- Examples for this Resource Profile: Clinic Bldg A, Salem Medical Center

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from USCoreLocation

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* | USCoreLocation | Details and position information for a physical place
identifier | S | 0..* | Identifier | Facility ID Number
type | S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType
address |  | 1..1 | Address | Physical location
city |  | 1..1 | string | Name of city, town etc.
state |  | 1..1 | string | Sub-unit of country (abbreviations ok)
managingOrganization |  | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Location.type | extensible | ServiceDeliveryLocationRoleType

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* | USCoreLocation | Details and position information for a physical place
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Facility ID Number
status | ?!S Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name | S Σ | 1..1 | string | Name of the location as used by humans
type | S Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 1..1 | Address | Physical location
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
managingOrganization | S Σ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep
Documentation for this format

#### Terminology Bindings

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
--- | --- | --- | --- | ---
Location |  | 0..* | USCoreLocation | Details and position information for a physical place
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Facility ID Number
status | ?!S Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus | Σ | 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).
name | S Σ | 1..1 | string | Name of the location as used by humans
alias |  | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type | S Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 1..1 | Address | Physical location
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 | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | Σ | 0..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"}
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location.
position |  | 0..1 | BackboneElement | The absolute geographic location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | S Σ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(Location) | Another Location this one is physically a part of
hoursOfOperation |  | 0..* | BackboneElement | What days/times during a week is this location usually open
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | The Location is open all day
openingTime |  | 0..1 | time | Time that the Location opens
closingTime |  | 0..1 | time | Time that the Location closes
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Location.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
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

Summary

Mandatory: 4 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- US Public Health Organization (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization)

Differential View

This structure is derived from USCoreLocation

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* | USCoreLocation | Details and position information for a physical place
identifier | S | 0..* | Identifier | Facility ID Number
type | S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType
address |  | 1..1 | Address | Physical location
city |  | 1..1 | string | Name of city, town etc.
state |  | 1..1 | string | Sub-unit of country (abbreviations ok)
managingOrganization |  | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Location.type | extensible | ServiceDeliveryLocationRoleType

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* | USCoreLocation | Details and position information for a physical place
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Facility ID Number
status | ?!S Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name | S Σ | 1..1 | string | Name of the location as used by humans
type | S Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 1..1 | Address | Physical location
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
managingOrganization | S Σ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep
Documentation for this format

#### Terminology Bindings

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
--- | --- | --- | --- | ---
Location |  | 0..* | USCoreLocation | Details and position information for a physical place
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Facility ID Number
status | ?!S Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus | Σ | 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).
name | S Σ | 1..1 | string | Name of the location as used by humans
alias |  | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type | S Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 1..1 | Address | Physical location
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 | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | Σ | 0..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"}
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location.
position |  | 0..1 | BackboneElement | The absolute geographic location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | S Σ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(Location) | Another Location this one is physically a part of
hoursOfOperation |  | 0..* | BackboneElement | What days/times during a week is this location usually open
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | The Location is open all day
openingTime |  | 0..1 | time | Time that the Location opens
closingTime |  | 0..1 | time | Time that the Location closes
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Location.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
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

Summary

Mandatory: 4 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- US Public Health Organization (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization)

Other representations of profile: CSV, Excel, Schematron