National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

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 2.0.0-current 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

Plain Language Summary goes here

## Home

Official URL: http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh | Version: 2.0.0-current
IG Standards status: Trial-use | Maturity Level: 4 | Computable Name: NationalDirectoryHealthcare

### Introduction

The National Directory of Healthcare Providers & Services (NDH) Implementation Guide (IG) provides standards and guidance for a national directory infrastructure in the US. The IG envisions a national source of truth for information about providers, health organizations, and related services, their relationships, and technical connectivity details (i.e., electronic endpoints). Content maintained by the national directory would be made available to downstream local directories using FHIR APIs. Local directories could also use FHIR APIs to make content available to their users. FHIR APIs could also serve as an entry point to the national directory, i.e., providers and organizations contribute information to the national directory over a FHIR API. Finally, the national directory may leverage FHIR APIs to facilitate verification of directory content for accuracy.

The sections of this IG provide guidance and/or standards for each of these capabilities:

- Base artifacts - provides a variety of FHIR artifacts including profiles, extensions, search parameters, and terminologies that comprise a robust directory data model. These artifacts are generally loosely constrained; additional conformance expectations and constraints are provided in other sections of the IG.
- National Directory API artifacts - constrains the Base artifacts and defines multiple methods for exchanging national directory information with a local directory. Methods include a FHIR API, a scheduled exchange operation including subscriptions and bulk data export.

### Background

The National Directory of Healthcare Providers & Services (NDH) Implementation Guide has been developed from a series of foundational guides. It originated from the STU 1.0.0 ballot version of the National Healthcare Directory IGs, which included the Exchange, Query, and Attestation and Verification (IGs). These Directory IGs themselves were derived from both the Validated Healthcare Directory IG (International) and the PDex Plan Net IG (Payer Network) (US Realm). The PDex Plan Net IG, in turn, evolved from the Validated Healthcare Directory IG (International).

Initially, the National Directory Implementation Guide (IG) comprised three separate IGs. However, during the STU 1.0.0 ballot process, the community provided feedback advocating for the unification of these guides. This led to the creation of the NDH IG, a combined implementation guide. The NDH IG effectively integrates pertinent ballot ticket resolutions from the original three IGs where necessary, forming a more comprehensive and streamlined guide.

Healthcare directories play a critical role in enabling identification of individual providers and service organizations, as well as characteristics about them, their relationships, and the means by which to access and exchange patient information among them electronically. Healthcare directories support a variety of use cases, including:

- Electronic endpoint discovery
- Referrals and transitions of care
- Health plan enrollment
- Provider selection
- Service selection
- Provider credentialing/privileging

Today, many health and social care organizations maintain directories, including ones for providers, payers, health information exchange organizations (HIEs/HIOs), health information service providers (HISPs), social services organizations, government agencies, and credentialing organizations. However, despite their importance, health and social care directory activities remain scattered, uncoordinated, and are often not interoperable. As a result, the industry collectively spends significant time and resources registering and validating demographic information for individual and organizational providers for purposes such as information exchange, referrals, licensure, credentialing, certification, and payment.

Providers and service organizations often have to submit and manage information about themselves and their relationships to a variety of stakeholders. In the US healthcare sector, providers often contract with ten or more health plans, and are required to regularly submit similar information to each plan for inclusion in a given provider network and directory. Likewise, provider credentialing and hospital privileging processes require similar documentation. The Council for Affordable Quality Healthcare estimated that just maintaining provider databases costs the US healthcare industry at least $2 billion annually.

Due to the high cost of acquiring and maintaining provider, organization and service information, existing healthcare directories often contain information that is inaccurate, out of date, or not validated.

### FHIR At Scale Taskforce Effort

