HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG, published by HRSA BPHC. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/drajer-health/uds-plus/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: UDS Plus Location

Indicates the location where the care was provided

Usage:

• Refer to this Resource Profile: De-Identified UDS Plus Encounter
• Examples for this Resource Profile: Holy Family Hospital

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	Indicates the location where the service was provided
type	S	0..*	CodeableConcept	Type of function performed Binding: Uds Plus Service Delivery Codes (extensible): The set of codes indicating the location of service
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.type	extensible	UdsPlusServiceDeliveryCodes http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-service-delivery-codes from this IG

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	Indicates the location where the service was provided
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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Σ	0..*	CodeableConcept	Type of function performed Binding: Uds Plus Service Delivery Codes (extensible): The set of codes indicating the location of service
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..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Σ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..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 Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.type	extensible	UdsPlusServiceDeliveryCodes http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-service-delivery-codes from this IG
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	Indicates the location where the service was provided
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	Σ	0..*	Identifier	Unique code or number identifying the location to its users
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Σ	0..*	CodeableConcept	Type of function performed Binding: Uds Plus Service Delivery Codes (extensible): The set of codes indicating the location of service
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..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Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	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 (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 Core Organization Profile)	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	URI
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.operationalStatus	preferred	Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard
Location.type	extensible	UdsPlusServiceDeliveryCodes http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-service-delivery-codes from this IG
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from USCoreLocation

Summary

Must-Support: 1 element

Maturity: 2

Differential View

This structure is derived from USCoreLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	Indicates the location where the service was provided
type	S	0..*	CodeableConcept	Type of function performed Binding: Uds Plus Service Delivery Codes (extensible): The set of codes indicating the location of service
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.type	extensible	UdsPlusServiceDeliveryCodes http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-service-delivery-codes from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	Indicates the location where the service was provided
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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Σ	0..*	CodeableConcept	Type of function performed Binding: Uds Plus Service Delivery Codes (extensible): The set of codes indicating the location of service
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..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Σ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..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 Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.type	extensible	UdsPlusServiceDeliveryCodes http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-service-delivery-codes from this IG
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	Indicates the location where the service was provided
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	Σ	0..*	Identifier	Unique code or number identifying the location to its users
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Σ	0..*	CodeableConcept	Type of function performed Binding: Uds Plus Service Delivery Codes (extensible): The set of codes indicating the location of service
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..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Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	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 (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 Core Organization Profile)	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	URI
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.operationalStatus	preferred	Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard
Location.type	extensible	UdsPlusServiceDeliveryCodes http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-service-delivery-codes from this IG
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from USCoreLocation

Summary

Must-Support: 1 element

Maturity: 2

Other representations of profile: CSV, Excel, Schematron