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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

NDH Server Capability Statement

The NDH CapabilityStatement defines the requirements for the NDH Server. The NDH Server is responsible for providing responses to the queries submitted by the NDH Requestors. The NDH Requestors (clients) have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Scheduled NDH Export Operation

This operation enables authorized clients to request scheduled, asynchronous NDH data exports with optional resource-type and query filtering, configurable output format and cadence, and lifecycle controls for status tracking, cancellation, and file-retention behavior.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Endpoint access-control-mechanism

Use this search parameter to find endpoints by access-control approach so clients can match expected authentication and authorization patterns. Applies to Endpoint records.

Endpoint dynamic-registration-trust-profile

Use this search parameter to find endpoints that support dynamic trust-profile registration so onboarding can be automated and scalable. Applies to Endpoint records.

Endpoint ihe-connection-type

Use this search parameter to find endpoints by detailed IHE-specific connection semantics when general connection types are not precise enough. Applies to Endpoint records.

Endpoint security-details

Use this search parameter to identify endpoints by trust framework so they can connect through compatible security and policy communities. Applies to Endpoint records.

Group service-offered

Use this search parameter to find Group records by services offered to identify groups that provide specific services. Applies to Group records.

HealthcareService eligibility

Use this search parameter to find HealthcareService records with the specified eligibility. Applies to HealthcareService records.

HealthcareService location

Use this search parameter to find HealthcareService records with the specified location. Applies to HealthcareService records.

HealthcareService network

Use this search parameter to find records linked to specific networks to evaluate in-network participation and coverage pathways. Applies to HealthcareService records.

HealthcareService new patient

Use this search parameter to find where new patients are being accepted to identify available access points for care. Applies to HealthcareService records.

HealthcareService new patient from network

Use this search parameter to find where new-patient acceptance is tied to a specific network so coverage-based access can be evaluated. Applies to HealthcareService records.

HealthcareService organization

Use this search parameter to find HealthcareService records with the specified organization. Applies to HealthcareService records.

HealthcareService program requirement age group

Use this search parameter to find services or programs by age-group eligibility to match offerings to age-based participation needs. Applies to HealthcareService records.

HealthcareService program requirement birthsex

Use this search parameter to find services or programs using birth-sex eligibility criteria to screen for population-specific participation rules. Applies to HealthcareService records.

HealthcareService program requirement employment status

Use this search parameter to find services or programs by employment-status criteria to identify offerings aligned to employment-based eligibility. Applies to HealthcareService records.

HealthcareService program requirement insurance status

Use this search parameter to find services or programs by insurance-status criteria to identify offerings aligned to coverage circumstances. Applies to HealthcareService records.

HealthcareService program requirement preferred language

Use this search parameter to find services or programs by preferred-language criteria to locate linguistically appropriate options. Applies to HealthcareService records.

HealthcareService program requirement va status

Use this search parameter to find services or programs by veteran-status criteria to identify offerings intended for veteran populations. Applies to HealthcareService records.

HealthcareService social service requirement age group

Use this search parameter to find services or programs by age-group eligibility to match offerings to age-based participation needs. Applies to HealthcareService records.

HealthcareService social service requirement birthsex

Use this search parameter to find services or programs using birth-sex eligibility criteria to screen for population-specific participation rules. Applies to HealthcareService records.

HealthcareService social service requirement employment status

Use this search parameter to find services or programs by employment-status criteria to identify offerings aligned to employment-based eligibility. Applies to HealthcareService records.

HealthcareService social service requirement insurance status

Use this search parameter to find services or programs by insurance-status criteria to identify offerings aligned to coverage circumstances. Applies to HealthcareService records.

HealthcareService social service requirement preferred language

Use this search parameter to find services or programs by preferred-language criteria to locate linguistically appropriate options. Applies to HealthcareService records.

HealthcareService social service requirement va status

Use this search parameter to find services or programs by veteran-status criteria to identify offerings intended for veteran populations. Applies to HealthcareService records.

Healthcareservice new-patient-and-from-network

Use this search parameter to find HealthcareService records with specified new-patient acceptance and network criteria. Applies to HealthcareService records.

