National Healthcare Directory Attestation and Verification, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-attestation/ and changes regularly. See the Directory of published versions

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

Resource Profile: NatDir Location

A Location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.

Usage:

• Examples for this Resource Profile: Cancer Clinic

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 NatlDirExLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NatlDirExLocation	Details and position information for a physical place
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NatlDirExLocation	Details and position information for a physical place
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
accessibility		0..*	CodeableConcept	Accessibility URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility Binding: Accessibility Value Set (extensible)
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
region		0..1	Attachment	Associated Region (GeoJSON) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active
name	SΣ	1..1	string	Name of the location as used by humans
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
telecom	S	0..*	ContactPoint	Contact details of the location
contactpoint-availabletime		0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary		0..*	Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)	Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
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
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
managingOrganization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization responsible for provisioning and upkeep
partOf	S	0..1	Reference(National Directory Endpoint Qry Exchange Location)	Another Location this one is physically a part of
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.status	required	Fixed Value: active
Location.type	extensible	ServiceDeliveryLocationRoleType
Location.telecom.use	required	ContactPointUse
Location.address.use	required	AddressUse
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Location.physicalType	example	LocationType

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NatlDirExLocation	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accessibility		0..*	CodeableConcept	Accessibility URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility Binding: Accessibility Value Set (extensible)
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
region		0..1	Attachment	Associated Region (GeoJSON) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active
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
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
telecom	S	0..*	ContactPoint	Contact details of the location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime		0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary		0..*	Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)	Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
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	SΣ	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(National Directory Endpoint Qry Exchange Organization)	Organization responsible for provisioning and upkeep
partOf	S	0..1	Reference(National Directory Endpoint Qry Exchange 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	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.meta.security	extensible	All Security Labels
Location.meta.tag	example	CommonTags
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Location.status	required	Fixed Value: active
Location.operationalStatus	preferred	Hl7VSBedStatus
Location.type	extensible	ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem
Location.telecom.use	required	ContactPointUse
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 NatlDirExLocation

Summary

Differential View

This structure is derived from NatlDirExLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NatlDirExLocation	Details and position information for a physical place
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NatlDirExLocation	Details and position information for a physical place
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
accessibility		0..*	CodeableConcept	Accessibility URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility Binding: Accessibility Value Set (extensible)
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
region		0..1	Attachment	Associated Region (GeoJSON) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active
name	SΣ	1..1	string	Name of the location as used by humans
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
telecom	S	0..*	ContactPoint	Contact details of the location
contactpoint-availabletime		0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary		0..*	Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)	Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
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
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
managingOrganization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization responsible for provisioning and upkeep
partOf	S	0..1	Reference(National Directory Endpoint Qry Exchange Location)	Another Location this one is physically a part of
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.status	required	Fixed Value: active
Location.type	extensible	ServiceDeliveryLocationRoleType
Location.telecom.use	required	ContactPointUse
Location.address.use	required	AddressUse
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Location.physicalType	example	LocationType

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NatlDirExLocation	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accessibility		0..*	CodeableConcept	Accessibility URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility Binding: Accessibility Value Set (extensible)
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
region		0..1	Attachment	Associated Region (GeoJSON) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active
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
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
telecom	S	0..*	ContactPoint	Contact details of the location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime		0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary		0..*	Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)	Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
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	SΣ	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(National Directory Endpoint Qry Exchange Organization)	Organization responsible for provisioning and upkeep
partOf	S	0..1	Reference(National Directory Endpoint Qry Exchange 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	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.meta.security	extensible	All Security Labels
Location.meta.tag	example	CommonTags
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Location.status	required	Fixed Value: active
Location.operationalStatus	preferred	Hl7VSBedStatus
Location.type	extensible	ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem
Location.telecom.use	required	ContactPointUse
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 NatlDirExLocation

Summary

Other representations of profile: CSV, Excel, Schematron