National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build US

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 Plan-Net Mappings
... 16 Artifacts Summary
.... 16.1 NDH Server Capability Statement
.... 16.2 Scheduled NDH Export Operation
.... 16.3 Endpoint access-control-mechanism
.... 16.4 Endpoint dynamic-registration-trust-profile
.... 16.5 Endpoint ihe-connection-type
.... 16.6 Endpoint security-details
.... 16.7 HealthcareService eligibility
.... 16.8 HealthcareService location
.... 16.9 HealthcareService network
.... 16.10 HealthcareService new patient
.... 16.11 HealthcareService new patient from network
.... 16.12 Healthcareservice new-patient-and-from-network
.... 16.13 HealthcareService organization
.... 16.14 HealthcareService program requirement age group
.... 16.15 HealthcareService program requirement birthsex
.... 16.16 HealthcareService program requirement employment status
.... 16.17 HealthcareService program requirement insurance status
.... 16.18 HealthcareService program requirement preferred language
.... 16.19 HealthcareService program requirement va status
.... 16.20 HealthcareService social service requirement age group
.... 16.21 HealthcareService social service requirement birthsex
.... 16.22 HealthcareService social service requirement employment status
.... 16.23 HealthcareService social service requirement insurance status
.... 16.24 HealthcareService social service requirement preferred language
.... 16.25 HealthcareService social service requirement va status
.... 16.26 InsurancePlan coverage-area
.... 16.27 InsurancePlan coverage-benefit-type
.... 16.28 InsurancePlan coverage-network
.... 16.29 InsurancePlan coverage-type
.... 16.30 InsurancePlan network
.... 16.31 InsurancePlan plan-network
.... 16.32 InsurancePlan plan-type
.... 16.33 Location accessibility
.... 16.34 Location contains
.... 16.35 Network coverage-area
.... 16.36 OrganizationAffiliation location
.... 16.37 OrganizationAffiliation participating organization
.... 16.38 OrganizationAffiliation primary organization
.... 16.39 OrganizationAffiliation via-intermediary
.... 16.40 Practitioner endpoint
.... 16.41 Practitioner qualification-code
.... 16.42 Practitioner qualification-issuer
.... 16.43 PractitionerRole location
.... 16.44 PractitionerRole network
.... 16.45 PractitionerRole new-patient
.... 16.46 PractitionerRole new-patient-from-network
.... 16.47 PractitionerRole organization
.... 16.48 verification-status
.... 16.49 VerificationResult attestation-who
.... 16.50 VerificationResult primarysource-type
.... 16.51 VerificationResult primarysource-validation-status
.... 16.52 VerificationResult primarysource-who
.... 16.53 VerificationResult status
.... 16.54 VerificationResult target
.... 16.55 NDH Endpoint Profile
.... 16.56 NDH Group
.... 16.57 NDH HealthcareService Profile
.... 16.58 NDH InsurancePlan Profile
.... 16.59 NDH Location Profile
.... 16.60 NDH Network Profile
.... 16.61 NDH Organization Profile
.... 16.62 NDH OrganizationAffiliation Profile
.... 16.63 NDH Practitioner Profile
.... 16.64 NDH PractitionerRole
.... 16.65 NDH Verification
.... 16.66 NDH Accessibility
.... 16.67 NDH Age Group
.... 16.68 NDH Age Range
.... 16.69 NDH Aligned with CMS Data Network
.... 16.70 NDH Associated Servers
.... 16.71 NDH CMS Enrollment In Good Standing
.... 16.72 NDH CMS IAL2 Verified
.... 16.73 NDH Communication Proficiency
.... 16.74 NDH Contact Point Available Time
.... 16.75 NDH Delivery Method
.... 16.76 NDH Dynamic Registration
.... 16.77 NDH Endpoint Access Control Mechanism
.... 16.78 NDH Endpoint EnvironmentType
.... 16.79 NDH Endpoint IHE Specific Connection Type
.... 16.80 NDH Endpoint Rank
.... 16.81 NDH Endpoint Reference
.... 16.82 NDH Endpoint Testing Certification
.... 16.83 NDH Funding Source
.... 16.84 NDH HealthcareService or Program Requirement
.... 16.85 NDH Identifier Status
.... 16.86 NDH Implementation Guide Supported
.... 16.87 NDH InsurancePlan Reference
.... 16.88 NDH Language Speak
.... 16.89 NDH Location Reference
.... 16.90 NDH Logo
.... 16.91 NDH Network Reference
.... 16.92 NDH New Patients
.... 16.93 NDH New Patients Characteristics
.... 16.94 NDH Org Description
.... 16.95 NDH Organization Alias Period
.... 16.96 NDH Organization Alias Type
.... 16.97 NDH Payment Accepted
.... 16.98 NDH Practitioner Qualification Scope where valid and status
.... 16.99 NDH Qualification
.... 16.100 NDH Rating
.... 16.101 NDH Rating Details
.... 16.102 NDH Required Document
.... 16.103 NDH Secure Exchange Artifacts
.... 16.104 NDH Security Details
.... 16.105 NDH Verification Status
.... 16.106 NDH Via Intermediary
.... 16.107 Accepting Patients Codes Value Set
.... 16.108 Accessibility Value Set
.... 16.109 Age Range Value Set
.... 16.110 Associated Servers Type Value Set
.... 16.111 Benefit Type Value Set
.... 16.112 Employment Status Value Set
.... 16.113 Endpoint Access Control Mechanism Value Set
.... 16.114 Endpoint Connection Types Value Set
.... 16.115 Endpoint FHIR Mimetype Value Set
.... 16.116 Endpoint IHE Specific Connection Types Value Set
.... 16.117 Endpoint Payload Type Value Set
.... 16.118 Endpoint Testing Method Value Set
.... 16.119 FaCeT Organizational Credential Properties Value Set
.... 16.120 FaCeT Practitioner Credential Properties Value Set
.... 16.121 Healthcare Service Category Value Set
.... 16.122 Healthcare Service Eligibility Code Value Set
.... 16.123 HealthcareService Type Value Set
.... 16.124 Identifier Status Value Set
.... 16.125 Individual Qualifications Value Set
.... 16.126 Individual Specialties, Degrees, Licenses, and Certificates Value Set
.... 16.127 Individual Specialty Value Set
.... 16.128 Insurance Status Value Set
.... 16.129 NDH Endpoint Environment Value Set
.... 16.130 NDH endpoint Implementation Guide Value Set
.... 16.131 NDH Verification Process Value Set
.... 16.132 NDH Verification Status Value Set
.... 16.133 Network Type Value Set
.... 16.134 Organization Alias Type Value Sete
.... 16.135 Organization Type Value Set
.... 16.136 OrganizationAffiliation Roles
.... 16.137 PractitionerRole Code Value Set
.... 16.138 Qualification Status Value Set
.... 16.139 Secure Exchange Artifacts Value Set
.... 16.140 Specialties, Degrees, Licenses, and Certificates Value Set
.... 16.141 Trust Framework Type Value Set
.... 16.142 Trust Profile Value Set
.... 16.143 Virtual Modalities Value Set
.... 16.144 CodeSystem properties for FaCeT Organizational Credential
.... 16.145 CodeSystem properties for FaCeT Practitioner Credentials
.... 16.146 Endpoint Access Control Mechanism Code System
.... 16.147 Endpoint Connection Types (additional) Code System
.... 16.148 FaCeT Credential Code System
.... 16.149 FaCeT Organizational Credential Code System
.... 16.150 Insurance Benefit Type Code System
.... 16.151 NDH Age Range Code System
.... 16.152 NDH Associated Servers Type Code System
.... 16.153 NDH Direct Trust Endpoint Usecase Code System
.... 16.154 NDH Endpoint Environment Code System
.... 16.155 Ndh Endpoint Testing Method Code System
.... 16.156 NDH FHIR Endpoint Use Case Code System
.... 16.157 NDH Insurance Status Code System
.... 16.158 Ndh Organization Type Code System
.... 16.159 NDH Practitioner Role Codes Code System
.... 16.160 NDH Resource Instance Verification Status Code System
.... 16.161 NDH Secure Exchange Artifacts Code System
.... 16.162 NDH Trust FrameworkType Code System
.... 16.163 NDH Trust Profile Code System
.... 16.164 This StructureMap defines the mapping from Plan-Net Endpoint to NDH Endpoint.
.... 16.165 This StructureMap defines the mapping from Plan-Net HealthcareService to NDH HealthcareService.
.... 16.166 This StructureMap defines the mapping from Plan-Net InsurancePlan to NDH InsurancePlan.
.... 16.167 This StructureMap defines the mapping from Plan-Net Location to NDH Location.
.... 16.168 This StructureMap defines the mapping from Plan-Net Network to NDH Network.
.... 16.169 This StructureMap defines the mapping from Plan-Net OrganizationAffiliation to NDH OrganizationAffiliation.
.... 16.170 This StructureMap defines the mapping from Plan-Net Organization to NDH Organization.
.... 16.171 This StructureMap defines the mapping from Plan-Net PractitionerRole to NDH PractitionerRole.
.... 16.172 This StructureMap defines the mapping from Plan-Net Practitioner to NDH Practitioner.
.... 16.173 Plan-Net to NDH Accepting Patients ConceptMap
.... 16.174 Plan-Net to NDH Accessibility ConceptMap
.... 16.175 Plan-Net to NDH Healthcare Service Category ConceptMap
.... 16.176 Plan-Net to NDH Insurance Product Type ConceptMap
.... 16.177 Plan-Net to NDH PractitionerRole ConceptMap
.... 16.178 Acme
.... 16.179 AcmeOfCTPortalEndpoint
.... 16.180 AcmeofCTPremNet
.... 16.181 AcmeofCTStdNet
.... 16.182 AcmeQHPBronze
.... 16.183 AcmeQHPGold
.... 16.184 aGroup
.... 16.185 Backport Subscription for Practitioner Qualification Change
.... 16.186 BigBox
.... 16.187 BlueCrossBlueShield-CT
.... 16.188 BlueCrossBlueShield-CT-ORG
.... 16.189 BlueCrossBlueShield-CT-PPO
.... 16.190 BurrClinic
.... 16.191 BurrClinicAffil
.... 16.192 BurrClinicServices
.... 16.193 CoordinationOfCareEndpoint
.... 16.194 DirectTrustEndpointAdtNotifications
.... 16.195 DirectTrustEndpointReferrals
.... 16.196 Example-license
.... 16.197 HamiltonClinic
.... 16.198 HansSolo
.... 16.199 HansSoloClinic
.... 16.200 HansSoloDirectTrustEndpointReferrals
.... 16.201 HansSoloPatientAccessEndpoint
.... 16.202 HansSoloRole
.... 16.203 HansSoloRole2
.... 16.204 HansSoloService
.... 16.205 HartfordOrthopedics
.... 16.206 HartfordOrthopedicServices
.... 16.207 HealthcareService-Social-Hope-CBO
.... 16.208 HealthcareService-Social-Towson-Food
.... 16.209 HealthcareServiceHomelessAssistance
.... 16.210 Hospital
.... 16.211 HospLoc1
.... 16.212 HospLoc2
.... 16.213 IheEndpoint
.... 16.214 JoeSmith
.... 16.215 JoeSmithHospitalRole
.... 16.216 JoeSmithRole2
.... 16.217 location-bundle
.... 16.218 Location-Social-Hope-CBO
.... 16.219 Location-Social-Towson-Food
.... 16.220 LocationGen1
.... 16.221 LocationGen2
.... 16.222 LocationWelcomeHome
.... 16.223 MedicareAdvantage
.... 16.224 MedicareAdvantageHMO
.... 16.225 Network1
.... 16.226 Network2
.... 16.227 NetworkGen1
.... 16.228 NetworkGen2
.... 16.229 Organization-Social-Hope-CBO
.... 16.230 Organization-Social-Towson-Food
.... 16.231 OrganizationGen1
.... 16.232 OrganizationGen2
.... 16.233 OrganizationStateMedicaidAgencyAlabama
.... 16.234 OrganizationWelcomeHome
.... 16.235 OrgHousingAssistanceHubManagement
.... 16.236 OrgManageNetwork
.... 16.237 OrgOneNetwork1Affiliation
.... 16.238 OrgOneNetwork2Affiliation
.... 16.239 OrgOneWithNetwork1AndNetwork2
.... 16.240 Parameters - US SNOMED
.... 16.241 PharmChain
.... 16.242 PharmChainAffil1
.... 16.243 PharmChainRetailService
.... 16.244 PharmLoc1
.... 16.245 PharmLoc2
.... 16.246 PharmLoc3
.... 16.247 PharmLoc4
.... 16.248 PractitionerOneNetwork1Role
.... 16.249 PractitionerOneNetwork2Role
.... 16.250 PractitionerOneWithNetwork1AndNetwork2
.... 16.251 PractitionerTwoNetwork1LeftAfterSixMonthRole
.... 16.252 PractitionerTwoWithNetwork1LeftAfterSixMonths
.... 16.253 SocialServiceHousingNetwork
.... 16.254 StateOfCTLocation
.... 16.255 StateOfIllinoisLicBoard
.... 16.256 Verify-Hospital
.... 16.257 Verify-Hospital-2
.... 16.258 Verify-JoeSmith
.... 16.259 Verify-JoeSmith-2
.... 16.260 Verify-JoeSmithHospitalRole