InsurancePlan coverage-area

Use this search parameter to find products that are offered in the specified location. Applies to InsurancePlan records.

InsurancePlan coverage-benefit-type

Use this search parameter to find products that are offered in the specified coverage benefit type. Applies to InsurancePlan records.

InsurancePlan coverage-network

Use this search parameter to find products offering covered benefits through the specified coverage network. Applies to InsurancePlan records.

InsurancePlan coverage-type

Use this search parameter to find products that are offered in the specified coverage type. Applies to InsurancePlan records.

InsurancePlan plan-network

Use this search parameter to find products that are offered in the specified plan network. Applies to InsurancePlan records.

InsurancePlan plan-type

Use this search parameter to find products that are offered in the specified plan type. Applies to InsurancePlan records.

Insuranceplan-network

Use this search parameter to find products that are offered in the specified network. Applies to InsurancePlan records.

Location accessibility

Use this search parameter to find locations by accessibility accommodations to locate sites that meet access-support needs. Applies to Location records.

Location contains

Use this search parameter to find locations by geographic containment to discover sites that serve or fall within a target area. Applies to Location records.

Network coverage-area

Use this search parameter to find network records by coverage area to identify networks available in a specific location. Applies to Organization records.

OrganizationAffiliation location

Use this search parameter to find OrganizationAffiliation records with the specified location. Applies to OrganizationAffiliation records.

OrganizationAffiliation participating organization

Use this search parameter to find OrganizationAffiliation records with the specified participating organization. Applies to OrganizationAffiliation records.

OrganizationAffiliation primary organization

Use this search parameter to find OrganizationAffiliation records with the specified primary organization. Applies to OrganizationAffiliation records.

Practitioner endpoint

Use this search parameter to find practitioners linked to technical endpoints to discover professionals available for electronic exchange. Applies to Practitioner records.

Practitioner qualification-code

Use this search parameter to find Practitioner records by qualification code. Applies to Practitioner records.

Practitioner qualification-issuer

Use this search parameter to find Practitioner records by qualification issuer organization. Applies to Practitioner records.

PractitionerRole location

Use this search parameter to find PractitionerRole records by location. Applies to PractitionerRole records.

PractitionerRole network

Use this search parameter to find records linked to specific networks to evaluate in-network participation and coverage pathways. Applies to PractitionerRole records.

PractitionerRole new-patient

Use this search parameter to find PractitionerRole records by new-patient acceptance. Applies to PractitionerRole records.

PractitionerRole new-patient-from-network

Use this search parameter to find PractitionerRole records by new-patient acceptance from a specified network. Applies to PractitionerRole records.

PractitionerRole organization

Use this search parameter to find PractitionerRole records by organization. Applies to PractitionerRole records.

VerificationResult attestation-who

Use this search parameter to find validation information for data that was attested to by the specified individual or organization. Applies to VerificationResult records.

VerificationResult primarysource-type

Use this search parameter to find verification information for data that was verified against the specified primary source type. Applies to VerificationResult records.

VerificationResult primarysource-validation-status

Use this search parameter to find verification information for data that was verified against the specified primary source validation status. Applies to VerificationResult records.

VerificationResult primarysource-who

Use this search parameter to find verification information for data that was verified against the specified primary source actor. Applies to VerificationResult records.

VerificationResult status

Use this search parameter to find verification information for data that was verified against the specified status. Applies to VerificationResult records.

VerificationResult target

Use this search parameter to find verification information for data that was verified against the specified target. Applies to VerificationResult records.

verification-status

Use this search parameter to find records by verification standing to prioritize trusted and current directory data. Applies to Endpoint, HealthcareService, Organization, Location, Practitioner, PractitionerRole, InsurancePlan, OrganizationAffiliation, and Group records.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

NDH Endpoint Profile

This profile enables NDH to publish trusted, implementation-ready technical endpoints so directory consumers can reliably discover, evaluate, and connect to electronic exchange services including APIs and messaging; it adds endpoint-focused extensions for trust, registration, access control, testing, and environment context, and applies ValueSet bindings that standardize connection type, payload type, and MIME-type semantics.

