Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Location Must Have:

1. A name

Each Location Must Support:

1. Location or facility identifier
2. A status (whether in use)
3. The type of location or facility¹
4. Contact details of the location
5. A Location address²
6. The managing organization

^1,2 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

• US Core Encounter Profile and the US Core Immunization Profile link directly to US Core Location via Encounter.location and Immunization.location.
• The following US Core Profiles indirectly reference the location/facility through references to US Core Encounter:
  • US Core DiagnosticReport Profile for Laboratory Results Reporting
  • US Core Immunization Profile
  • US Core MedicationDispense Profile
  • US Core Observation Clinical Result Profile
  • US Core Procedure Profile
  • US Core ServiceRequest Profile

  If the event facility/location differs from the Encounter.location, systems SHOULD reference it directly:^§

  • Systems SHALL use the location element for all resources where the element is available.^§
  • Systems MAY use the standard Event Location Extension for US Core DiagnosticReport Profile for Laboratory Results Reporting and US Core Observation Clinical Result Profile.^§
• ¹Location.type is a grouped value set composed of four value sets to meet multiple industry needs for identifying service locations:
  • The Service Delivery Location Role Type value set is inherited from the base resource, and, although its binding strength is extensible in the base resource, US Core implementers MAY treat it as preferred.^§
  • Healthcare Service Location Codes (HSLOC) and SNOMED-CT Healthcare Facility Type value sets meet the USCDI applicable vocabulary standard for the Encounter Location Data Element. Certifying Systems MAY use a code from either vocabulary.^§
  • The CMS Place of Service (POS) value set meets the Health Insurance Portability and Accountability Act of 1996 (HIPAA) requirements for billing and Payers.
• ² For Location.address.state, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD use the ISO 3166 subdivision codes.^§

Changes since version 9.0.0:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Unique business identifier for facility or location.
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name by which a facility or location is known.
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible)
Location.type.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Location.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Location.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Location.telecom	S This element must be supported.	0..*	ContactPoint	Contact details of the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Location.address.line	S This element must be supported. Σ This element is included in summaries.	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 Example US Core: 49 MEADOW ST
Location.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Location.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Location.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.type	Base	extensible	US Core Location Type Codes	📦10.0.0-ballot	This IG
Location.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Location.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.identifier	S This element must be supported.	0..*	Identifier	Unique business identifier for facility or location.
Location.status	S This element must be supported.	0..1	code	active | suspended | inactive
Location.name	S This element must be supported.	1..1	string	Name by which a facility or location is known.
Location.type	S This element must be supported.	0..*	CodeableConcept	Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible)
Location.type.coding	S This element must be supported.	1..*	Coding	Code defined by a terminology system
Location.type.coding.system	S This element must be supported.	1..1	uri	Identity of the terminology system
Location.type.coding.code	S This element must be supported.	1..1	code	Symbol in syntax defined by the system
Location.telecom	S This element must be supported.	0..*	ContactPoint	Contact details of the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.address.line	S This element must be supported.	0..*	string	Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
Location.address.city	S This element must be supported.	0..1	string	Name of city, town etc. Example US Core: EVERYTOWN
Location.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Location.address.postalCode	S This element must be supported.	0..1	string	US Zip Codes Example US Core: 74047
Location.managingOrganization	S This element must be supported.	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Location.type	Base	extensible	US Core Location Type Codes	📦10.0.0-ballot	This IG
Location.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Location.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Location.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Location.contained		0..*	Resource	Contained, inline Resources
Location.extension		0..*	Extension	Additional content defined by implementations
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Unique business identifier for facility or location.
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus	Σ This element is included in summaries.	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).
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name by which a facility or location is known.
Location.alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
Location.description	Σ This element is included in summaries.	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode	Σ This element is included in summaries.	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible)
Location.type.id		0..1	string	Unique id for inter-element referencing
Location.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.type.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Location.type.coding.id		0..1	string	Unique id for inter-element referencing
Location.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Location.type.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Location.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Location.type.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Location.type.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Location.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Location.telecom	S This element must be supported.	0..*	ContactPoint	Contact details of the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.address.id		0..1	string	Unique id for inter-element referencing
Location.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Location.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Location.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line	S This element must be supported. Σ This element is included in summaries.	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 Example US Core: 49 MEADOW ST
Location.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Location.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Location.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Location.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Location.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Location.address.period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType	Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
Location.position		0..1	BackboneElement	The absolute geographic location
Location.position.id		0..1	string	Unique id for inter-element referencing
Location.position.extension		0..*	Extension	Additional content defined by implementations
Location.position.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.position.longitude		1..1	decimal	Longitude with WGS84 datum
Location.position.latitude		1..1	decimal	Latitude with WGS84 datum
Location.position.altitude		0..1	decimal	Altitude with WGS84 datum
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(Location)	Another Location this one is physically a part of
Location.hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
Location.hoursOfOperation.id		0..1	string	Unique id for inter-element referencing
Location.hoursOfOperation.extension		0..*	Extension	Additional content defined by implementations
Location.hoursOfOperation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay		0..1	boolean	The Location is open all day
Location.hoursOfOperation.openingTime		0..1	time	Time that the Location opens
Location.hoursOfOperation.closingTime		0..1	time	Time that the Location closes
Location.availabilityExceptions		0..1	string	Description of availability exceptions
Location.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.operationalStatus	Base	preferred	hl7VS-bedStatus	📦3.0.0	THO v7.4
Location.mode	Base	required	LocationMode	📍4.0.1	FHIR Std.
Location.type	Base	extensible	US Core Location Type Codes	📦10.0.0-ballot	This IG
Location.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Location.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Location.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.
Location.hoursOfOperation.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Unique business identifier for facility or location.
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name by which a facility or location is known.
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible)
Location.type.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Location.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Location.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Location.telecom	S This element must be supported.	0..*	ContactPoint	Contact details of the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Location.address.line	S This element must be supported. Σ This element is included in summaries.	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 Example US Core: 49 MEADOW ST
Location.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Location.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Location.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.type	Base	extensible	US Core Location Type Codes	📦10.0.0-ballot	This IG
Location.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Location.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.identifier	S This element must be supported.	0..*	Identifier	Unique business identifier for facility or location.
Location.status	S This element must be supported.	0..1	code	active | suspended | inactive
Location.name	S This element must be supported.	1..1	string	Name by which a facility or location is known.
Location.type	S This element must be supported.	0..*	CodeableConcept	Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible)
Location.type.coding	S This element must be supported.	1..*	Coding	Code defined by a terminology system
Location.type.coding.system	S This element must be supported.	1..1	uri	Identity of the terminology system
Location.type.coding.code	S This element must be supported.	1..1	code	Symbol in syntax defined by the system
Location.telecom	S This element must be supported.	0..*	ContactPoint	Contact details of the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.address.line	S This element must be supported.	0..*	string	Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
Location.address.city	S This element must be supported.	0..1	string	Name of city, town etc. Example US Core: EVERYTOWN
Location.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Location.address.postalCode	S This element must be supported.	0..1	string	US Zip Codes Example US Core: 74047
Location.managingOrganization	S This element must be supported.	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Location.type	Base	extensible	US Core Location Type Codes	📦10.0.0-ballot	This IG
Location.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Location.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Location.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Location.contained		0..*	Resource	Contained, inline Resources
Location.extension		0..*	Extension	Additional content defined by implementations
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Unique business identifier for facility or location.
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus	Σ This element is included in summaries.	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).
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name by which a facility or location is known.
Location.alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
Location.description	Σ This element is included in summaries.	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode	Σ This element is included in summaries.	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible)
Location.type.id		0..1	string	Unique id for inter-element referencing
Location.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.type.coding	S This element must be supported. Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system
Location.type.coding.id		0..1	string	Unique id for inter-element referencing
Location.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Location.type.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Location.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Location.type.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Location.type.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Location.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Location.telecom	S This element must be supported.	0..*	ContactPoint	Contact details of the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.address.id		0..1	string	Unique id for inter-element referencing
Location.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Location.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Location.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line	S This element must be supported. Σ This element is included in summaries.	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 Example US Core: 49 MEADOW ST
Location.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Location.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Location.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Location.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Location.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Location.address.period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType	Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
Location.position		0..1	BackboneElement	The absolute geographic location
Location.position.id		0..1	string	Unique id for inter-element referencing
Location.position.extension		0..*	Extension	Additional content defined by implementations
Location.position.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.position.longitude		1..1	decimal	Longitude with WGS84 datum
Location.position.latitude		1..1	decimal	Latitude with WGS84 datum
Location.position.altitude		0..1	decimal	Altitude with WGS84 datum
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(Location)	Another Location this one is physically a part of
Location.hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
Location.hoursOfOperation.id		0..1	string	Unique id for inter-element referencing
Location.hoursOfOperation.extension		0..*	Extension	Additional content defined by implementations
Location.hoursOfOperation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay		0..1	boolean	The Location is open all day
Location.hoursOfOperation.openingTime		0..1	time	Time that the Location opens
Location.hoursOfOperation.closingTime		0..1	time	Time that the Location closes
Location.availabilityExceptions		0..1	string	Description of availability exceptions
Location.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.operationalStatus	Base	preferred	hl7VS-bedStatus	📦3.0.0	THO v7.4
Location.mode	Base	required	LocationMode	📍4.0.1	FHIR Std.
Location.type	Base	extensible	US Core Location Type Codes	📦10.0.0-ballot	This IG
Location.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Location.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Location.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4
Location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.
Location.hoursOfOperation.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

