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
| Page standards status: Normative |
To address the particular use case requirements of the NDH, a set of extensions are defined:
This extension enables NDH to communicate accessibility accommodations for practitioners and locations in a consistent, computable form, using a coded value with extensible binding to AccessibilityVS for interoperable discovery and filtering; it is used in Location and Practitioner.
This extension enables NDH to assert alignment with the CMS data network using a required boolean indicator for straightforward policy and participation checks; it is used in Practitioner and Organization.
This extension enables NDH to represent endpoint-to-server associations so implementers can publish alternate or companion server routes for operational flexibility, with structured sub-extensions for server type and server URL and an extensible binding to NdhAssociatedServersTypeVS for consistent classification; it is used in Endpoint.
This extension enables NDH to assert whether an artifact is enrolled with CMS and currently in good standing, using a required boolean for unambiguous compliance signaling; it is used in Practitioner, Organization, and VerificationResult.
This extension enables NDH to assert CMS IAL2 identity assurance verification status for an artifact using a required boolean indicator; it is used in Practitioner, Organization, and VerificationResult.
This extension enables NDH to encode a practitioner's language proficiency level for a declared communication language, using a CodeableConcept bound extensibly to ILRReadingScaleVS to support consistent language-access matching; it is used in Practitioner.communication.
This extension enables NDH to declare how a service is delivered and, when virtual, which modalities are supported, using structured sub-extensions and ValueSet bindings to DeliveryMethodVS and VirtualModalitiesVS for predictable service-access routing; it is used in HealthcareService.
This extension enables NDH to convey dynamic client-registration capabilities for trust-framework participation, using sub-extensions for trust profile and version and an extensible binding to TrustProfileVS to standardize runtime registration signaling; it is used in Endpoint.
This extension enables NDH to classify endpoint environment context, using a CodeableConcept with extensible binding to NdhEndpointEnvironmentVS so consumers can distinguish operational deployment targets consistently; it is used in Endpoint.
This extension enables NDH to represent IHE-specific endpoint connection semantics when base connectionType coding is insufficiently granular, using a preferred binding to EndpointIheSpecificConnectionTypeVS for more precise interoperability declarations; it is used in Endpoint.
This extension enables NDH to express preferred ordering among functionally equivalent endpoints, using a required positive integer so clients can deterministically select connection priority; it is used in Endpoint.
This extension enables NDH to attach a direct reference to an NDH Endpoint resource so technical exchange capabilities can be resolved from practitioner-facing directory data; it is used in Practitioner.
This extension enables NDH to document endpoint testing and certification evidence, including tester, method, certificate artifact, and relevant timestamps, using structured sub-extensions and an extensible binding to EndpointTestingMethodVS for harmonized test-method representation; it is used in Endpoint.
This extension enables NDH to declare endpoint access-control approach for secure and scalable exchange, using an extensible binding to EndpointAccessControlMechanismVS so clients can align connection behavior with expected authorization patterns; it is used in Endpoint.
This extension enables NDH to identify funding provenance for services and organizations, using structured sub-extensions for funding identifiers, funding organizations, and source text to support financial-context transparency in directory records; it is used in HealthcareService and Organization.
This extension enables NDH to assert lifecycle status for identifiers in a normalized way, using required code binding to IdentifierStatusVS so consumers can consistently interpret identifier validity and operational state; it is used in Identifier.
This extension enables NDH to declare implementation-guide compatibility for endpoints when standard connection-type coding does not fully describe behavior, using structured sub-extensions for IG URI, name, use case, version, actor, and options with extensible use-case binding to NdhImplementationGuideVS; it is used in Endpoint.
This extension enables NDH to link organizations to accepted NDH InsurancePlan resources, providing explicit plan participation references for accurate plan-organization discovery; it is used in Organization.
This extension enables NDH to represent spoken language capability at telecom contact points, using extensible binding to LanguagesVS to improve language-concordant access and communication routing; it is used in HealthcareService.telecom, Location.telecom, and Organization.telecom.
This extension enables NDH to declare NDH Location-based coverage areas, supporting clear network and organizational service-geography linkage for downstream eligibility and routing decisions; it is used in Organization.
This extension enables NDH to attach a canonical visual identity artifact for services and organizations using an Attachment value, supporting recognizable presentation across directory consumers; it is used in HealthcareService, Organization, and OrganizationAffiliation.
This extension enables NDH to represent age-based eligibility categories as coded concepts with extensible binding to AgeGroupVS for consistent age-group filtering; it is used as a nested extension within base-ext-service-or-program-requirement.
This extension enables NDH to represent age-based eligibility as a structured Range value for service and program requirement evaluation; it is used as a nested extension within base-ext-service-or-program-requirement.
This extension enables NDH to explicitly link practitioner roles and services to participating NDH Network resources, improving network participation discovery and filtering; it is used in PractitionerRole and HealthcareService.
This extension enables NDH to capture additional qualifiers about accepted new-patient populations as textual characteristics, complementing structured acceptance indicators in NewPatients workflows; it is used as a nested extension within base-ext-newpatients.
This extension enables NDH to represent new-patient acceptance policy with optional network specificity and contextual characteristics, using structured sub-extensions and required binding to AcceptingPatientsVS so access status can be compared consistently across roles, services, and locations; it is used in HealthcareService, Location, and PractitionerRole.
This extension enables NDH to time-bound organization alias validity with a Period value so consumers can distinguish current from historical alternate names; it is used in Organization.alias.
This extension enables NDH to classify organization aliases by usage type, using a CodeableConcept bound by example to OrgAliasTypeVS to support clearer interpretation of alternate naming; it is used in Organization.alias.
This extension enables NDH to provide a concise human-readable narrative describing an organization's purpose or scope, improving directory comprehension beyond coded attributes; it is used in Organization.
This extension enables NDH to state accepted payment methods for services or organizations, using required binding to paymentTypeVS for interoperable financial-access signaling; it is used in HealthcareService and Organization.
This extension enables NDH to qualify practitioner credentials with explicit status and jurisdictional validity, using structured sub-extensions with required bindings to QualificationStatusVS and US-core state semantics for computable credential governance; it is used in Practitioner.qualification.
This extension enables NDH to carry supplemental rating metadata, including rating system, rating type, and rating value, so implementer-defined scoring models can be represented with clearer provenance and meaning; it is used as a nested extension within base-ext-rating.
This extension enables NDH to represent ratings for services, organizations, practitioners, and roles, with structured support for rating type, quantitative or textual values, and optional nested RatingDetails for richer comparative quality signals; it is used in HealthcareService, Organization, Practitioner, and PractitionerRole.
This extension enables NDH to enumerate documents required to access or use a service, using structured identifier and document sub-extensions to support intake readiness and pre-visit transparency; it is used in HealthcareService.
This extension enables NDH to publish key secure-exchange artifacts needed for trust establishment, including artifact type, certificate payload, and expiration, with extensible binding to NdhSecureExchangeArtifactsVS for interoperable certificate-discovery workflows; it is used in Endpoint.
This extension enables NDH to communicate endpoint trust-framework security context, including framework type, qualifiers, signed artifacts, and public certificates, with extensible TrustFrameworkTypeVS binding to support consistent policy interpretation across trust communities; it is used in Endpoint.
This extension represents a service offered by a group, which can be used to describe the types of services provided by a multidisciplinary provider group in the context of coordinated care delivery. It allows for the inclusion of multiple services, each represented as a CodeableConcept, to capture the range of services that a group may offer to patients or clients.
This extension enables NDH to encode participation criteria for services and programs using structured demographic and coverage-related sub-extensions, including age range/group, birth sex, employment, insurance, veteran status, and preferred language, with ValueSet bindings that support consistent eligibility interpretation; it is used in HealthcareService.
This extension enables NDH to communicate verification standing for directory resources in a consistent coded format, using an extensible binding to NdhVerificationStatusVS for trust-state interoperability; it is used in Endpoint, HealthcareService, InsurancePlan, Location, Organization, OrganizationAffiliation, Practitioner, PractitionerRole, and Group.