NDH Group

This profile enables NDH to represent multidisciplinary provider groups as directory entities so consumers can discover team-based programs and services and understand the practitioner and practitioner-role membership that supports coordinated care delivery; it adds extensions for location and endpoint references, verification, artifact description, and effective period, and uses ValueSet-constrained group coding to standardize program/service classification.

NDH HealthcareService Profile

This profile enables NDH to represent healthcare and community services in a consistent, searchable way so consumers can identify what is offered, where and how it is delivered, and who can access it; it adds extensions for ratings, new-patient intake, delivery method, funding, required documents, network linkage, and verification, and strengthens interoperability with ValueSet-constrained categories, types, specialties, provision conditions, eligibility codes, and programs.

NDH InsurancePlan Profile

This profile enables NDH to publish normalized insurance product and plan details, including coverage, network relationships, and administration, so users can compare options and accurately match plans to participating providers and service areas; it adds verification and identifier-status extensions and uses ValueSet bindings to normalize product type, coverage type, benefit type, and plan type classifications.

NDH Location Profile

This profile enables NDH to define service locations with consistent operational and geographic details so consumers can accurately discover where care is delivered, understand access characteristics, and link locations to organizations, services, and endpoints; it adds extensions for geospatial boundaries, accessibility, new-patient status, and verification, and applies ValueSet constraints for status, mode, location type, address use and type, state, and days-of-week availability.

NDH Network Profile

This profile enables NDH to represent payer and provider network structures as computable directory data so users can determine network participation, geographic coverage, and organizational relationships that affect access and coverage decisions; it adds extensions for coverage-area references, organization period, and verification, and uses ValueSet bindings to standardize network type and key identifier semantics.

NDH Organization Profile

This profile enables NDH to publish authoritative organizational identities, attributes, and contact channels so directory consumers can verify entities, understand what they offer, and connect organizations to plans, networks, services, and exchange endpoints; it adds extensions for ratings, funding, accepted payments, organization description, insurance-plan linkage, CMS-alignment indicators, verification, logos, and alias metadata, and applies ValueSet constraints for organization type and state/address semantics.

NDH OrganizationAffiliation Profile

This profile enables NDH to describe formal affiliations between organizations in a computable way so consumers can understand delegated services, shared networks, service locations, and endpoint relationships that drive referral and access pathways; it adds extensions for verification, and branding, and uses ValueSet bindings for affiliation role and specialty coding to improve consistent role interpretation across implementations.

NDH Practitioner Profile

This profile enables NDH to represent healthcare practitioners with verifiable identity and qualification details so consumers can discover, trust, and select individual professionals participating in care delivery and directory exchange; it adds extensions for endpoint references, accessibility, ratings, CMS-alignment indicators, verification, and communication proficiency, and applies ValueSet constraints and additional bindings for qualification, taxonomy, credential, and address-state semantics.

NDH PractitionerRole

This profile enables NDH to express how practitioners function within organizations, locations, services, and networks so users can understand role-specific participation and route patients to the right provider context for care and coverage; it adds extensions for ratings, new-patient intake, network references, and verification, and uses ValueSet bindings for practitioner-role and specialty coding to support consistent downstream matching and routing.

NDH Verification

This profile enables NDH to capture verification provenance, status, and timing for directory data so consumers can assess trust, recency, and validation method when making decisions based on published provider, organization, and role information; it adds CMS-focused verification extensions and applies ValueSet bindings for validation type, process, primary-source type, and communication method to normalize attestation workflows.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

NDH Accessibility

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.

NDH Age Group

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.

NDH Age Range

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.

NDH Aligned with CMS Data Network

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.

NDH Associated Servers

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.

NDH CMS Enrollment In Good Standing

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.

NDH CMS IAL2 Verified

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.

NDH Communication Proficiency

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.

NDH Delivery Method

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.

NDH Dynamic Registration

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.

NDH Endpoint Access Control Mechanism

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.

NDH Endpoint EnvironmentType

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.

