National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

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-ballot 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

Resource Profile: NDH Base Location Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location Version: 1.0.0-ballot
Active as of 2024-06-17 Computable Name: NdhLocation

Copyright/Legal: HL7 International

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.

Background & Scope

Traditionally, a location refers to the physical place where healthcare services are provided, practitioners are employed, and organizations are based. This information is captured by the position element. For the National Directory, there is a need to address insurance plan coverage areas and insurance provider network coverage areas. This information is defined by the location-boundary-geojson extension element.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location USCoreLocation(6.1.0)
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... location-boundary-geojson 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
.... accessibility 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
.... newpatients 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... identifier
.... Slices for extension Content/Rules for all slices
..... identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1 Reference(NDH Base Organization Profile) Organization that issued id (may be just text)
... type S 0..* CodeableConcept Type of function performed
... telecom
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
... address
.... line 0..4 string Street name, number, direction & P.O. Box etc.
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... managingOrganization 0..1 Reference(NDH Base Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(NDH Base Location Profile) Another Location this one is physically a part of
... endpoint S 0..* Reference(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation(6.1.0) Details and position information for a physical place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... location-boundary-geojson 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
.... accessibility 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
.... newpatients C 0..* (Complex) 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
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... verification-status 0..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
... 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
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... 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..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
.... 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)
... managingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(NDH Base Location Profile) Another Location this one is physically a part of
... endpoint S 0..* Reference(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation(6.1.0) 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
... 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
.... location-boundary-geojson 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
.... accessibility 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
.... newpatients C 0..* (Complex) 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
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... verification-status 0..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 Σ 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 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 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 Σ 0..1 Reference(NDH Base 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 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ 0..* CodeableConcept Type of function performed
Binding: 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) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... 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..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 Σ 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(NDH Base Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(NDH Base Location Profile) 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(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location USCoreLocation(6.1.0)
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... location-boundary-geojson 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
.... accessibility 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
.... newpatients 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... identifier
.... Slices for extension Content/Rules for all slices
..... identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1 Reference(NDH Base Organization Profile) Organization that issued id (may be just text)
... type S 0..* CodeableConcept Type of function performed
... telecom
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
... address
.... line 0..4 string Street name, number, direction & P.O. Box etc.
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... managingOrganization 0..1 Reference(NDH Base Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(NDH Base Location Profile) Another Location this one is physically a part of
... endpoint S 0..* Reference(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation(6.1.0) Details and position information for a physical place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... location-boundary-geojson 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
.... accessibility 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
.... newpatients C 0..* (Complex) 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
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... verification-status 0..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
... 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
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... 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..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
.... 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)
... managingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(NDH Base Location Profile) Another Location this one is physically a part of
... endpoint S 0..* Reference(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation(6.1.0) 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
... 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
.... location-boundary-geojson 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
.... accessibility 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
.... newpatients C 0..* (Complex) 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
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... verification-status 0..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 Σ 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 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 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 Σ 0..1 Reference(NDH Base 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 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ 0..* CodeableConcept Type of function performed
Binding: 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) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... 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..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 Σ 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(NDH Base Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(NDH Base Location Profile) 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(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

SearchParameter Name Type Example
accessibility token GET [base]/Location?accessibility=cultcomp
contains special GET [base]/Location?contains=41.809006\|-71.41177
new-patient-from-network reference GET [base]/Location?new-patient-from-network=newpt
new-patient token GET [base]/Location?=new-patient=newpt

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

SearchParameter Name Type Example
address string GET [base]/Location?address=123 Ravissant ST
address-city string GET [base]/Location?address-city=Coconut Creek
address-country string GET [base]/Location?address-country=USA
address-postalcode string GET [base]/Location?address-postalcode=34997
address-state string GET [base]/Location?address-state=FL
address-use token GET [base]/Location?address-use=work
organization reference GET [base]/Location?organization.address-state=FL
type token GET [base]/Location?type=RH

_include Search Parameter

_include Example
Location:endpoint GET [base]/Location?_include=Location:endpoint
Location:new-patient-from-network GET [base]/Location?_include=Location:new-patient-from-network
Location:organization GET [base]/Location?_include=Location:organization
Location:partof GET [base]/Location?_include=Location:partof

_revinclude Search Parameter

_revinclude
CareTeam:careteam-location
HealthcareService:coverage-area
HealthcareService:location
InsurancePlan:coverage-area
OrganizationAffiliation:location
PractitionerRole:location

Special Search Parameters

The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.

Search for locations with managing organization

The FHIR path for the managing organization is Location.managingOrganization, but the search parameter is organization. For example, to search for all locations assoicated with an managingOrganization has ID Hospital should write as:

GET [base]/Location?organization=Organization/Hospital

You can also search for locations associated with the managing organizations by name or other criteria. For example, to search for all locations associated with an organization with the name of Hartford General Hospital:

GET [base]/Location?organization:Organization.name=Hartford General Hospital

You can add additional search criteria to further narrow down your search results. For example, to search for all locations associated with the Hartford General Hospital organization that have a status of active:

GET [base]/Location?organization:Organization.name=Hartford General Hospital&status=active

Including other resources in search result

You can search for all Locations and their associated related resources (in this case, organization) which are managering some of locations. The _include parameter to indicate that the managingOrganization resources be included in the result.

GET [base]//Location?_include=Location:organization

Search location-boundary-geojson

GeoJSON encodes spatial data structures, including points, lines, polygons, and multi-part collections of these types. It is a common format for representing simple geographic features along with their non-spatial attributes. For example, a polygon area for Washington, D.C. is represented as:

{
  "type"": ""Feature",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [-77.119759, 38.934343],
        [-77.041697, 38.99511],
        [-76.910535, 38.892912],
        [-77.038088, 38.791015],
        [-77.119759, 38.934343]
      ]
    ]
  },
  "properties": {
    "name"": "Washington, D.C."
  }
}
How to populate the location-boundary-geojson data in Location resource

The data type of the location-boundary-geojson is Attachment, with the contentType set to application/geo+json and the data formatted as base64Binary. To represent a polygon area for Washington, D.C., you can use a JSON to Base64 converter to transform the JSON data into base64Binary format, which will look like this:

{
  "resourceType" : "Location",
  "id" : "wash-dc-metro",
  "meta" : {
    "profile" : ["http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-location"]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Location</b><a name=\"wash-dc-metro\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource Location &quot;wash-dc-metro&quot; </p><p style=\"margin-bottom: 0px\">Profile: <code>http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-location</code></p></div><p><b>Location Boundary (GeoJSON)</b>: </p><p><b>status</b>: active</p><p><b>name</b>: <span title=\"  this record is active  \">Washington, DC metro area</span></p><p><b>form</b>: Area <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.3.0/CodeSystem-location-physical-type.html\">Location type</a>#area)</span></p></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/location-boundary-geojson",
    "valueAttachment" : {
      "contentType" : "application/geo+json",
      "data" : "VGhlbWU6IA0KUmF3UGFyc2VkDQp7InR5cGUiOiJGZWF0dXJlQ29sbGVjdGlvbiIsInByb3BlcnRpZXMiOnsia2luZCI6InN0YXRlIiwic3RhdGUiOiJEQyJ9LCJmZWF0dXJlcyI6Ww0KeyJ0eXBlIjoiRmVhdHVyZSIsInByb3BlcnRpZXMiOnsia2luZCI6ImNvdW50eSIsIm5hbWUiOiJEaXN0cmljdCBvZiBDb2x1bWJpYSIsInN0YXRlIjoiREMifSwiZ2VvbWV0cnkiOnsidHlwZSI6Ik11bHRpUG9seWdvbiIsImNvb3JkaW5hdGVzIjpbW1tbLTc3LjAzNTMsMzguOTkzOV0sWy03Ny4wMDI0LDM4Ljk2NjVdLFstNzYuOTA5MywzOC44OTUzXSxbLTc3LjA0MDcsMzguNzkxMl0sWy03Ny4wNDYyLDM4Ljg0MDVdLFstNzcuMDQwNywzOC44NzM0XSxbLTc3LjExNzQsMzguOTMzNl1dXV19fQ0KXX0=",
      "url" : "https://github.com/OpenDataDE/State-zip-code-GeoJSON/raw/master/dc_district_of_columbia_zip_codes_geo.min.json",
      "size" : "389"
    }
  }],
  "status" : "active",
  "name" : "Washington, DC metro area",
  "form" : {
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/location-physical-type",
      "code" : "area",
      "display" : "Area"
    }]
  }
}
How to search location-boundary-geojson

The special contains search parameter tests whether the provided geocoded point(s) (expressed as [latitude]|[longitude] using the WGS84 datum) are within the defined boundary. Support for multiple points can also be provided using the , syntax, which is interpreted as the location returned in the search containing at least one of the provided coordinates. For example, for the Washington, D.C. polygon area:

GET [base]/Location?contains=-77.119759|38.934343,-77.041697|38.99511,-76.910535|38.892912,-77.038088|38.791015,-77.119759|38.934343