• US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)

Maturity: 5

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

• See the Scopes Format section for a description of the SMART scopes syntax.
• See the Search Syntax section for a description of the US Core search syntax.
• See the General Requirements section for additional rules and expectations when a Server requires status parameters.
• See the General Guidance section for additional guidance on searching for multiple patients.

US Core Scopes

Servers providing access to data MAY support these US Core SMART Scopes:

• resource level scopes: <patient|user|system>/Location.rs ^§

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching location based on text address using the address search parameter

   GET [base]/Location?address=[address]

   Example:

   1. GET [base]/Location?address=Arbor

   Implementation Notes: Fetches a bundle of all US Core Location Profile resources that match the address string ( see how to search by string).

2. SHALL support searching by location name using the name search parameter

   GET [base]/Location?name=[name]

   Example:

   1. GET [base]/Location?name=Health

   Implementation Notes: Fetches a bundle of all US Core Location Profile resources that match the name ( see how to search by string).

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported

1. SHOULD support searching location by city using the address-city search parameter

   GET [base]/Location?address-city=[address-city]

   Example:

   1. GET [base]/Location?address-city=Ann Arbor

   Implementation Notes: Fetches a bundle of all US Core Location Profile resources for the city ( see how to search by string).

2. SHOULD support searching location by ZIP code using the address-postalcode search parameter

   GET [base]/Location?address-postalcode=[address-postalcode]

   Example:

   1. GET [base]/Location?address-postalcode=48104

   Implementation Notes: Fetches a bundle of all US Core Location Profile resources for the ZIP code ( see how to search by string).

3. SHOULD support searching location by state using the address-state search parameter

   GET [base]/Location?address-state=[address-state]

   Example:

   1. GET [base]/Location?address-state=MI

   Implementation Notes: Fetches a bundle of all US Core Location Profile resources for the state ( see how to search by string).