NDH Endpoint IHE Specific Connection Type

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.

NDH Endpoint Rank

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.

NDH Endpoint Reference

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.

NDH Endpoint Testing Certification

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.

NDH Funding Source

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.

NDH HealthcareService or Program Requirement

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.

NDH Identifier Status

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.

NDH Implementation Guide Supported

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.

NDH InsurancePlan Reference

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.

NDH Language Speak

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.

NDH Location Reference

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.

NDH Logo

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.

NDH Network Reference

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.

NDH New Patients

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.

NDH New Patients Characteristics

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.

NDH Org Description

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.

NDH Organization Alias Period

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.

NDH Organization Alias Type

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.

NDH Payment Accepted

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.

NDH Practitioner Qualification Scope where valid and status

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.

NDH 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.

NDH Rating Details

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.

NDH Required Document

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.

NDH Secure Exchange Artifacts

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.

NDH Security Details

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.

NDH Verification Status

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.

Service Offered for a Group

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.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Accepting Patients Codes Value Set

This value set defines NDH concepts used to represent whether a practice, service, or role is accepting new patients.

Accessibility Value Set

This value set defines NDH accessibility accommodation categories used to describe available access-support options across directory records.

Age Range Value Set

This value set defines NDH age-group concepts used to represent age-based eligibility or targeting criteria in directory data.

Associated Servers Type Value Set

This value set defines associated-server type concepts used to classify companion or supporting server roles linked to NDH endpoints.

Benefit Type Value Set

This value set defines insurance benefit-type concepts used to classify covered services and benefit categories for plan comparison and eligibility interpretation.

Employment Status Value Set

This value set defines employment-status concepts used by NDH to represent an individual's current employment situation in a standardized form.

Endpoint Access Control Mechanism Value Set

This value set defines endpoint access-control mechanism concepts used to declare authentication and authorization approaches for secure exchange.

Endpoint Connection Types Value Set

This value set defines endpoint connection-type concepts for NDH endpoints by combining core, IHE, and NDH supplemental connection semantics.

Endpoint FHIR Mimetype Value Set

This value set defines permitted FHIR MIME-type representations used to declare supported FHIR serialization formats for endpoint exchange.

Endpoint IHE Specific Connection Types Value Set

This value set defines IHE-specific endpoint connection-type concepts used when exchange needs are more specific than general connection-type codes.

Endpoint Payload Type Value Set

This value set defines NDH endpoint payload-type constraints and, in this guide, intentionally limits payload typing to the not-applicable designation.

Endpoint Testing Method Value Set

This value set defines endpoint testing-method concepts used to represent how endpoint validation, conformance, or certification evidence was established.

FaCeT Organizational Credential Properties Value Set

This value set defines FaCeT organizational credential concepts used to represent standardized accreditation, certification, and related organizational credential terms in NDH content.

FaCeT Practitioner Credential Properties Value Set

This value set defines FaCeT practitioner credential concepts used to represent standardized practitioner credentials and related qualification terms in NDH content.

Healthcare Service Category Value Set

This value set defines broad healthcare-service category concepts used to classify the general type of services being provided or offered.

Healthcare Service Eligibility Code Value Set

This value set defines healthcare-service eligibility concepts, drawing from condition and procedure value sets to represent qualification criteria for service access.

HealthcareService Type Value Set

This value set defines detailed healthcare-service type concepts used to classify specific clinical, social, and support services in NDH directory exchange.

Identifier Status Value Set

This value set defines identifier-status concepts used to communicate lifecycle state and operational validity of identifiers in directory records.

Individual Qualifications Value Set

This value set defines individual healthcare qualification concepts from the NUCC Provider Taxonomy, including specialties, degrees, licenses, and certifications relevant to individual practitioners. It intentionally excludes grouping-level and non-individual organization categories (for example agencies, facilities, hospitals, laboratories, managed care organizations, suppliers, and transportation services) to keep the expansion aligned to individual practitioner use.

Individual Specialties, Degrees, Licenses, and Certificates Value Set

This value set defines individual specialty, degree, license, and certificate concepts by combining specialty and healthcare taxonomy sources for richer credential representation.

