National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0 - draft 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 2.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

Table of Contents

Page standards status: Informative
.. 0 Table of Contents
... 1 Home
... 2 Directory Artifacts
... 3 National Directory API Use Cases
... 4 Guidance
... 5 Conformance
... 6 Resource Relationships
... 7 Attestation and Verification Guidance
... 8 National Directory API Implementation Guidance
... 9 National Directory API Examples
... 10 NDH CapabilityStatement
... 11 Attestation Use Cases
... 12 Attestation Flow Diagrams
... 13 Attestation Implementation Guidance
... 14 Validation & Verification Use Cases
... 15 Validation & Verification Flow Diagrams
... 16 Validation & Verification Implementation Guidance
... 17 Local Directory API Use Cases
... 18 Local Directory API Implementation Guidance
... 19 Local Directory API Examples
... 20 Download Specification
... 21 other
... 22 Change Log
... 23 Artifacts Summary
.... 23.1 NDH Server Capability Statement
.... 23.2 Scheduled NDH Export Operation
.... 23.3 Endpoint access-control-mechanism
.... 23.4 Endpoint connection-type-version
.... 23.5 Endpoint dynamic-registration-trust-profile
.... 23.6 Endpoint ihe-connection-type
.... 23.7 Endpoint trust-framework-type
.... 23.8 Endpoint usecase-type
.... 23.9 Endpoint verification-status
.... 23.10 HealthcareService eligibility
.... 23.11 HealthcareService location
.... 23.12 HealthcareService network
.... 23.13 HealthcareService new patient
.... 23.14 HealthcareService new patient from network
.... 23.15 Healthcareservice new-patient-and-from-network
.... 23.16 HealthcareService organization
.... 23.17 HealthcareService program requirement age group
.... 23.18 HealthcareService program requirement birthsex
.... 23.19 HealthcareService program requirement employment status
.... 23.20 HealthcareService program requirement insurance status
.... 23.21 HealthcareService program requirement preferred language
.... 23.22 HealthcareService program requirement va status
.... 23.23 HealthcareService social service requirement age group
.... 23.24 HealthcareService social service requirement birthsex
.... 23.25 HealthcareService social service requirement employment status
.... 23.26 HealthcareService social service requirement insurance status
.... 23.27 HealthcareService social service requirement preferred language
.... 23.28 HealthcareService social service requirement va status
.... 23.29 HealthcareService verification status
.... 23.30 InsurancePlan coverage-area
.... 23.31 InsurancePlan coverage-benefit-type
.... 23.32 InsurancePlan coverage-network
.... 23.33 InsurancePlan coverage-type
.... 23.34 InsurancePlan network
.... 23.35 InsurancePlan plan-network
.... 23.36 InsurancePlan plan-type
.... 23.37 InsurancePlan verification-status
.... 23.38 Location accessibility
.... 23.39 Location contains
.... 23.40 Location new-patient
.... 23.41 Location new-patient-and-from-network
.... 23.42 Location new-patient-from-network
.... 23.43 Location verification-status
.... 23.44 Network coverage-area
.... 23.45 Organization or Network verification-status
.... 23.46 OrganizationAffiliation location
.... 23.47 OrganizationAffiliation participating organization
.... 23.48 OrganizationAffiliation primary organization
.... 23.49 OrganizationAffiliation verification-status
.... 23.50 OrganizationAffiliation via-intermediary
.... 23.51 Practitioner endpoint
.... 23.52 Practitioner qualification-code
.... 23.53 Practitioner qualification-issuer
.... 23.54 Practitioner verification-status
.... 23.55 PractitionerRole location
.... 23.56 PractitionerRole network
.... 23.57 PractitionerRole new-patient
.... 23.58 Practitionerrole new-patient-and-from-network
.... 23.59 PractitionerRole new-patient-from-network
.... 23.60 PractitionerRole organization
.... 23.61 PractitionerRole verification-status
.... 23.62 VerificationResult attestation-communication-method
.... 23.63 VerificationResult attestation-onbehalfof
.... 23.64 VerificationResult attestation-who
.... 23.65 VerificationResult primarysource-type
.... 23.66 VerificationResult primarysource-validation-date
.... 23.67 VerificationResult primarysource-validation-status
.... 23.68 VerificationResult primarysource-who
.... 23.69 VerificationResult status
.... 23.70 VerificationResult status-date
.... 23.71 VerificationResult target
.... 23.72 VerificationResult validator-organization
.... 23.73 NDH Endpoint Profile
.... 23.74 NDH HealthcareService Profile
.... 23.75 NDH InsurancePlan Profile
.... 23.76 NDH Location Profile
.... 23.77 NDH Network Profile
.... 23.78 NDH Organization Profile
.... 23.79 NDH OrganizationAffiliation Profile
.... 23.80 NDH Practitioner Profile
.... 23.81 NDH PractitionerRole
.... 23.82 NDH Verification
.... 23.83 NDH Accessibility
.... 23.84 NDH Age Group
.... 23.85 NDH Age Range
.... 23.86 NDH Associated Servers
.... 23.87 NDH Communication Proficiency
.... 23.88 NDH Contactpoint Availabletime
.... 23.89 NDH Delivery Method
.... 23.90 NDH Digitalcertificate
.... 23.91 NDH Dynamic Registration
.... 23.92 NDH Endpoint Access Control Mechanism
.... 23.93 NDH Endpoint Connection Type Version
.... 23.94 NDH Endpoint EnvironmentType
.... 23.95 NDH Endpoint IHE Specific Connection Type
.... 23.96 NDH Endpoint Rank
.... 23.97 NDH Endpoint Reference
.... 23.98 NDH Endpoint Testing Certification
.... 23.99 NDH Endpoint Usecase
.... 23.100 NDH FHIR IG
.... 23.101 NDH Funding Source
.... 23.102 NDH HealthcareService or Program Requirement
.... 23.103 NDH Healthcareservice Reference
.... 23.104 NDH Identifier Status
.... 23.105 NDH InsurancePlan Reference
.... 23.106 NDH Language Speak
.... 23.107 NDH Location Reference
.... 23.108 NDH Logo
.... 23.109 NDH Network Reference
.... 23.110 NDH New Patients
.... 23.111 NDH New Patients Characteristics
.... 23.112 NDH Org Description
.... 23.113 NDH Organization Alias Period
.... 23.114 NDH Organization Alias Type
.... 23.115 NDH Payment Accepted
.... 23.116 NDH Practitioner Qualification
.... 23.117 NDH Qualification
.... 23.118 NDH Rating
.... 23.119 NDH Rating Details
.... 23.120 NDH Required Document
.... 23.121 NDH Secure Exchange Artifacts
.... 23.122 NDH Trust Framework
.... 23.123 NDH Verification Status
.... 23.124 NDH Via Intermediary
.... 23.125 Accepting Patients Codes Value Set
.... 23.126 Accessibility Value Set
.... 23.127 Age Range Value Set
.... 23.128 Associated Servers Type Value Set
.... 23.129 Benefit Type Value Set
.... 23.130 Digital Certificate Use Value Set
.... 23.131 Employment Status Value Set
.... 23.132 Endpoint Access Control Mechanism Value Set
.... 23.133 Endpoint Connection Types Value Set
.... 23.134 Endpoint FHIR Mimetype Value Set
.... 23.135 Endpoint IHE Specific Connection Types Value Set
.... 23.136 Endpoint Payload Type Value Set
.... 23.137 Endpoint Testing Method Value Set
.... 23.138 Healthcare Service Category Value Set
.... 23.139 Healthcare Service Eligibility Code Value Set
.... 23.140 HealthcareService Type Value Set
.... 23.141 Identifier Status Value Set
.... 23.142 Individual and Group Specialties
.... 23.143 Individual Specialties, Degrees, Licenses, and Certificates Value Set
.... 23.144 Insurance Status Value Set
.... 23.145 NDH Care Team Category Value Set
.... 23.146 NDH Direct Trust Endpoint Usecase Value Set
.... 23.147 NDH Direct Trust Payload Type Value Set
.... 23.148 NDH Endpoint Environment Value Set
.... 23.149 NDH FHIR Endpoint Usecase Value Set
.... 23.150 NDH Verification Process Value Set
.... 23.151 NDH Verification Status Value Set
.... 23.152 Network Type Value Set
.... 23.153 Organization Alias Type Value Sete
.... 23.154 Organization Type Value Set
.... 23.155 OrganizationAffiliation Roles
.... 23.156 PractitionerRole Code Value Set
.... 23.157 Qualification Status Value Set
.... 23.158 Secure Exchange Artifacts Value Set
.... 23.159 Specialties, Degrees, Licenses, and Certificates Value Set
.... 23.160 Trust Framework Type Value Set
.... 23.161 Trust Profile Value Set
.... 23.162 Virtual Modalities Value Set
.... 23.163 Endpoint Access Control Mechanism Code System
.... 23.164 Endpoint Connection Types (additional) Code System
.... 23.165 Insurance Benefit Type Code System
.... 23.166 NDH Age Range Code System
.... 23.167 NDH Associated Servers Type Code System
.... 23.168 NDH Digitalcertificate Use Code System
.... 23.169 NDH Direct Trust Endpoint Usecase Code System
.... 23.170 NDH Direct Trust Payload Type Code System
.... 23.171 NDH Endpoint Environment Code System
.... 23.172 Ndh Endpoint Testing Method Code System
.... 23.173 NDH FHIR Endpoint Use Case Code System
.... 23.174 NDH Insurance Status Code System
.... 23.175 Ndh Organization Type Code System
.... 23.176 NDH Practitioner Role Codes Code System
.... 23.177 NDH Resource Instance Verification Status Code System
.... 23.178 NDH Secure Exchange Artifacts Code System
.... 23.179 NDH Trust FrameworkType Code System
.... 23.180 NDH Trust Profile Code System
.... 23.181 Acme
.... 23.182 AcmeOfCTPortalEndpoint
.... 23.183 AcmeofCTPremNet
.... 23.184 AcmeofCTStdNet
.... 23.185 AcmeQHPBronze
.... 23.186 AcmeQHPGold
.... 23.187 Backport Subscription for Practitioner Qualification Change
.... 23.188 BigBox
.... 23.189 BlueCrossBlueShield-CT
.... 23.190 BlueCrossBlueShield-CT-ORG
.... 23.191 BlueCrossBlueShield-CT-PPO
.... 23.192 BurrClinic
.... 23.193 BurrClinicAffil
.... 23.194 BurrClinicServices
.... 23.195 CoordinationOfCareEndpoint
.... 23.196 DirectTrustEndpointAdtNotifications
.... 23.197 DirectTrustEndpointReferrals
.... 23.198 Example-license
.... 23.199 HamiltonClinic
.... 23.200 HansSolo
.... 23.201 HansSoloClinic
.... 23.202 HansSoloDirectTrustEndpointReferrals
.... 23.203 HansSoloPatientAccessEndpoint
.... 23.204 HansSoloRole
.... 23.205 HansSoloRole2
.... 23.206 HansSoloService
.... 23.207 HartfordOrthopedics
.... 23.208 HartfordOrthopedicServices
.... 23.209 HealthcareService-Social-Hope-CBO
.... 23.210 HealthcareService-Social-Towson-Food
.... 23.211 HealthcareServiceHomelessAssistance
.... 23.212 Hospital
.... 23.213 HospLoc1
.... 23.214 HospLoc2
.... 23.215 IheEndpoint
.... 23.216 JoeSmith
.... 23.217 JoeSmithHospitalRole
.... 23.218 JoeSmithRole2
.... 23.219 location-bundle
.... 23.220 Location-Social-Hope-CBO
.... 23.221 Location-Social-Towson-Food
.... 23.222 LocationGen1
.... 23.223 LocationGen2
.... 23.224 LocationWelcomeHome
.... 23.225 MedicareAdvantage
.... 23.226 MedicareAdvantageHMO
.... 23.227 Network1
.... 23.228 Network2
.... 23.229 NetworkGen1
.... 23.230 NetworkGen2
.... 23.231 Organization-Social-Hope-CBO
.... 23.232 Organization-Social-Towson-Food
.... 23.233 OrganizationGen1
.... 23.234 OrganizationGen2
.... 23.235 OrganizationStateMedicaidAgencyAlabama
.... 23.236 OrganizationWelcomeHome
.... 23.237 OrgHousingAssistanceHubManagement
.... 23.238 OrgManageNetwork
.... 23.239 OrgOneNetwork1Affiliation
.... 23.240 OrgOneNetwork2Affiliation
.... 23.241 OrgOneWithNetwork1AndNetwork2
.... 23.242 Parameters - US SNOMED
.... 23.243 PharmChain
.... 23.244 PharmChainAffil1
.... 23.245 PharmChainRetailService
.... 23.246 PharmLoc1
.... 23.247 PharmLoc2
.... 23.248 PharmLoc3
.... 23.249 PharmLoc4
.... 23.250 PractitionerOneNetwork1Role
.... 23.251 PractitionerOneNetwork2Role
.... 23.252 PractitionerOneWithNetwork1AndNetwork2
.... 23.253 PractitionerTwoNetwork1LeftAfterSixMonthRole
.... 23.254 PractitionerTwoWithNetwork1LeftAfterSixMonths
.... 23.255 SocialServiceHousingNetwork
.... 23.256 StateOfCTLocation
.... 23.257 StateOfIllinoisLicBoard
.... 23.258 Verify-Hospital
.... 23.259 Verify-Hospital-2
.... 23.260 Verify-JoeSmith
.... 23.261 Verify-JoeSmith-2
.... 23.262 Verify-JoeSmithHospitalRole