National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 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 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: Payer Provider Network Query Location Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPn-ldapi-Location Version: 1.0.0
Standards status: Trial-use Computable Name: NdhPnLdApiLocation

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:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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 Content/Rules for all slices
.... 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 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)
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
.... Slices for extension Content/Rules for all slices
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 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
.... 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 Σ 0..1 Reference(Payer Provider Network Query 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 ?!Σ 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
... address S 0..1 Address Physical location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 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
.... 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
... 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 1..1 decimal Longitude with WGS84 datum
ele-1: All FHIR elements must have a @value or children
.... latitude 1..1 decimal Latitude with WGS84 datum
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf S 0..1 Reference(Payer Provider Network Query 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(Payer Provider Network Local 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
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.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.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
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