Individual Specialty Value Set

This value set defines individual specialty concepts used to represent practitioner specialty designations in a consistent coded format.

Insurance Status Value Set

This value set defines insurance-status concepts used by NDH to communicate whether coverage is insured, uninsured, or underinsured.

NDH Care Team Category Value Set

This value set defines NDH care-team category concepts used to classify the primary coordination focus of a care team in directory exchange.

NDH Endpoint Environment Value Set

This value set defines NDH endpoint environment concepts used to distinguish production and non-production endpoint deployment contexts.

NDH Example Rating Type Value Set

Example value set for rating types

NDH Verification Process Value Set

This value set defines verification-process concepts used by NDH to identify how directory information was verified or attested.

NDH Verification Status Value Set

This value set defines NDH verification-status concepts used to communicate whether verification is complete, incomplete, or not required.

NDH endpoint Implementation Guide Value Set

This value set defines implementation-guide use-case concepts used to indicate which interoperability guides and exchange scenarios an endpoint supports.

Network Type Value Set

This value set defines the network-type designation used to classify NDH network entities distinctly from general organization categories.

Organization Alias Type Value Sete

This value set defines organization-alias type categories used to distinguish how alternate organization names are used in directory contexts.

Organization Type Value Set

This value set defines organization-type categories used to classify directory organizations by role and function while excluding network-only typing.

OrganizationAffiliation Roles

This value set defines organization-affiliation role concepts, combining HL7 and HIE-oriented role sources to classify affiliation relationships consistently.

PractitionerRole Code Value Set

This value set defines practitioner-role capability concepts used to classify professional and network participation functions, including NDH role codes for payer-directory use.

Qualification Status Value Set

This value set defines qualification-status concepts used to indicate whether a credential or qualification is currently valid.

Secure Exchange Artifacts Value Set

This value set defines secure-exchange artifact type concepts used to categorize certificates and related trust artifacts for endpoint interoperability.

Specialties, Degrees, Licenses, and Certificates Value Set

This value set defines specialty, degree, license, and certificate concepts by combining credentialed-care, provider taxonomy, and degree/license/certificate sources.

Trust Framework Type Value Set

This value set defines trust-framework type concepts used to identify the governance and policy network under which exchange trust is established.

Trust Profile Value Set

This value set defines trust-profile concepts used to indicate the registration and authorization profile family governing endpoint interaction.

Virtual Modalities Value Set

This value set defines virtual service-delivery modality concepts used to describe how services are delivered through remote or digital channels.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CodeSystem properties for FaCeT Organizational Credential

This code system defines metadata property codes for FaCeT organizational credentials, including credential category, issuer details, credential type, credential URL, retirement status, and CMS deeming-recognition indicator.

CodeSystem properties for FaCeT Practitioner Credentials

This code system defines metadata property codes for FaCeT practitioner credentials, including credentialing organization, source URL, descriptive text, and boolean indicators for multisource, clinical, and board-certification status.

Endpoint Access Control Mechanism Code System

This code system defines endpoint access-control mechanism concepts for NDH exchange, enabling consistent declaration of authentication and authorization approaches used to protect endpoint access.

Endpoint Connection Types (additional) Code System

This code system provides NDH-specific supplemental endpoint connection-type codes that extend the core HL7 endpoint-connection-type code system when additional connection semantics are needed.

FaCeT Credential Code System

This code system defines FaCeT practitioner credential concepts and associated properties used to publish normalized credential abbreviations, definitions, issuing-organization context, and classification attributes.

FaCeT Organizational Credential Code System

This code system defines FaCeT organizational credential concepts and associated properties used to publish normalized organizational accreditation and certification identifiers with issuer and lifecycle metadata.

Insurance Benefit Type Code System

This code system defines detailed insurance benefit-type and coverage-quantity concepts used to classify covered services, benefit dimensions, and plan-level coverage structures in a consistent computable format.

NDH Age Range Code System

This code system defines normalized NDH age-group categories used to represent age-range eligibility or targeting criteria in a consistent, computable format across directory content.

