National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build 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-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

Table of Contents

Page standards status: Informative
.. 0 Table of Contents
... 1 Home
... 2 National Directory API Use Cases
... 3 National Directory API Examples
... 4 Attestation Use Cases
... 5 Validation & Verification Use Cases
... 6 Directory Artifacts
... 7 NDH CapabilityStatement
... 8 Conformance
... 9 National Directory API Implementation Guidance
... 10 Attestation and Verification Guidance
... 11 Resource Relationships
... 12 Change Log
... 13 Download Specification
... 14 other
... 15 Artifacts Summary
.... 15.1 NDH Server Capability Statement
.... 15.2 Scheduled NDH Export Operation
.... 15.3 Endpoint access-control-mechanism
.... 15.4 Endpoint dynamic-registration-trust-profile
.... 15.5 Endpoint ihe-connection-type
.... 15.6 Endpoint trust-framework-type
.... 15.7 HealthcareService eligibility
.... 15.8 HealthcareService location
.... 15.9 HealthcareService network
.... 15.10 HealthcareService new patient
.... 15.11 HealthcareService new patient from network
.... 15.12 Healthcareservice new-patient-and-from-network
.... 15.13 HealthcareService organization
.... 15.14 HealthcareService program requirement age group
.... 15.15 HealthcareService program requirement birthsex
.... 15.16 HealthcareService program requirement employment status
.... 15.17 HealthcareService program requirement insurance status
.... 15.18 HealthcareService program requirement preferred language
.... 15.19 HealthcareService program requirement va status
.... 15.20 HealthcareService social service requirement age group
.... 15.21 HealthcareService social service requirement birthsex
.... 15.22 HealthcareService social service requirement employment status
.... 15.23 HealthcareService social service requirement insurance status
.... 15.24 HealthcareService social service requirement preferred language
.... 15.25 HealthcareService social service requirement va status
.... 15.26 InsurancePlan coverage-area
.... 15.27 InsurancePlan coverage-benefit-type
.... 15.28 InsurancePlan coverage-network
.... 15.29 InsurancePlan coverage-type
.... 15.30 InsurancePlan network
.... 15.31 InsurancePlan plan-network
.... 15.32 InsurancePlan plan-type
.... 15.33 Location accessibility
.... 15.34 Location contains
.... 15.35 Location new-patient
.... 15.36 Location new-patient-from-network
.... 15.37 Network coverage-area
.... 15.38 OrganizationAffiliation location
.... 15.39 OrganizationAffiliation participating organization
.... 15.40 OrganizationAffiliation primary organization
.... 15.41 OrganizationAffiliation via-intermediary
.... 15.42 Practitioner endpoint
.... 15.43 Practitioner qualification-code
.... 15.44 Practitioner qualification-issuer
.... 15.45 PractitionerRole location
.... 15.46 PractitionerRole network
.... 15.47 PractitionerRole new-patient
.... 15.48 PractitionerRole new-patient-from-network
.... 15.49 PractitionerRole organization
.... 15.50 verification-status
.... 15.51 VerificationResult attestation-who
.... 15.52 VerificationResult primarysource-type
.... 15.53 VerificationResult primarysource-validation-status
.... 15.54 VerificationResult primarysource-who
.... 15.55 VerificationResult status
.... 15.56 VerificationResult target
.... 15.57 NDH Endpoint Profile
.... 15.58 NDH Group
.... 15.59 NDH HealthcareService Profile
.... 15.60 NDH InsurancePlan Profile
.... 15.61 NDH Location Profile
.... 15.62 NDH Network Profile
.... 15.63 NDH Organization Profile
.... 15.64 NDH OrganizationAffiliation Profile
.... 15.65 NDH Practitioner Profile
.... 15.66 NDH PractitionerRole
.... 15.67 NDH Verification
.... 15.68 NDH Accessibility
.... 15.69 NDH Age Group
.... 15.70 NDH Age Range
.... 15.71 NDH Associated Servers
.... 15.72 NDH Communication Proficiency
.... 15.73 NDH Contactpoint Availabletime
.... 15.74 NDH Delivery Method
.... 15.75 NDH Dynamic Registration
.... 15.76 NDH Endpoint Access Control Mechanism
.... 15.77 NDH Endpoint EnvironmentType
.... 15.78 NDH Endpoint IHE Specific Connection Type
.... 15.79 NDH Endpoint Rank
.... 15.80 NDH Endpoint Reference
.... 15.81 NDH Endpoint Testing Certification
.... 15.82 NDH Funding Source
.... 15.83 NDH HealthcareService or Program Requirement
.... 15.84 NDH Identifier Status
.... 15.85 NDH Implementation Guide Supported
.... 15.86 NDH InsurancePlan Reference
.... 15.87 NDH Language Speak
.... 15.88 NDH Location Reference
.... 15.89 NDH Logo
.... 15.90 NDH Network Reference
.... 15.91 NDH New Patients
.... 15.92 NDH New Patients Characteristics
.... 15.93 NDH Org Description
.... 15.94 NDH Organization Alias Period
.... 15.95 NDH Organization Alias Type
.... 15.96 NDH Payment Accepted
.... 15.97 NDH Practitioner Qualification
.... 15.98 NDH Qualification
.... 15.99 NDH Rating
.... 15.100 NDH Rating Details
.... 15.101 NDH Required Document
.... 15.102 NDH Secure Exchange Artifacts
.... 15.103 NDH Trust Framework
.... 15.104 NDH Verification Status
.... 15.105 NDH Via Intermediary
.... 15.106 Accepting Patients Codes Value Set
.... 15.107 Accessibility Value Set
.... 15.108 Age Range Value Set
.... 15.109 Associated Servers Type Value Set
.... 15.110 Benefit Type Value Set
.... 15.111 Employment Status Value Set
.... 15.112 Endpoint Access Control Mechanism Value Set
.... 15.113 Endpoint Connection Types Value Set
.... 15.114 Endpoint FHIR Mimetype Value Set
.... 15.115 Endpoint IHE Specific Connection Types Value Set
.... 15.116 Endpoint Payload Type Value Set
.... 15.117 Endpoint Testing Method Value Set
.... 15.118 Healthcare Service Category Value Set
.... 15.119 Healthcare Service Eligibility Code Value Set
.... 15.120 HealthcareService Type Value Set
.... 15.121 Identifier Status Value Set
.... 15.122 Individual and Group Specialties
.... 15.123 Individual Specialties, Degrees, Licenses, and Certificates Value Set
.... 15.124 Insurance Status Value Set
.... 15.125 NDH Endpoint Environment Value Set
.... 15.126 NDH endpoint Implementation Guide Value Set
.... 15.127 NDH Verification Process Value Set
.... 15.128 NDH Verification Status Value Set
.... 15.129 Network Type Value Set
.... 15.130 Organization Alias Type Value Sete
.... 15.131 Organization Type Value Set
.... 15.132 OrganizationAffiliation Roles
.... 15.133 PractitionerRole Code Value Set
.... 15.134 Qualification Status Value Set
.... 15.135 Secure Exchange Artifacts Value Set
.... 15.136 Specialties, Degrees, Licenses, and Certificates Value Set
.... 15.137 Trust Framework Type Value Set
.... 15.138 Trust Profile Value Set
.... 15.139 Virtual Modalities Value Set
.... 15.140 Endpoint Access Control Mechanism Code System
.... 15.141 Endpoint Connection Types (additional) Code System
.... 15.142 Insurance Benefit Type Code System
.... 15.143 NDH Age Range Code System
.... 15.144 NDH Associated Servers Type Code System
.... 15.145 NDH Direct Trust Endpoint Usecase Code System
.... 15.146 NDH Endpoint Environment Code System
.... 15.147 Ndh Endpoint Testing Method Code System
.... 15.148 NDH FHIR Endpoint Use Case Code System
.... 15.149 NDH Insurance Status Code System
.... 15.150 Ndh Organization Type Code System
.... 15.151 NDH Practitioner Role Codes Code System
.... 15.152 NDH Resource Instance Verification Status Code System
.... 15.153 NDH Secure Exchange Artifacts Code System
.... 15.154 NDH Trust FrameworkType Code System
.... 15.155 NDH Trust Profile Code System
.... 15.156 Acme
.... 15.157 AcmeOfCTPortalEndpoint
.... 15.158 AcmeofCTPremNet
.... 15.159 AcmeofCTStdNet
.... 15.160 AcmeQHPBronze
.... 15.161 AcmeQHPGold
.... 15.162 aGroup
.... 15.163 Backport Subscription for Practitioner Qualification Change
.... 15.164 BigBox
.... 15.165 BlueCrossBlueShield-CT
.... 15.166 BlueCrossBlueShield-CT-ORG
.... 15.167 BlueCrossBlueShield-CT-PPO
.... 15.168 BurrClinic
.... 15.169 BurrClinicAffil
.... 15.170 BurrClinicServices
.... 15.171 CoordinationOfCareEndpoint
.... 15.172 DirectTrustEndpointAdtNotifications
.... 15.173 DirectTrustEndpointReferrals
.... 15.174 Example-license
.... 15.175 HamiltonClinic
.... 15.176 HansSolo
.... 15.177 HansSoloClinic
.... 15.178 HansSoloDirectTrustEndpointReferrals
.... 15.179 HansSoloPatientAccessEndpoint
.... 15.180 HansSoloRole
.... 15.181 HansSoloRole2
.... 15.182 HansSoloService
.... 15.183 HartfordOrthopedics
.... 15.184 HartfordOrthopedicServices
.... 15.185 HealthcareService-Social-Hope-CBO
.... 15.186 HealthcareService-Social-Towson-Food
.... 15.187 HealthcareServiceHomelessAssistance
.... 15.188 Hospital
.... 15.189 HospLoc1
.... 15.190 HospLoc2
.... 15.191 IheEndpoint
.... 15.192 JoeSmith
.... 15.193 JoeSmithHospitalRole
.... 15.194 JoeSmithRole2
.... 15.195 location-bundle
.... 15.196 Location-Social-Hope-CBO
.... 15.197 Location-Social-Towson-Food
.... 15.198 LocationGen1
.... 15.199 LocationGen2
.... 15.200 LocationWelcomeHome
.... 15.201 MedicareAdvantage
.... 15.202 MedicareAdvantageHMO
.... 15.203 Network1
.... 15.204 Network2
.... 15.205 NetworkGen1
.... 15.206 NetworkGen2
.... 15.207 Organization-Social-Hope-CBO
.... 15.208 Organization-Social-Towson-Food
.... 15.209 OrganizationGen1
.... 15.210 OrganizationGen2
.... 15.211 OrganizationStateMedicaidAgencyAlabama
.... 15.212 OrganizationWelcomeHome
.... 15.213 OrgHousingAssistanceHubManagement
.... 15.214 OrgManageNetwork
.... 15.215 OrgOneNetwork1Affiliation
.... 15.216 OrgOneNetwork2Affiliation
.... 15.217 OrgOneWithNetwork1AndNetwork2
.... 15.218 Parameters - US SNOMED
.... 15.219 PharmChain
.... 15.220 PharmChainAffil1
.... 15.221 PharmChainRetailService
.... 15.222 PharmLoc1
.... 15.223 PharmLoc2
.... 15.224 PharmLoc3
.... 15.225 PharmLoc4
.... 15.226 PractitionerOneNetwork1Role
.... 15.227 PractitionerOneNetwork2Role
.... 15.228 PractitionerOneWithNetwork1AndNetwork2
.... 15.229 PractitionerTwoNetwork1LeftAfterSixMonthRole
.... 15.230 PractitionerTwoWithNetwork1LeftAfterSixMonths
.... 15.231 SocialServiceHousingNetwork
.... 15.232 StateOfCTLocation
.... 15.233 StateOfIllinoisLicBoard
.... 15.234 Verify-Hospital
.... 15.235 Verify-Hospital-2
.... 15.236 Verify-JoeSmith
.... 15.237 Verify-JoeSmith-2
.... 15.238 Verify-JoeSmithHospitalRole