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