NDH Associated Servers Type Code System

This code system defines NDH associated-server type concepts used to characterize supporting or companion server roles linked to a published endpoint.

NDH Direct Trust Endpoint Usecase Code System

This code system defines NDH Direct Trust endpoint use-case concepts covering exchange participants, business workflows, and operational communication patterns to support precise endpoint-purpose declaration.

NDH Endpoint Environment Code System

This code system defines endpoint environment classifications for NDH publication, enabling consistent differentiation of production, staging, development, test, and training endpoints.

NDH Example Rating Type Code System

Example code system for rating types

NDH FHIR Endpoint Use Case Code System

This code system defines NDH FHIR endpoint use-case concepts so endpoint capabilities can be tagged to specific interoperability workflows such as patient access, prior authorization, and payer exchange.

NDH Insurance Status Code System

This code system defines normalized NDH insurance-coverage status concepts so implementations can consistently communicate whether coverage is present, absent, or insufficient.

NDH Practitioner Role Codes Code System

This code system defines NDH practitioner role concepts used to classify professional function, participation type, and network-related responsibilities for practitioners and related entities.

NDH Resource Instance Verification Status Code System

This code system defines NDH resource-instance verification status concepts used to communicate whether verification is complete, incomplete, or not required.

NDH Secure Exchange Artifacts Code System

This code system defines NDH secure-exchange artifact types, including certificate categories used to establish trust, identity, signing, and encryption context for interoperable endpoint exchange.

NDH Trust FrameworkType Code System

This code system defines NDH trust-framework type concepts so implementations can declare the policy and governance network under which exchange trust relationships operate.

NDH Trust Profile Code System

This code system defines NDH trust-profile concepts that identify the registration and authorization profile family governing secure exchange behavior.

Ndh Endpoint Testing Method Code System

This code system defines endpoint testing method concepts used by NDH to represent how endpoint conformance, certification, or validation evidence was produced.

Ndh Organization Type Code System

This code system defines NDH organization-type categories used to classify directory entities by organizational role and operational context within provider directory exchanges.

Terminology: Structure Maps

These define transformations to convert between data structures used by systems conforming to this implementation guide.

This StructureMap defines the mapping from Plan-Net Endpoint to NDH Endpoint.

This StructureMap defines the mapping from Plan-Net Endpoint to NDH Endpoint.

This StructureMap defines the mapping from Plan-Net HealthcareService to NDH HealthcareService.

This StructureMap defines the mapping from Plan-Net HealthcareService to NDH HealthcareService.

This StructureMap defines the mapping from Plan-Net InsurancePlan to NDH InsurancePlan.

This StructureMap defines the mapping from Plan-Net InsurancePlan to NDH InsurancePlan.

This StructureMap defines the mapping from Plan-Net Location to NDH Location.

This StructureMap defines the mapping from Plan-Net Location to NDH Location.

This StructureMap defines the mapping from Plan-Net Network to NDH Network.

This StructureMap defines the mapping from Plan-Net Network to NDH Network.

This StructureMap defines the mapping from Plan-Net Organization to NDH Organization.

This StructureMap defines the mapping from Plan-Net Organization to NDH Organization.

This StructureMap defines the mapping from Plan-Net OrganizationAffiliation to NDH OrganizationAffiliation.

This StructureMap defines the mapping from Plan-Net OrganizationAffiliation to NDH OrganizationAffiliation.

This StructureMap defines the mapping from Plan-Net Practitioner to NDH Practitioner.

This StructureMap defines the mapping from Plan-Net Practitioner to NDH Practitioner.

This StructureMap defines the mapping from Plan-Net PractitionerRole to NDH PractitionerRole.

This StructureMap defines the mapping from Plan-Net PractitionerRole to NDH PractitionerRole.

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

Plan-Net to NDH Accepting Patients ConceptMap

Maps Plan-Net Accepting Patients codes to NDH Accepting Patients codes used from THO.

This ConceptMap should not be needed, but Plan-Net replicates the codeSystem that is in THO. FHIR-57456 requests Plan-Net change. If that is done, then this ConceptMap should be retired.

