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

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