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

Table of Contents

Page standards status: Informative
.. 0 Table of Contents
... 1 Home
... 2 Base Artifacts
... 3 National Directory API Use Cases
... 4 National Directory API Implementation Guidance
... 5 National Directory API Artifacts
... 6 National Directory API Capability Satement
... 7 National Directory API Examples
... 8 Attestation Use Cases
... 9 Attestation Flow Diagrams
... 10 Attestation Implementation Guidance
... 11 Attestation Artifacts
... 12 Attestation CapabilityStatement
... 13 Validation & Verification Use Cases
... 14 Validation & Verification Flow Diagrams
... 15 Validation & Verification Implementation Guidance
... 16 Validation & Verification Artifacts
... 17 Validation & Verification CapabilityStatement
... 18 Local Directory API Use Cases
... 19 Local Directory API Implementation Guidance
... 20 Local Directory API Artifacts
... 21 Local Directory API CapabilityStatement
... 22 Local Directory API Examples
... 23 Download Specification
... 24 other
... 25 Change Log
... 26 Artifacts Summary
.... 26.1 National Directory API Base Expanded Server Capability Statement
.... 26.2 National Directory API Base Server Capability Statement
.... 26.3 National Directory API Capability Statement
.... 26.4 NDH Attestation Server Capability Statement
.... 26.5 NDH Verification Server Capability Statement
.... 26.6 Workflow Directory Server Endpoint Basic Query Capability Statement
.... 26.7 Workflow Directory Server Endpoint Expanded Query Capability Statement
.... 26.8 Workflow Directory Server Health And Human Service Basic Query Capability Statement
.... 26.9 Workflow Directory Server Health And Human Service Expanded Query Capability Statement
.... 26.10 Workflow Directory Server Human Service Basic Query Capability Statement
.... 26.11 Workflow Directory Server Human Service Expanded Query Capability Statement
.... 26.12 Workflow Directory Server Payer Provider Network Query Capability Statement
.... 26.13 Workflow Directory Server Provider Basic Query Capability Statement
.... 26.14 Workflow Directory Server Provider Expanded Query Capability Statement
.... 26.15 Scheduled NDH Export Operation
.... 26.16 CareTeam endpoint
.... 26.17 CareTeam location
.... 26.18 CareTeam Name
.... 26.19 CareTeam organization
.... 26.20 CareTeam service
.... 26.21 CareTeam verification-status
.... 26.22 Endpoint access-control-mechanism
.... 26.23 Endpoint connection-type-version
.... 26.24 Endpoint dynamic-registration-trust-profile
.... 26.25 Endpoint ihe-connection-type
.... 26.26 Endpoint nonfhir-usecase-type
.... 26.27 Endpoint trust-framework-type
.... 26.28 Endpoint usecase-type
.... 26.29 Endpoint verification-status
.... 26.30 HealthcareService eligibility
.... 26.31 HealthcareService location
.... 26.32 HealthcareService network
.... 26.33 HealthcareService new patient
.... 26.34 HealthcareService new patient from network
.... 26.35 Healthcareservice new-patient-and-from-network
.... 26.36 HealthcareService organization
.... 26.37 HealthcareService program requirement age group
.... 26.38 HealthcareService program requirement birthsex
.... 26.39 HealthcareService program requirement employment status
.... 26.40 HealthcareService program requirement insurance status
.... 26.41 HealthcareService program requirement preferred language
.... 26.42 HealthcareService program requirement va status
.... 26.43 HealthcareService social service requirement age group
.... 26.44 HealthcareService social service requirement birthsex
.... 26.45 HealthcareService social service requirement employment status
.... 26.46 HealthcareService social service requirement insurance status
.... 26.47 HealthcareService social service requirement preferred language
.... 26.48 HealthcareService social service requirement va status
.... 26.49 HealthcareService verification status
.... 26.50 InsurancePlan coverage-area
.... 26.51 InsurancePlan coverage-benefit-type
.... 26.52 InsurancePlan coverage-network
.... 26.53 InsurancePlan coverage-type
.... 26.54 InsurancePlan network
.... 26.55 InsurancePlan plan-network
.... 26.56 InsurancePlan plan-type
.... 26.57 InsurancePlan verification-status
.... 26.58 Location accessibility
.... 26.59 Location contains
.... 26.60 Location new-patient
.... 26.61 Location new-patient-and-from-network
.... 26.62 Location new-patient-from-network
.... 26.63 Location verification-status
.... 26.64 Network coverage-area
.... 26.65 Organization or Network verification-status
.... 26.66 OrganizationAffiliation location
.... 26.67 OrganizationAffiliation participating organization
.... 26.68 OrganizationAffiliation primary organization
.... 26.69 OrganizationAffiliation verification-status
.... 26.70 OrganizationAffiliation via-intermediary
.... 26.71 Practitioner endpoint
.... 26.72 Practitioner qualification-code
.... 26.73 Practitioner qualification-issuer
.... 26.74 Practitioner verification-status
.... 26.75 PractitionerRole location
.... 26.76 PractitionerRole network
.... 26.77 PractitionerRole new-patient
.... 26.78 Practitionerrole new-patient-and-from-network
.... 26.79 PractitionerRole new-patient-from-network
.... 26.80 PractitionerRole organization
.... 26.81 PractitionerRole verification-status
.... 26.82 VerificationResult attestation-communication-method
.... 26.83 VerificationResult attestation-onbehalfof
.... 26.84 VerificationResult attestation-who
.... 26.85 VerificationResult primarysource-type
.... 26.86 VerificationResult primarysource-validation-date
.... 26.87 VerificationResult primarysource-validation-status
.... 26.88 VerificationResult primarysource-who
.... 26.89 VerificationResult status
.... 26.90 VerificationResult status-date
.... 26.91 VerificationResult target
.... 26.92 VerificationResult validator-organization
.... 26.93 National Directory API CareTeam Profile
.... 26.94 National Directory API Endpoint Profile
.... 26.95 National Directory API HealthcareService Profile
.... 26.96 National Directory API InsurancePlan Profile
.... 26.97 National Directory API Location Profile
.... 26.98 National Directory API Network Profile
.... 26.99 National Directory API Organization Profile
.... 26.100 National Directory API OrganizationAffiliation Profile
.... 26.101 National Directory API Practitioner Profile
.... 26.102 National Directory API PractitionerRole
.... 26.103 NDH Base CareTeam Profile
.... 26.104 NDH Base Endpoint Profile
.... 26.105 NDH Base HealthcareService Profile
.... 26.106 NDH Base InsurancePlan Profile
.... 26.107 NDH Base Location Profile
.... 26.108 NDH Base Network Profile
.... 26.109 NDH Base Organization Profile
.... 26.110 NDH Base OrganizationAffiliation Profile
.... 26.111 NDH Base Practitioner Profile
.... 26.112 NDH Base PractitionerRole
.... 26.113 NDH Base Restriction
.... 26.114 NDH Base Verification
.... 26.115 Payer Provider Network Local Directory API Endpoint Profile
.... 26.116 Payer Provider Network Query HealthcareService Profile
.... 26.117 Payer Provider Network Query InsurancePlan Profile
.... 26.118 Payer Provider Network Query Location Profile
.... 26.119 Payer Provider Network Query Network Profile
.... 26.120 Payer Provider Network Query Organization Profile
.... 26.121 Payer Provider Network Query OrganizationAffiliation Profile
.... 26.122 Payer Provider Network Query Practitioner Profile
.... 26.123 Payer Provider Network Query PractitionerRole
.... 26.124 NDH Accessibility
.... 26.125 NDH Age Group
.... 26.126 NDH Age Range
.... 26.127 NDH Associated Servers
.... 26.128 NDH Combined Payload And MimeType
.... 26.129 NDH Communication Proficiency
.... 26.130 NDH Contactpoint Availabletime
.... 26.131 NDH Delivery Method
.... 26.132 NDH Digitalcertificate
.... 26.133 NDH Dynamic Registration
.... 26.134 NDH Endpoint Access Control Mechanism
.... 26.135 NDH Endpoint Connection Type Version
.... 26.136 NDH Endpoint EnvironmentType
.... 26.137 NDH Endpoint IHE Specific Connection Type
.... 26.138 NDH Endpoint Non FHIR Usecase
.... 26.139 NDH Endpoint Rank
.... 26.140 NDH Endpoint Reference
.... 26.141 NDH Endpoint Testing Certification
.... 26.142 NDH Endpoint Usecase
.... 26.143 NDH FHIR IG
.... 26.144 NDH Funding Source
.... 26.145 NDH HealthcareService or Program Requirement
.... 26.146 NDH Healthcareservice Reference
.... 26.147 NDH Identifier Status
.... 26.148 NDH InsurancePlan Reference
.... 26.149 NDH Language Speak
.... 26.150 NDH Location Reference
.... 26.151 NDH Logo
.... 26.152 NDH Network Reference
.... 26.153 NDH New Patients
.... 26.154 NDH New Patients Characteristics
.... 26.155 NDH Org Description
.... 26.156 NDH Organization Alias Period
.... 26.157 NDH Organization Alias Type
.... 26.158 NDH Payment Accepted
.... 26.159 NDH Practitioner Qualification
.... 26.160 NDH Qualification
.... 26.161 NDH Rating
.... 26.162 NDH Rating Details
.... 26.163 NDH Required Document
.... 26.164 NDH Secure Exchange Artifacts
.... 26.165 NDH Supported IG
.... 26.166 NDH Supported IG Actor
.... 26.167 NDH Trust Framework
.... 26.168 NDH Usage Restriction
.... 26.169 NDH usage restriction fhir path
.... 26.170 NDH Verification Status
.... 26.171 NDH Via Intermediary
.... 26.172 Accepting Patients Codes Value Set
.... 26.173 Accessibility Value Set
.... 26.174 Age Range Value Set
.... 26.175 Associated Servers Type Value Set
.... 26.176 Benefit Type Value Set
.... 26.177 Consent Policy Rules Value Set
.... 26.178 Digital Certificate Use Value Set
.... 26.179 Employment Status Value Set
.... 26.180 Endpoint Access Control Mechanism Value Set
.... 26.181 Endpoint common mimetype Value Set
.... 26.182 Endpoint Connection Types Value Set
.... 26.183 Endpoint FHIR Mimetype Value Set
.... 26.184 Endpoint IHE Specific Connection Types Value Set
.... 26.185 Endpoint Payload Type Value Set
.... 26.186 Endpoint Testing Method Value Set
.... 26.187 Healthcare Service Category Value Set
.... 26.188 Healthcare Service Eligibility Code Value Set
.... 26.189 HealthcareService Type Value Set
.... 26.190 Identifier Status Value Set
.... 26.191 IG Actor Value Set
.... 26.192 Individual and Group Specialties
.... 26.193 Individual Specialties, Degrees, Licenses, and Certificates Value Set
.... 26.194 Insurance Status Value Set
.... 26.195 NDH Care Team Category Value Set
.... 26.196 NDH Consent Category Value Set
.... 26.197 NDH Consent Scope Value Set
.... 26.198 NDH Direct Trust Endpoint Usecase Value Set
.... 26.199 NDH Direct Trust Payload Type Value Set
.... 26.200 NDH Endpoint Environment Value Set
.... 26.201 NDH FHIR Endpoint Usecase Value Set
.... 26.202 NDH Verification Process Value Set
.... 26.203 NDH Verification Status Value Set
.... 26.204 Network Type Value Set
.... 26.205 Non-Individual Specialties
.... 26.206 Organization Alias Type Value Sete
.... 26.207 Organization Type Value Set
.... 26.208 OrganizationAffiliation Roles
.... 26.209 PractitionerRole Code Value Set
.... 26.210 Qualification Status Value Set
.... 26.211 Secure Exchange Artifacts Value Set
.... 26.212 Specialties Value Set
.... 26.213 Specialties, Degrees, Licenses, and Certificates Value Set
.... 26.214 Trust Framework Type Value Set
.... 26.215 Trust Profile Value Set
.... 26.216 Virtual Modalities Value Set
.... 26.217 Endpoint Access Control Mechanism Code System
.... 26.218 Endpoint Connection Types (additional) Code System
.... 26.219 Insurance Benefit Type Code System
.... 26.220 National Healthcare Directory Consent Category Code System
.... 26.221 National Healthcare Directory ConsentPolicyRules Code System
.... 26.222 NDH Age Range Code System
.... 26.223 NDH Associated Servers Type Code System
.... 26.224 NDH ConsentScopeCodes Code System
.... 26.225 NDH Digitalcertificate Use Code System
.... 26.226 NDH Direct Trust Endpoint Usecase Code System
.... 26.227 NDH Direct Trust Payload Type Code System
.... 26.228 NDH Endpoint Environment Code System
.... 26.229 Ndh Endpoint Testing Method Code System
.... 26.230 NDH FHIR Endpoint Use Case Code System
.... 26.231 NDH IG Actor Code System
.... 26.232 NDH Insurance Status Code System
.... 26.233 Ndh Organization Type Code System
.... 26.234 NDH Practitioner Role Codes Code System
.... 26.235 NDH Resource Instance Verification Status Code System
.... 26.236 NDH Secure Exchange Artifacts Code System
.... 26.237 NDH Trust FrameworkType Code System
.... 26.238 NDH Trust Profile Code System
.... 26.239 Acme
.... 26.240 AcmeOfCTPortalEndpoint
.... 26.241 AcmeofCTPremNet
.... 26.242 AcmeofCTStdNet
.... 26.243 AcmeofCTStdNet2
.... 26.244 AcmeQHPBronze
.... 26.245 AcmeQHPBronze3
.... 26.246 AcmeQHPGold
.... 26.247 Backport Subscription for Practitioner Qualification Change
.... 26.248 BigBox
.... 26.249 BlueCrossBlueShield-CT
.... 26.250 BlueCrossBlueShield-CT-ORG
.... 26.251 BlueCrossBlueShield-CT-PPO
.... 26.252 BurrClinic
.... 26.253 BurrClinicAffil
.... 26.254 BurrClinicAffil2
.... 26.255 BurrClinicServices
.... 26.256 BurrClinicServices2
.... 26.257 CareTeam1
.... 26.258 CareTeam2
.... 26.259 CoordinationOfCareEndpoint
.... 26.260 diamond-mtls-endpoint2
.... 26.261 diamondonyxhealth2
.... 26.262 DirectTrustEndpointAdtNotifications
.... 26.263 DirectTrustEndpointReferrals
.... 26.264 Example-license
.... 26.265 GaryGroup
.... 26.266 HamiltonClinic
.... 26.267 HansSolo
.... 26.268 HansSoloClinic
.... 26.269 HansSoloDirectTrustEndpointReferrals
.... 26.270 HansSoloPatientAccessEndpoint
.... 26.271 HansSoloRole
.... 26.272 HansSoloRole2
.... 26.273 HansSoloService
.... 26.274 HartfordOrthopedics
.... 26.275 HartfordOrthopedicServices
.... 26.276 HealthcareService-Social-Hope-CBO
.... 26.277 HealthcareService-Social-Towson-Food
.... 26.278 HealthcareServiceHomelessAssistance
.... 26.279 HealthcareServiceWomenShelter
.... 26.280 HealthcareServiceWomenShelterAll
.... 26.281 Hospital
.... 26.282 Hospital2
.... 26.283 HospLoc1
.... 26.284 HospLoc2
.... 26.285 HospLoc3
.... 26.286 IheEndpoint
.... 26.287 JoeSmith
.... 26.288 JoeSmithHospitalRole
.... 26.289 JoeSmithRole2
.... 26.290 JoeSmithRole3
.... 26.291 location-bundle
.... 26.292 Location-Social-Hope-CBO
.... 26.293 Location-Social-Towson-Food
.... 26.294 LocationGen1
.... 26.295 LocationGen2
.... 26.296 LocationWelcomeHome
.... 26.297 LocationWomenShelter
.... 26.298 LocationWomenShelterAll
.... 26.299 MedicareAdvantage
.... 26.300 MedicareAdvantageHMO
.... 26.301 MilitaryHealthcareOrganization
.... 26.302 Network1
.... 26.303 Network2
.... 26.304 NetworkGen1
.... 26.305 NetworkGen2
.... 26.306 Organization-Social-Hope-CBO
.... 26.307 Organization-Social-Towson-Food
.... 26.308 OrganizationGen1
.... 26.309 OrganizationGen2
.... 26.310 OrganizationStateMedicaidAgencyAlabama
.... 26.311 OrganizationWelcomeHome
.... 26.312 OrgHousingAssistanceHubManagement
.... 26.313 OrgManageNetwork
.... 26.314 OrgOneNetwork1Affiliation
.... 26.315 OrgOneNetwork2Affiliation
.... 26.316 OrgOneWithNetwork1AndNetwork2
.... 26.317 Parameters - US SNOMED
.... 26.318 PatientConsent
.... 26.319 PharmChain
.... 26.320 PharmChainAffil1
.... 26.321 PharmChainRetailService
.... 26.322 PharmLoc1
.... 26.323 PharmLoc2
.... 26.324 PharmLoc3
.... 26.325 PharmLoc4
.... 26.326 PractitionerOneNetwork1Role
.... 26.327 PractitionerOneNetwork2Role
.... 26.328 PractitionerOneWithNetwork1AndNetwork2
.... 26.329 PractitionerRestrict
.... 26.330 PractitionerTwoNetwork1LeftAfterSixMonthRole
.... 26.331 PractitionerTwoWithNetwork1LeftAfterSixMonths
.... 26.332 SocialServiceHousingNetwork
.... 26.333 StateOfCTLocation
.... 26.334 StateOfIllinoisLicBoard
.... 26.335 Verify-Hospital
.... 26.336 Verify-Hospital-2
.... 26.337 Verify-JoeSmith
.... 26.338 Verify-JoeSmith-2
.... 26.339 Verify-JoeSmithHospitalRole