The purpose of the FHIR at Scale Taskforce (FAST) is to augment and support recent HL7® Fast Healthcare Interoperability Resources (FHIR®) efforts focused on ecosystem issues that, if mitigated, can accelerate adoption. A number of regulatory and technical barriers, as well as required core capabilities, have been identified related to Directory, Versioning, and Scale. This Implementation Guide includes the work from FAST with regard to a national endpoint directory. FAST Directory work is focused on defining the issues related to making electronic endpoints available . Since these endpoints are associated with providers, organizations, and services, prior work on Validated Healthcare Directory FHIR IG and DaVinci PDEX Plan Net was used as the foundation data model. The FHIR endpoint resource provides the structure on which this national directory effort can make endpoints discoverable in the context of the specific providers, organizations and services and their relationships.

For more information on the FAST Directory effort see the FAST Accelerator pages on Confluence.

### Overview

#### NDH Concept

### Dependencies

IG | Package | FHIR | Comment
--- | --- | --- | ---
National Directory of Healthcare Providers & Services (NDH) Implementation Guide | hl7.fhir.us.ndh#2.0.0-current | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#7.1.0 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology
US Core Implementation Guide | hl7.fhir.us.core#6.1.0 | R4 |
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.2.0 | R4 |
Subscriptions R5 Backport | hl7.fhir.uv.subscriptions-backport.r4#1.1.0 | R4 |
Mobile Care Services Discovery (mCSD) | ihe.iti.mcsd#4.0.0 | R4 |
Da Vinci PDex Plan Net | hl7.fhir.us.davinci-pdex-plan-net#1.2.0 | R4 |
Da Vinci Clinical Data Exchange (CDex) | hl7.fhir.us.davinci-cdex#2.1.0 | R4 |
FHIR Tooling Extensions IG | hl7.fhir.uv.tools.r4#1.1.2 | R4 | for example references

### Intellectual Property Considerations

This publication includes IP covered under the following statements.

- © Copyright 2022 American Medical Association
  Show Usage
  - NUCC Provider Taxonomy: Acme of CT, BlueCrossBlueShield CT Organization... Show 19 more, Hartford General Hospital, HealthcareService/BurrClinicServices, HealthcareService/HansSoloService, HealthcareService/HartfordOrthopedicServices, IndividualAndGroupSpecialtiesVS, NdhHealthcareService, NdhPractitionerRole, OrgOneWithNetwork1AndNetwork2, Organization Manage Payer Network (OMPN), OrganizationAffiliation/PharmChainAffil1, Pharmacy by PharmChain, Practitioner/HansSolo, Practitioner/JoeSmith, Practitioner/PractitionerOneWithNetwork1AndNetwork2, Practitioner/PractitionerTwoWithNetwork1LeftAfterSixMonths, PractitionerRole/HansSoloRole, PractitionerRole/HansSoloRole2, PractitionerRole/JoeSmithHospitalRole and PractitionerRole/JoeSmithRole2
