National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

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

Resource Profile: National Directory API Location Profile

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:

• Refer to this Resource Profile: National Directory API CareTeam Profile, National Directory API HealthcareService Profile, National Directory API InsurancePlan Profile, National Directory API Location Profile... Show 3 more, National Directory API Network Profile, National Directory API OrganizationAffiliation Profile and National Directory API PractitionerRole
• Examples for this Resource Profile: Hartford Hospital Location 1, HOPE FOOD DISPENSARY OF GREATER BALTIMORE, TOWSON FOOD DISPENSARY OF GREATER BALTIMORE COUNTY, LocationGen1... Show 4 more, LocationGen2, Welcome Home, The W Womens Shelter and The W Womens Shelter
• CapabilityStatements using this Resource Profile: National Directory API Base Expanded Server Capability Statement, National Directory API Base Server Capability Statement, National Directory API Capability Statement, NDH Attestation Server Capability Statement and NDH Verification Server Capability Statement

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NdhLocation	Details and position information for a physical place dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	SΣ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:location-boundary-geojson	S	0..1	Attachment	A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. ele-1: All FHIR elements must have a @value or children Fixed Value: active
name	SΣ	1..1	string	Name of the location as used by humans ele-1: All FHIR elements must have a @value or children
alias	S	0..*	string	A list of alternate names that the location is known as, or was known as, in the past ele-1: All FHIR elements must have a @value or children
description	SΣ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name ele-1: All FHIR elements must have a @value or children
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contact details of the location ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children
address	S	0..1	Address	Physical location ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both
text	SΣ	0..1	string	Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location. ele-1: All FHIR elements must have a @value or children
position	S	0..1	BackboneElement	The absolute geographic location ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
longitude	S	1..1	decimal	Longitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
latitude	S	1..1	decimal	Latitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
altitude	S	0..1	decimal	Altitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization responsible for provisioning and upkeep ele-1: All FHIR elements must have a @value or children
partOf	S	0..1	Reference(National Directory API Location Profile)	Another Location this one is physically a part of ele-1: All FHIR elements must have a @value or children
hoursOfOperation	S	0..*	BackboneElement	What days/times during a week is this location usually open ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children
allDay	S	0..1	boolean	The Location is open all day ele-1: All FHIR elements must have a @value or children
openingTime	S	0..1	time	Time that the Location opens ele-1: All FHIR elements must have a @value or children
closingTime	S	0..1	time	Time that the Location closes ele-1: All FHIR elements must have a @value or children
availabilityExceptions	S	0..1	string	Description of availability exceptions ele-1: All FHIR elements must have a @value or children
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to services operated for the location ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Location.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Location.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.type	extensible	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Location.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
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

This structure is derived from NdhLocation

Name	Flags	Card.	Type	Description & Constraints
Location			NdhLocation
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:location-boundary-geojson	S	0..1	boundary-geojson(4.0.1)	A boundary shape that represents the outside edge of the location (in GeoJSON format)
extension:accessibility	S	0..*	Accessibility	NDH Accessibility
extension:newpatients	S	0..*	NewPatients	NDH New Patients
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
identifier	S	0..*	Identifier	Unique code or number identifying the location to its users
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
alias	S	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	S	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode		0..0
telecom
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
address
use	S	0..1	code	home | work | temp | old | billing - purpose of this address
type	S	0..1	code	postal | physical | both
text	S	0..1	string	Text representation of the address
physicalType	S	0..1	CodeableConcept	Physical form of the location
position	S	0..1	BackboneElement	The absolute geographic location
longitude	S	1..1	decimal	Longitude with WGS84 datum
latitude	S	1..1	decimal	Latitude with WGS84 datum
altitude	S	0..1	decimal	Altitude with WGS84 datum
managingOrganization		0..1	Reference(National Directory API Organization Profile)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(National Directory API Location Profile)	Another Location this one is physically a part of
hoursOfOperation	S	0..*	BackboneElement	What days/times during a week is this location usually open
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	The Location is open all day
openingTime	S	0..1	time	Time that the Location opens
closingTime	S	0..1	time	Time that the Location closes
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint		0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to services operated for the location
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NdhLocation	Details and position information for a physical place
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	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	Σ	1..1	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		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:location-boundary-geojson	S	0..1	Attachment	A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
extension:accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
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	S	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	SΣ	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
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	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	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	SΣ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	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	SΣ	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	S	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	S	1..1	decimal	Longitude with WGS84 datum
latitude	S	1..1	decimal	Latitude with WGS84 datum
altitude	S	0..1	decimal	Altitude with WGS84 datum
managingOrganization	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization responsible for provisioning and upkeep
partOf	S	0..1	Reference(National Directory API Location Profile)	Another Location this one is physically a part of
hoursOfOperation	S	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	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	The Location is open all day
openingTime	S	0..1	time	Time that the Location opens
closingTime	S	0..1	time	Time that the Location closes
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Location.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Location.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Location.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Location.status	required	Fixed Value: active 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.type	extensible	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Location.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
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