Plan-Net to NDH Accessibility ConceptMap

Maps Plan-Net Accessibility codes to NDH Accessibility codes used from THO.

This ConceptMap should not be needed, but Plan-Net replicates the codeSystem that is in THO. FHIR-57630 requests Plan-Net change. If that is done, then this ConceptMap should be retired.

Plan-Net to NDH Delivery Method ConceptMap

Maps Plan-Net Delivery Method codes to NDH Delivery Method codes used from THO.

This ConceptMap should not be needed, but Plan-Net replicates the codeSystem that is in THO. FHIR-57631 requests Plan-Net change. If that is done, then this ConceptMap should be retired.

Plan-Net to NDH Endpoint Connection Type ConceptMap

Maps Plan-Net Endpoint connection type codes to NDH Endpoint connection type codes.

Plan-Net to NDH Healthcare Service Category ConceptMap

Maps Plan-Net HealthcareService category codes to NDH healthcare service category codes.

Plan-Net to NDH Insurance Product Type ConceptMap

Maps Plan-Net Insurance Product Type codes to NDH Insurance Product Type codes used from THO.

This ConceptMap should not be needed, but Plan-Net replicates the codeSystem that is in THO. FHIR-57453 requests Plan-Net change. If that is done, then this ConceptMap should be retired.

Plan-Net to NDH Organization Type ConceptMap

Maps Plan-Net organization type codes to NDH organization and network type codes.

Plan-Net to NDH OrganizationAffiliationRole ConceptMap

Maps Plan-Net OrganizationAffiliation role codes to NDH OrganizationAffiliation role codes.

Plan-Net to NDH PractitionerRole ConceptMap

Maps Plan-Net PractitionerRole codes to NDH PractitionerRole codes.

Plan-Net to NDH Virtual Modalities ConceptMap

Maps Plan-Net Virtual Modalities codes to NDH Virtual Modalities codes used from THO.

This ConceptMap should not be needed, but Plan-Net replicates the codeSystem that is in THO. FHIR-57634 requests Plan-Net change. If that is done, then this ConceptMap should be retired.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Acme

Payer Organization

Acme EHR Server Endpoint

An example of an Endpoint that represents an EHR FHIR Server endpoint that has testing certification.

AcmeOfCTPortalEndpoint

Endpoint for Acme of CT Portal

AcmeQHPBronze

Acme of CT QHP Bronze Plan

AcmeQHPGold

Acme of CT QHP Gold Plan

AcmeofCTPremNet

Acme of CT Premium Premium Network

AcmeofCTStdNet

Acme of CT Standard Network

Backport Subscription for Practitioner Qualification Change

Topic-based 'Practitioner Qualification Change' subscription.

BigBox

Organization that Manages 2 of PharmChain's pharmacies

BlueCrossBlueShield-CT

Blue Cross Blue Shield of Connecticut

BlueCrossBlueShield-CT-ORG

Organization Manage Blue Cross Blue Shield of Connecticut PPO Network

BlueCrossBlueShield-CT-PPO

Blue Cross Blue Shield of Connecticut PPO Network

BurrClinic

Burr Clinic provides service to Hartford Hospital

BurrClinicAffil

Burr Clinic's affiliation with Acme of CT Provider Network and Hartford General Hospital

BurrClinicServices

Burr Clinic Services

CoordinationOfCareEndpoint

Endpoint for Coordination of Care

DirectTrustEndpointAdtNotifications

Endpoint for DirectTrust

DirectTrustEndpointReferrals

Endpoint for DirectTrust

Example Behavioral Health Group

This is a group of practitioners that provide behavioral health services to patients at the Burr Clinic.

Example Rated Hospital

Example Hospital organization with ratings

Example-license

Example license

HamiltonClinic

Hamilton Clinic (a Division of Hartford Hospital)

HansSolo

Solo Practitioner Hans Solo

HansSoloClinic

Location of Hans Solo's clinic

HansSoloDirectTrustEndpointReferrals

Hans Solo Endpoint for DirectTrust

HansSoloPatientAccessEndpoint