- ISO maintains the copyright on the country codes, and controls its use carefully. For further details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  - ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: AcceptingPatientsVS, Accessibility... Show 151 more, AccessibilityVS, AgeGroupVS, AssociatedServers, BenefitTypeVS, CommunicationProficiency, ContactPointAvailableTime, DeliveryMethod, DynamicRegistration, EmploymentStatusVS, EndpointAccessControlMechanism, EndpointAccessControlMechanismSearchParameter, EndpointAccessControlMechanismVS, EndpointConnectionTypeVS, EndpointDynamicRegistrationTrustProfileSearchParameter, EndpointFhirMimeTypeVS, EndpointIheConnectionTypeSearchParameter, EndpointIheSpecificConnectionType, EndpointIheSpecificConnectionTypeVS, EndpointPayloadTypeVS, EndpointRank, EndpointReference, EndpointTestingCertification, EndpointTestingMethodVS, EndpointTrustFrameworkTypeSearchParameter, EndpointenvironmentType, FundingSource, HealthcareServiceCategoryVS, HealthcareServiceEligibilityCodeVS, HealthcareServiceEligibilitySearchParameter, HealthcareServiceLocationSearchParameter, HealthcareServiceNetworkSearchParameter, HealthcareServiceNewPatientAndFromNetworkSearchParameter, HealthcareServiceNewPatientFromNetworkSearchParameter, HealthcareServiceNewPatientSearchParameter, HealthcareServiceOrganizationSearchParameter, HealthcareServiceProgramRequirementAgeGroupSearchParameter, HealthcareServiceProgramRequirementBirthsexSearchParameter, HealthcareServiceProgramRequirementEmploymentStatusSearchParameter, HealthcareServiceProgramRequirementInsuranceStatusSearchParameter, HealthcareServiceProgramRequirementPreferredLanguageSearchParameter, HealthcareServiceProgramRequirementVaStatusSearchParameter, HealthcareServiceSocialServiceAgeGroupSearchParameter, HealthcareServiceSocialServiceBirthsexSearchParameter, HealthcareServiceSocialServiceEmploymentStatusSearchParameter, HealthcareServiceSocialServiceInsuranceStatusSearchParameter, HealthcareServiceSocialServicePreferredLanguageSearchParameter, HealthcareServiceSocialServiceVaStatusSearchParameter, HealthcareServiceTypeVS, IdentifierStatus, IdentifierStatusVS, ImplementationGuideSupported, IndividualAndGroupSpecialtiesVS, IndividualSpecialtyAndDegreeLicenseCertificateVS, InsuranceBenefitType, InsuranceCoverageAreaSearchParameter, InsurancePlanReference, InsuranceStatusVS, InsuranceplanCoverageBenefitTypeSearchParameter, InsuranceplanCoverageNetworkSearchParameter, InsuranceplanCoverageTypeSearchParameter, InsuranceplanPlanNetworkSearchParameter, InsuranceplanPlanTypeSearchParameter, LanguageSpeak, LocationAccessibilitySearchParameter, LocationContainsSearchParameter, LocationReference, Logo, NationalDirectoryHealthcare, NdhAgeGroup, NdhAgeGroupCS, NdhAgeRange, NdhAssociatedServersTypeCS, NdhAssociatedServersTypeVS, NdhCapabilityStatement, NdhDirectTrustEndpointUsecaseCS, NdhEndpoint, NdhEndpointAccessControlMechanismCS, NdhEndpointConnectionTypeCS, NdhEndpointEnvironmentCS, NdhEndpointEnvironmentVS, NdhEndpointTestingMethodCS, NdhFhirEndpointUseCaseCS, NdhGroup, NdhHealthcareService, NdhImplementationGuideVS, NdhInsurancePlan, NdhInsuranceStatusCS, NdhLocation, NdhNetwork, NdhOrgTypeCS, NdhOrganization, NdhOrganizationAffiliation, NdhPractitioner, NdhPractitionerRole, NdhPractitionerRoleCS, NdhSchExport, NdhSecureExchangeArtifactsCS, NdhSecureExchangeArtifactsVS, NdhTrustFrameworkTypeCS, NdhTrustProfileCS, NdhVerification, NdhVerificationStatusCS, NdhVerificationStatusVS, NetworkCoverageAreaSearchParameter, NetworkReference, NetworkTypeVS, NewPatients, NewPatientsCharacteristics, OrgAliasPeriod, OrgAliasType, OrgAliasTypeVS, OrgDescription, OrgTypeVS, OrganizationAffiliationLocationSearchParameter, OrganizationAffiliationParticipatingOrganizationSearchParameter, OrganizationAffiliationPrimaryOrganizationSearchParameter, OrganizationAffiliationRoleVS, OrganizationAffiliationViaIntermediarySearchParameter, PaymentAccepted, PractitionerEndpointSearchParameter, PractitionerQualification, PractitionerQualificationCodeSearchParameter, PractitionerQualificationIssuerSearchParameter, PractitionerRoleVS, PractitionerroleLocationSearchParameter, PractitionerroleNetworkSearchParameter, PractitionerroleNewPatientFromNetworkSearchParameter, PractitionerroleNewPatientSearchParameter, PractitionerroleOrganizationSearchParameter, Qualification, QualificationStatusVS, Rating, RatingDetails, RequiredDocument, SecureExchangeArtifacts, ServiceOrProgramRequirement, SpecialtyAndDegreeLicenseCertificateVS, TrustFramework, TrustFrameworkTypeVS, TrustProfileVS, VerificationProcessVS, VerificationResultAttestationWhoSearchParameter, VerificationResultPrimarysourceTypeSearchParameter, VerificationResultPrimarysourceValidationStatusSearchParameter, VerificationResultPrimarysourceWhoSearchParameter, VerificationResultStatusSearchParameter, VerificationResultTargetSearchParameter, VerificationStatus, VerificationStatusSearchParameter, ViaIntermediary and VirtualModalitiesVS
- The ILR Speaking Skill codes are in the public domain and are free to use without restriction.
  Show Usage
  - Interagency Language Roundtable Speaking Skill Scale: CommunicationProficiency and Practitioner/HansSolo