This structure is derived from NdhLocation

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 34 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)
• National Directory API Location Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Location)
• National Directory API Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NdhLocation	Details and position information for a physical place dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	SΣ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:location-boundary-geojson	S	0..1	Attachment	A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. ele-1: All FHIR elements must have a @value or children Fixed Value: active
name	SΣ	1..1	string	Name of the location as used by humans ele-1: All FHIR elements must have a @value or children
alias	S	0..*	string	A list of alternate names that the location is known as, or was known as, in the past ele-1: All FHIR elements must have a @value or children
description	SΣ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name ele-1: All FHIR elements must have a @value or children
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contact details of the location ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children
address	S	0..1	Address	Physical location ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both
text	SΣ	0..1	string	Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location. ele-1: All FHIR elements must have a @value or children
position	S	0..1	BackboneElement	The absolute geographic location ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
longitude	S	1..1	decimal	Longitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
latitude	S	1..1	decimal	Latitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
altitude	S	0..1	decimal	Altitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization responsible for provisioning and upkeep ele-1: All FHIR elements must have a @value or children
partOf	S	0..1	Reference(National Directory API Location Profile)	Another Location this one is physically a part of ele-1: All FHIR elements must have a @value or children
hoursOfOperation	S	0..*	BackboneElement	What days/times during a week is this location usually open ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children
allDay	S	0..1	boolean	The Location is open all day ele-1: All FHIR elements must have a @value or children
openingTime	S	0..1	time	Time that the Location opens ele-1: All FHIR elements must have a @value or children
closingTime	S	0..1	time	Time that the Location closes ele-1: All FHIR elements must have a @value or children
availabilityExceptions	S	0..1	string	Description of availability exceptions ele-1: All FHIR elements must have a @value or children
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to services operated for the location ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Location.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Location.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.type	extensible	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Location.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
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

Differential View

This structure is derived from NdhLocation

Name	Flags	Card.	Type	Description & Constraints
Location			NdhLocation
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:location-boundary-geojson	S	0..1	boundary-geojson(4.0.1)	A boundary shape that represents the outside edge of the location (in GeoJSON format)
extension:accessibility	S	0..*	Accessibility	NDH Accessibility
extension:newpatients	S	0..*	NewPatients	NDH New Patients
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
identifier	S	0..*	Identifier	Unique code or number identifying the location to its users
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
alias	S	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	S	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode		0..0
telecom
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
address
use	S	0..1	code	home | work | temp | old | billing - purpose of this address
type	S	0..1	code	postal | physical | both
text	S	0..1	string	Text representation of the address
physicalType	S	0..1	CodeableConcept	Physical form of the location
position	S	0..1	BackboneElement	The absolute geographic location
longitude	S	1..1	decimal	Longitude with WGS84 datum
latitude	S	1..1	decimal	Latitude with WGS84 datum
altitude	S	0..1	decimal	Altitude with WGS84 datum
managingOrganization		0..1	Reference(National Directory API Organization Profile)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(National Directory API Location Profile)	Another Location this one is physically a part of
hoursOfOperation	S	0..*	BackboneElement	What days/times during a week is this location usually open
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	The Location is open all day
openingTime	S	0..1	time	Time that the Location opens
closingTime	S	0..1	time	Time that the Location closes
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint		0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to services operated for the location
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	NdhLocation	Details and position information for a physical place
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	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	Σ	1..1	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		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:location-boundary-geojson	S	0..1	Attachment	A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
extension:accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique code or number identifying the location to its users
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
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	S	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	SΣ	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
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	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	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	SΣ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	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	SΣ	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	S	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	S	1..1	decimal	Longitude with WGS84 datum
latitude	S	1..1	decimal	Latitude with WGS84 datum
altitude	S	0..1	decimal	Altitude with WGS84 datum
managingOrganization	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization responsible for provisioning and upkeep
partOf	S	0..1	Reference(National Directory API Location Profile)	Another Location this one is physically a part of
hoursOfOperation	S	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	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	The Location is open all day
openingTime	S	0..1	time	Time that the Location opens
closingTime	S	0..1	time	Time that the Location closes
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Location.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Location.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Location.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Location.status	required	Fixed Value: active 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.type	extensible	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Location.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
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

This structure is derived from NdhLocation

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 34 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)
• National Directory API Location Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Location)
• National Directory API Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint)

Other representations of profile: CSV, Excel, Schematron