Hans Solo Endpoint for Patient Access

HansSoloRole

Solo practitioner practice in his own clinic

HansSoloRole2

Solo practitioner has privileges at a hospital

HansSoloService

Hans Solo Services

HartfordOrthopedicServices

Hartford Orthopedic Services

HartfordOrthopedics

Hartford Orthopedic Services is a group providing Orthopods for Acme of CT at Hartford General Hospital

HealthcareService-Social-Hope-CBO

HOPE INC Healthcare Service

HealthcareService-Social-Towson-Food

Towson Healthcare Service

HealthcareServiceHomelessAssistance

Healthcare Service for Homeless Assistance

HospLoc1

Location1 of Hartford Hospital

HospLoc2

Location2 of Hartford Hospital

Hospital

Hartford General Hospital

IheEndpoint

Endpoint for IHE

JoeSmith

Practitioner Dr Joe Smith

JoeSmithHospitalRole

Dr Smith Internal Medicine at Hartford General Hospital

JoeSmithRole2

Dr Smith Internal Medicine at Burr Clinic

Location-Social-Hope-CBO

HOPE FOOD DISPENSARY

Location-Social-Towson-Food

Towson Food INC

LocationGen1

NdhLocation LocationGen1

LocationGen2

NdhLocation LocationGen2

LocationWelcomeHome

Location for Welcome Home

MedicareAdvantage

Medicare Advantage Plan

MedicareAdvantageHMO

Medicare Advantage HMO

Network1

Network1

Network2

Network2

NetworkGen1

NdhNetwork NetworkGen1

NetworkGen2

NdhNetwork NetworkGen2

OrgHousingAssistanceHubManagement

Organization that manages the Housing Assistance Hub

OrgManageNetwork

Organization Manage Payer Network

OrgOneNetwork1Affiliation

Organization Affiliation for OrgOne in Network1

OrgOneNetwork2Affiliation

Organization Affiliation for OrgOne in Network2

OrgOneWithNetwork1AndNetwork2

Organization participating in Network1 and Network2

Organization-Social-Hope-CBO

A food dispensary entity

Organization-Social-Towson-Food

A food dispensary entity

OrganizationGen1

NdhOrganization OrganizationGen1

OrganizationGen2

NdhOrganization OrganizationGen2

OrganizationStateMedicaidAgencyAlabama

State Medicaid Agency Alabama

OrganizationWelcomeHome

Organization for Welcome Home (Homeless Assistance)

Parameters - US SNOMED

Parameters - US SNOMED

PharmChain

Organization that Provides Pharmacy Services

PharmChainAffil1

Organization Affiliation for PharmChain (Retail)

PharmChainRetailService

Pharmacy Service provided by PharmChain

PharmLoc1

Location of Pharmacy1 in PharmChain's network

PharmLoc2

Location of Pharmacy2 in PharmChain's network

PharmLoc3

Location of Pharmacy3 in PharmChain's network

PharmLoc4

Location of Pharmacy4 in PharmChain's network

PractitionerOneNetwork1Role

PractitionerOne Network 2023 PractitionerRole

PractitionerOneNetwork2Role

PractitionerOne Network 2024 PractitionerRole

PractitionerOneWithNetwork1AndNetwork2

Practitioner1 with Network1 and Network2

PractitionerTwoNetwork1LeftAfterSixMonthRole

PractitionerTwo Network 2023 First Six Months PractitionerRole

PractitionerTwoWithNetwork1LeftAfterSixMonths

Practitioner2 with Network 2023 for first six months

SocialServiceHousingNetwork

Hub for Social Service Housing

StateOfCTLocation

State of CT Area

StateOfIllinoisLicBoard

State of Illinois Licensing Board

Verify-Hospital

Verify Hartford General Hospital

Verify-Hospital-2

Verify Hartford General Hospital

Verify-JoeSmith

Verify Practitioner Joe Smith

Verify-JoeSmith-2

Verify Practitioner Joe Smith

Verify-JoeSmithHospitalRole

Verify Joe Smith's role at Hartford General Hospital

location-bundle

All location resources