- The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  - Unified Code for Units of Measure (UCUM): HOPE INC
- This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  - SNOMED Clinical Terms&reg; (SNOMED CT&reg;): NdhOrganizationAffiliation
- This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  - Accepting Patients: AcceptingPatientsVS, Bundle/location-bundle... Show 13 more, HOPE INC, Hartford Hospital Location 1, HealthcareService/HartfordOrthopedicServices, LocationGen1, LocationGen2, NewPatients, OrgA CT Location 1, OrgA CT Location 2, OrgA MA Location 1, OrgA MA Location 2, Pharmacy by PharmChain, Towson Food INC and Welcome Home
  - Care Service Accessibility: Accessibility, AccessibilityVS... Show 7 more, Bundle/location-bundle, Hartford Hospital Location 1, Hartford Hospital Location 2, OrgA CT Location 1, OrgA CT Location 2, OrgA MA Location 1 and OrgA MA Location 2
  - Contact entity type: Hope INC
  - DataAbsentReason: Endpoint for Acme of CT Portal, Endpoint for Coordination of Care... Show 6 more, Endpoint for DirectTrust, Endpoint for IHE, EndpointPayloadTypeVS, Hans Solo Endpoint for DirectTrust, Hans Solo Endpoint for Patient Access and NdhEndpoint
  - Endpoint Connection Type: Endpoint for Coordination of Care, Endpoint for DirectTrust... Show 4 more, EndpointConnectionTypeVS, Hans Solo Endpoint for DirectTrust, Hans Solo Endpoint for Patient Access and NdhEndpoint
  - Failure-action: VerificationResult/Example-license, VerificationResult/Verify-Hospital... Show 4 more, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith, VerificationResult/Verify-JoeSmith-2 and VerificationResult/Verify-JoeSmithHospitalRole
  - Insurance Coverage Type: NdhInsurancePlan
  - Insurance Product Type: Acme of CT QHP Bronze, Acme of CT QHP Gold, Blue Cross Blue Shied CT Insurance, Medicare Advantage Plan and NdhInsurancePlan
  - Insuranceplan Plan Type: Acme of CT QHP Bronze, Acme of CT QHP Gold and NdhInsurancePlan
  - NDH Healthcare Service Category: Behavioral Health Group, HOPE INC... Show 9 more, HealthcareService/BurrClinicServices, HealthcareService/HansSoloService, HealthcareService/HartfordOrthopedicServices, HealthcareServiceCategoryVS, NdhGroup, NdhHealthcareService, Pharmacy by PharmChain, Towson Food INC and Welcome Home
  - Need: VerificationResult/Example-license, VerificationResult/Verify-Hospital... Show 4 more, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith, VerificationResult/Verify-JoeSmith-2 and VerificationResult/Verify-JoeSmithHospitalRole
  - Organization Affiliation Role: NdhOrganizationAffiliation, OrganizationAffiliation/BurrClinicAffil... Show 4 more, OrganizationAffiliation/OrgOneNetwork1Affiliation, OrganizationAffiliation/OrgOneNetwork2Affiliation, OrganizationAffiliation/PharmChainAffil1 and OrganizationAffiliationRoleVS
  - Organization Affiliation Role for HIE: NdhOrganizationAffiliation and OrganizationAffiliationRoleVS
  - Organization Alias Type: Acme of CT, OrgAliasType and OrgAliasTypeVS
  - Organization type: ACME CT Preferred Provider Network, ACME CT Premium Preferred Provider Network... Show 18 more, Acme of CT, Big Box Retailer, BlueCrossBlueShield CT Organization, BlueCrossBlueShield CT PPO, Housing Assistance Hub Management, NdhNetwork, NdhOrganization, Network1, Network2, NetworkGen1, NetworkGen2, NetworkTypeVS, OrgTypeVS, Organization Manage Payer Network (OMPN), Social Service Housing Hub, State of Illinois Licensing Board, StateMedicaidAgencyAlabama and Welcome Home
  - Primary-source-type: NdhVerification, VerificationResult/Verify-Hospital, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith and VerificationResult/Verify-JoeSmith-2
  - Professional Credential Status: IdentifierStatus, IdentifierStatusVS, PractitionerQualification, Qualification and QualificationStatusVS
  - Program: NdhHealthcareService
  - Service Delivery Method: DeliveryMethod, HOPE INC... Show 6 more, HealthcareService/BurrClinicServices, HealthcareService/HansSoloService, HealthcareService/HartfordOrthopedicServices, Pharmacy by PharmChain, Towson Food INC and Welcome Home
  - ServiceProvisionConditions: NdhHealthcareService
  - Service type: HealthcareServiceTypeVS, NdhHealthcareService, Towson Food INC and Welcome Home
  - employmentStatus: EmploymentStatusVS, ServiceOrProgramRequirement and Welcome Home
  - bedStatus: NdhLocation
  - identifierType: NdhNetwork
  - degreeLicenseCertificate: IndividualSpecialtyAndDegreeLicenseCertificateVS, NdhPractitioner... Show 4 more, Practitioner/HansSolo, Practitioner/JoeSmith, Practitioner/PractitionerOneWithNetwork1AndNetwork2 and Practitioner/PractitionerTwoWithNetwork1LeftAfterSixMonths
  - paymentMethod: HealthcareService/HartfordOrthopedicServices and PaymentAccepted
  - RoleCode: Bundle/location-bundle, HOPE FOOD DISPENSARY OF GREATER BALTIMORE... Show 9 more, Hartford Hospital Location 1, Hartford Hospital Location 2, NdhLocation, OrgA CT Location 1, OrgA CT Location 2, OrgA MA Location 1, OrgA MA Location 2, TOWSON FOOD DISPENSARY OF GREATER BALTIMORE COUNTY and Welcome Home
  - Validation-process: NdhVerification, VerificationProcessVS... Show 6 more, VerificationResult/Example-license, VerificationResult/Verify-Hospital, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith, VerificationResult/Verify-JoeSmith-2 and VerificationResult/Verify-JoeSmithHospitalRole
  - Validation-status: VerificationResult/Verify-Hospital, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith and VerificationResult/Verify-JoeSmith-2
  - Validation-type: NdhVerification, VerificationResult/Example-license... Show 5 more, VerificationResult/Verify-Hospital, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith, VerificationResult/Verify-JoeSmith-2 and VerificationResult/Verify-JoeSmithHospitalRole
  - VerificationResult Communication Method: NdhVerification, VerificationResult/Example-license... Show 5 more, VerificationResult/Verify-Hospital, VerificationResult/Verify-Hospital-2, VerificationResult/Verify-JoeSmith, VerificationResult/Verify-JoeSmith-2 and VerificationResult/Verify-JoeSmithHospitalRole
  - Virtual Healthcare Delivery Method: DeliveryMethod, HealthcareService/HartfordOrthopedicServices and VirtualModalitiesVS