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