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
Profile/Capability | National Directory API | National Directory API Base Expanded | National Directory API Base |
CareTeam | SHALL | SHOULD | SHOULD |
Endpoint | SHALL | SHALL | SHALL |
HealthcareService | SHALL | SHALL | SHOULD |
InsurancePlan | SHALL | SHOULD | SHOULD |
Location | SHALL | SHALL | SHALL |
Network | SHALL | SHOULD | SHOULD |
Organization | SHALL | SHALL | SHALL |
OrganizationAffiliation | SHALL | SHALL | SHOULD |
Practitioner | SHALL | SHALL | SHALL |
PractitionerRole | SHALL | SHALL | SHALL |
Restriction | SHALL | SHALL | SHOULD |
Validation | SHALL | SHALL | SHOULD |
The primary focus of this implementation guide is a RESTful API for obtaining data from a FHIR-enabled API from a National Directory of Healthcare Providers & Services (NDH). This API supports a unidirectional flow of information from a FHIR-enabled National Directory to Local Directories and/or Applications. (e.g., supports GET but not PUT or POST)
The capability statement for NDH requires support of all of the associated resources defined for the NDH. However, to facilitate the use of the NDH IG by local environments that may act, in their sphere of influence as reference directories, this IG supports two less restrictive National Directory API capability statements: