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 Artifacts
... 10 National Directory API Capability Satement
... 11 National Directory API Examples
... 12 Attestation Use Cases
... 13 Attestation Flow Diagrams
... 14 Attestation Implementation Guidance
... 15 Attestation Artifacts
... 16 Validation & Verification Use Cases
... 17 Validation & Verification Flow Diagrams
... 18 Validation & Verification Implementation Guidance
... 19 Validation & Verification Artifacts
... 20 Local Directory API Use Cases
... 21 Local Directory API Implementation Guidance
... 22 Local Directory API Artifacts
... 23 Local Directory API Examples
... 24 Download Specification
... 25 other
... 26 Change Log
... 27 Artifacts Summary
.... 27.1 National Directory API Base Expanded Server Capability Statement
.... 27.2 National Directory API Base Server Capability Statement
.... 27.3 National Directory API Capability Statement
.... 27.4 Scheduled NDH Export Operation
.... 27.5 CareTeam endpoint
.... 27.6 CareTeam location
.... 27.7 CareTeam Name
.... 27.8 CareTeam organization
.... 27.9 CareTeam service
.... 27.10 CareTeam verification-status
.... 27.11 Endpoint access-control-mechanism
.... 27.12 Endpoint connection-type-version
.... 27.13 Endpoint dynamic-registration-trust-profile
.... 27.14 Endpoint ihe-connection-type
.... 27.15 Endpoint trust-framework-type
.... 27.16 Endpoint verification-status
.... 27.17 HealthcareService eligibility
.... 27.18 HealthcareService location
.... 27.19 HealthcareService network
.... 27.20 HealthcareService new patient
.... 27.21 HealthcareService new patient from network
.... 27.22 Healthcareservice new-patient-and-from-network
.... 27.23 HealthcareService organization
.... 27.24 HealthcareService program requirement age group
.... 27.25 HealthcareService program requirement birthsex
.... 27.26 HealthcareService program requirement employment status
.... 27.27 HealthcareService program requirement insurance status
.... 27.28 HealthcareService program requirement preferred language
.... 27.29 HealthcareService program requirement va status
.... 27.30 HealthcareService social service requirement age group
.... 27.31 HealthcareService social service requirement birthsex
.... 27.32 HealthcareService social service requirement employment status
.... 27.33 HealthcareService social service requirement insurance status
.... 27.34 HealthcareService social service requirement preferred language
.... 27.35 HealthcareService social service requirement va status
.... 27.36 HealthcareService verification status
.... 27.37 InsurancePlan coverage-area
.... 27.38 InsurancePlan coverage-benefit-type
.... 27.39 InsurancePlan coverage-network
.... 27.40 InsurancePlan coverage-type
.... 27.41 InsurancePlan network
.... 27.42 InsurancePlan plan-network
.... 27.43 InsurancePlan plan-type
.... 27.44 InsurancePlan verification-status
.... 27.45 Location accessibility
.... 27.46 Location contains
.... 27.47 Location new-patient
.... 27.48 Location new-patient-and-from-network
.... 27.49 Location new-patient-from-network
.... 27.50 Location verification-status
.... 27.51 Network coverage-area
.... 27.52 Organization or Network verification-status
.... 27.53 OrganizationAffiliation location
.... 27.54 OrganizationAffiliation participating organization
.... 27.55 OrganizationAffiliation primary organization
.... 27.56 OrganizationAffiliation verification-status
.... 27.57 OrganizationAffiliation via-intermediary
.... 27.58 Practitioner endpoint
.... 27.59 Practitioner qualification-code
.... 27.60 Practitioner qualification-issuer
.... 27.61 Practitioner verification-status
.... 27.62 PractitionerRole location
.... 27.63 PractitionerRole network
.... 27.64 PractitionerRole new-patient
.... 27.65 Practitionerrole new-patient-and-from-network
.... 27.66 PractitionerRole new-patient-from-network
.... 27.67 PractitionerRole organization
.... 27.68 PractitionerRole verification-status
.... 27.69 VerificationResult attestation-communication-method
.... 27.70 VerificationResult attestation-onbehalfof
.... 27.71 VerificationResult attestation-who
.... 27.72 VerificationResult primarysource-type
.... 27.73 VerificationResult primarysource-validation-date
.... 27.74 VerificationResult primarysource-validation-status
.... 27.75 VerificationResult primarysource-who
.... 27.76 VerificationResult status
.... 27.77 VerificationResult status-date
.... 27.78 VerificationResult target
.... 27.79 VerificationResult validator-organization
.... 27.80 National Directory API CareTeam Profile
.... 27.81 National Directory API Endpoint Profile
.... 27.82 National Directory API HealthcareService Profile
.... 27.83 National Directory API InsurancePlan Profile
.... 27.84 National Directory API Location Profile
.... 27.85 National Directory API Network Profile
.... 27.86 National Directory API Organization Profile
.... 27.87 National Directory API OrganizationAffiliation Profile
.... 27.88 National Directory API Practitioner Profile
.... 27.89 National Directory API PractitionerRole
.... 27.90 NDH CareTeam Profile
.... 27.91 NDH Endpoint Profile
.... 27.92 NDH HealthcareService Profile
.... 27.93 NDH InsurancePlan Profile
.... 27.94 NDH Location Profile
.... 27.95 NDH Network Profile
.... 27.96 NDH Organization Profile
.... 27.97 NDH OrganizationAffiliation Profile
.... 27.98 NDH Practitioner Profile
.... 27.99 NDH PractitionerRole
.... 27.100 NDH Restriction
.... 27.101 NDH Verification
.... 27.102 NDH Accessibility
.... 27.103 NDH Age Group
.... 27.104 NDH Age Range
.... 27.105 NDH Associated Servers
.... 27.106 NDH Communication Proficiency
.... 27.107 NDH Contactpoint Availabletime
.... 27.108 NDH Delivery Method
.... 27.109 NDH Digitalcertificate
.... 27.110 NDH Dynamic Registration
.... 27.111 NDH Endpoint Access Control Mechanism
.... 27.112 NDH Endpoint Connection Type Version
.... 27.113 NDH Endpoint EnvironmentType
.... 27.114 NDH Endpoint IHE Specific Connection Type
.... 27.115 NDH Endpoint Rank
.... 27.116 NDH Endpoint Reference
.... 27.117 NDH Endpoint Testing Certification
.... 27.118 NDH FHIR IG
.... 27.119 NDH Funding Source
.... 27.120 NDH HealthcareService or Program Requirement
.... 27.121 NDH Healthcareservice Reference
.... 27.122 NDH Identifier Status
.... 27.123 NDH InsurancePlan Reference
.... 27.124 NDH Language Speak
.... 27.125 NDH Location Reference
.... 27.126 NDH Logo
.... 27.127 NDH Network Reference
.... 27.128 NDH New Patients
.... 27.129 NDH New Patients Characteristics
.... 27.130 NDH Org Description
.... 27.131 NDH Organization Alias Period
.... 27.132 NDH Organization Alias Type
.... 27.133 NDH Payment Accepted
.... 27.134 NDH Practitioner Qualification
.... 27.135 NDH Qualification
.... 27.136 NDH Rating
.... 27.137 NDH Rating Details
.... 27.138 NDH Required Document
.... 27.139 NDH Secure Exchange Artifacts
.... 27.140 NDH Trust Framework
.... 27.141 NDH Usage Restriction
.... 27.142 NDH usage restriction fhir path
.... 27.143 NDH Verification Status
.... 27.144 NDH Via Intermediary
.... 27.145 Accepting Patients Codes Value Set
.... 27.146 Accessibility Value Set
.... 27.147 Age Range Value Set
.... 27.148 Associated Servers Type Value Set
.... 27.149 Benefit Type Value Set
.... 27.150 Consent Policy Rules Value Set
.... 27.151 Digital Certificate Use Value Set
.... 27.152 Employment Status Value Set
.... 27.153 Endpoint Access Control Mechanism Value Set
.... 27.154 Endpoint common mimetype Value Set
.... 27.155 Endpoint Connection Types Value Set
.... 27.156 Endpoint FHIR Mimetype Value Set
.... 27.157 Endpoint IHE Specific Connection Types Value Set
.... 27.158 Endpoint Payload Type Value Set
.... 27.159 Endpoint Testing Method Value Set
.... 27.160 Healthcare Service Category Value Set
.... 27.161 Healthcare Service Eligibility Code Value Set
.... 27.162 HealthcareService Type Value Set
.... 27.163 Identifier Status Value Set
.... 27.164 IG Actor Value Set
.... 27.165 Individual and Group Specialties
.... 27.166 Individual Specialties, Degrees, Licenses, and Certificates Value Set
.... 27.167 Insurance Status Value Set
.... 27.168 NDH Care Team Category Value Set
.... 27.169 NDH Consent Category Value Set
.... 27.170 NDH Consent Scope Value Set
.... 27.171 NDH Direct Trust Endpoint Usecase Value Set
.... 27.172 NDH Direct Trust Payload Type Value Set
.... 27.173 NDH Endpoint Environment Value Set
.... 27.174 NDH FHIR Endpoint Usecase Value Set
.... 27.175 NDH Verification Process Value Set
.... 27.176 NDH Verification Status Value Set
.... 27.177 Network Type Value Set
.... 27.178 Non-Individual Specialties
.... 27.179 Organization Alias Type Value Sete
.... 27.180 Organization Type Value Set
.... 27.181 OrganizationAffiliation Roles
.... 27.182 PractitionerRole Code Value Set
.... 27.183 Qualification Status Value Set
.... 27.184 Secure Exchange Artifacts Value Set
.... 27.185 Specialties Value Set
.... 27.186 Specialties, Degrees, Licenses, and Certificates Value Set
.... 27.187 Trust Framework Type Value Set
.... 27.188 Trust Profile Value Set
.... 27.189 Virtual Modalities Value Set
.... 27.190 Endpoint Access Control Mechanism Code System
.... 27.191 Endpoint Connection Types (additional) Code System
.... 27.192 Insurance Benefit Type Code System
.... 27.193 National Healthcare Directory Consent Category Code System
.... 27.194 National Healthcare Directory ConsentPolicyRules Code System
.... 27.195 NDH Age Range Code System
.... 27.196 NDH Associated Servers Type Code System
.... 27.197 NDH ConsentScopeCodes Code System
.... 27.198 NDH Digitalcertificate Use Code System
.... 27.199 NDH Direct Trust Endpoint Usecase Code System
.... 27.200 NDH Direct Trust Payload Type Code System
.... 27.201 NDH Endpoint Environment Code System
.... 27.202 Ndh Endpoint Testing Method Code System
.... 27.203 NDH FHIR Endpoint Use Case Code System
.... 27.204 NDH IG Actor Code System
.... 27.205 NDH Insurance Status Code System
.... 27.206 Ndh Organization Type Code System
.... 27.207 NDH Practitioner Role Codes Code System
.... 27.208 NDH Resource Instance Verification Status Code System
.... 27.209 NDH Secure Exchange Artifacts Code System
.... 27.210 NDH Trust FrameworkType Code System
.... 27.211 NDH Trust Profile Code System
.... 27.212 Acme
.... 27.213 AcmeOfCTPortalEndpoint
.... 27.214 AcmeofCTPremNet
.... 27.215 AcmeofCTStdNet
.... 27.216 AcmeQHPBronze
.... 27.217 AcmeQHPGold
.... 27.218 Backport Subscription for Practitioner Qualification Change
.... 27.219 BigBox
.... 27.220 BlueCrossBlueShield-CT
.... 27.221 BlueCrossBlueShield-CT-ORG
.... 27.222 BlueCrossBlueShield-CT-PPO
.... 27.223 BurrClinic
.... 27.224 BurrClinicAffil
.... 27.225 BurrClinicServices
.... 27.226 CareTeam1
.... 27.227 CareTeam2
.... 27.228 CoordinationOfCareEndpoint
.... 27.229 DirectTrustEndpointAdtNotifications
.... 27.230 DirectTrustEndpointReferrals
.... 27.231 Example-license
.... 27.232 HamiltonClinic
.... 27.233 HansSolo
.... 27.234 HansSoloClinic
.... 27.235 HansSoloDirectTrustEndpointReferrals
.... 27.236 HansSoloPatientAccessEndpoint
.... 27.237 HansSoloRole
.... 27.238 HansSoloRole2
.... 27.239 HansSoloService
.... 27.240 HartfordOrthopedics
.... 27.241 HartfordOrthopedicServices
.... 27.242 HealthcareService-Social-Hope-CBO
.... 27.243 HealthcareService-Social-Towson-Food
.... 27.244 HealthcareServiceHomelessAssistance
.... 27.245 Hospital
.... 27.246 HospLoc1
.... 27.247 HospLoc2
.... 27.248 IheEndpoint
.... 27.249 JoeSmith
.... 27.250 JoeSmithHospitalRole
.... 27.251 JoeSmithRole2
.... 27.252 location-bundle
.... 27.253 Location-Social-Hope-CBO
.... 27.254 Location-Social-Towson-Food
.... 27.255 LocationGen1
.... 27.256 LocationGen2
.... 27.257 LocationWelcomeHome
.... 27.258 MedicareAdvantage
.... 27.259 MedicareAdvantageHMO
.... 27.260 Network1
.... 27.261 Network2
.... 27.262 NetworkGen1
.... 27.263 NetworkGen2
.... 27.264 Organization-Social-Hope-CBO
.... 27.265 Organization-Social-Towson-Food
.... 27.266 OrganizationGen1
.... 27.267 OrganizationGen2
.... 27.268 OrganizationStateMedicaidAgencyAlabama
.... 27.269 OrganizationWelcomeHome
.... 27.270 OrgHousingAssistanceHubManagement
.... 27.271 OrgManageNetwork
.... 27.272 OrgOneNetwork1Affiliation
.... 27.273 OrgOneNetwork2Affiliation
.... 27.274 OrgOneWithNetwork1AndNetwork2
.... 27.275 Parameters - US SNOMED
.... 27.276 PatientConsent
.... 27.277 PharmChain
.... 27.278 PharmChainAffil1
.... 27.279 PharmChainRetailService
.... 27.280 PharmLoc1
.... 27.281 PharmLoc2
.... 27.282 PharmLoc3
.... 27.283 PharmLoc4
.... 27.284 PractitionerOneNetwork1Role
.... 27.285 PractitionerOneNetwork2Role
.... 27.286 PractitionerOneWithNetwork1AndNetwork2
.... 27.287 PractitionerRestrict
.... 27.288 PractitionerTwoNetwork1LeftAfterSixMonthRole
.... 27.289 PractitionerTwoWithNetwork1LeftAfterSixMonths
.... 27.290 SocialServiceHousingNetwork
.... 27.291 StateOfCTLocation
.... 27.292 StateOfIllinoisLicBoard
.... 27.293 Verify-Hospital
.... 27.294 Verify-Hospital-2
.... 27.295 Verify-JoeSmith
.... 27.296 Verify-JoeSmith-2
.... 27.297 Verify-JoeSmithHospitalRole