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

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 | This Section describes the expected capabilities of the NDH Server which is responsible for providing responses to the queries submitted by the NDH Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NDH Servers are defined. NDH 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 | Scheduled NDH Export Operation

### 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 | Select Endpoints that support the type of services indicated by a specific access-control-mechanism
Endpoint dynamic-registration-trust-profile | Select Endpoints that support the type of services indicated by a specific dynamic-registration-trust-profile
Endpoint ihe-connection-type | Select Endpoints that support the type of services indicated by a specific ihe-connection-type
Endpoint trust-framework-type | Select Endpoints that support the type of services indicated by a specific trust-framework-type
HealthcareService eligibility | Select HealthcareService with the specified eligibility
HealthcareService location | Select HealthcareService with the specified location
HealthcareService network | Select HealthcareService with the specified network
HealthcareService new patient | Select HealthcareService with the specified new patient
HealthcareService new patient from network | Select HealthcareService with the specified new patient from network
HealthcareService organization | Select HealthcareService with the specified organization
HealthcareService program requirement age group | Select HealthcareService with the specified program requirement age group
HealthcareService program requirement birthsex | Select HealthcareService with the specified program requirement birthsex
HealthcareService program requirement employment status | Select HealthcareService with the specified program requirement employment status
HealthcareService program requirement insurance status | Select HealthcareService with the specificed program requirement insurance status
HealthcareService program requirement preferred language | Select HealthcareService with the specified program requirement preferred language
HealthcareService program requirement va status | Select HealthcareService with the specified program requirement va status
HealthcareService social service requirement age group | Select HealthcareService with the specified social service requirement age group
HealthcareService social service requirement birthsex | Select HealthcareService with the specified social service requirement birthsex
HealthcareService social service requirement employment status | Select HealthcareService with the specified social service requirement employment status
HealthcareService social service requirement insurance status | Select HealthcareService with the specified social service requirement insurance status
HealthcareService social service requirement preferred language | Select HealthcareService with the specified social service requirement preferred language
HealthcareService social service requirement va status | Select HealthcareService with the specified social service requirement va status
Healthcareservice new-patient-and-from-network | Select Healthcareservice of the specified new-patient and from-network
InsurancePlan coverage-area | Select products that are offered in the specified location
InsurancePlan coverage-benefit-type | Select products that are offered in the specified coverage-benefit-type
InsurancePlan coverage-network | Select products offering covered benefits through the specified coverage network
InsurancePlan coverage-type | Select products that are offered in the specified coverage-type
InsurancePlan network | Select products that are offered in the specified network
InsurancePlan plan-network | Select products that are offered in the specified plan-network
InsurancePlan plan-type | Select products that are offered in the specified plan-type
Location accessibility | Select Locations of the specified accessibility
Location contains | Select Locations of the specified contains (co-ordinates)
Network coverage-area | Select health insurance provider networks available in a region described by the specified location. This search parameter is for the NDH Network Profile Resource only.
OrganizationAffiliation location | Select OrganizationAffiliation with the specified location
OrganizationAffiliation participating organization | Select OrganizationAffiliation with the specified participating organization
OrganizationAffiliation primary organization | Select OrganizationAffiliation with the specified primary organization
OrganizationAffiliation via-intermediary | Select OrganizationAffiliation of the specified via-intermediary
Practitioner endpoint | Select Practitioner with the specified endpoint
Practitioner qualification-code | Select Practitioner with a type of qualification matching the specific code
Practitioner qualification-issuer | Select Practitioners with a qualification issued by the specified organization
PractitionerRole location | Select roles where the practitioner location
PractitionerRole network | Select roles where the practitioner is a member of the specified health insurance provider network
PractitionerRole new-patient | Select roles where the practitioner new-patient
PractitionerRole new-patient-from-network | Select roles where the practitioner new-patient-from-network
PractitionerRole organization | Select roles where the practitioner organization
VerificationResult attestation-who | Select validation information for data that was attested to by the specified individual or organization
VerificationResult primarysource-type | Select verification information for data that was verified against the specified primary source type
VerificationResult primarysource-validation-status | Select verification information for data that was verified against the specified primary source validationStatus
VerificationResult primarysource-who | Select verification information for data that was verified against the specified primary source who
VerificationResult status | Select verification information for data that was verified against the specified status
VerificationResult target | Select verification information for data that was verified against the specified target
verification-status | Select Resources by a specific verification-status

### Structures: Resource Profiles

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

NDH Endpoint Profile | The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging.
NDH Group | The NDH Group represents a group of multi-disciplinary providers organized around a specific healthcare program or service, not an individual patient. For example, a diabetic care team may include an endocrinologist, a diabetes educator, and a nutritionist.
NDH HealthcareService Profile | The HealthCareService resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnostics, pharmacy, hospital and ambulatory care, home care, long-term care, and other health-related and community services.
NDH InsurancePlan Profile | An InsurancePlan is a discrete package of health insurance coverage benefits that are offered under a particular network type. A given payer’s products typically differ by network type and/or covered benefits. A plan pairs a product’s covered benefits with the particular cost sharing structure offered to a consumer. A given product may comprise multiple plans (i.e. each plan offers different cost sharing requirements for the same set of covered benefits). InsurancePlan describes a health insurance offering comprised of a list of covered benefits (i.e. the product), costs associated with those benefits (i.e. the plan), and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc.
NDH Location Profile | A Location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.
NDH Network Profile | A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. In the NDH IG, individuals and organizations are represented as participants in a National Directory Exchange Network through the practitionerRole and National Directory Exchange-organizationAffiliation resources, respectively.
NDH Organization Profile | An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice. Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text
NDH OrganizationAffiliation Profile | The OrganizationAffiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information.
NDH Practitioner Profile | Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.
NDH PractitionerRole | PractitionerRole typically describes details about a provider. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services at a location. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization. PractitionerRole involves either the actual or potential (hence the optionality on Practitioner) of an individual to play this role on behalf of or under the auspices of an organization. The absence of a Practitioner resource does not imply that the Organization itself is playing the role of a Practitioner, instead it implies that role has been established by the Organization and MAY apply that to a specific Practitioner.
NDH Verification | Describes Verification requirements, source(s), status and dates for one or more elements

### Structures: Extension Definitions

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

NDH Accessibility | An extension to describe accessibility options offered by a practitioner or at a location.
NDH Age Group | Age Group
NDH Age Range | Age Range
NDH Associated Servers | This extension is designed to store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, the server's type and URL will be included. For example, if your system features two types of endpoints: a standard endpoint and a proxy endpoint associated with the server. For example, the proxy endpoint can be configured to interface with AEGIS software, allowing the software to record transactions and ensure compliance with pertinent standards or regulations. Implementing such a configuration in a production environment would offer the flexibility to switch between standard and proxy modes (associated server) as necessary. Consequently, it is essential to have both standard and proxy endpoints readily available for seamless transitions as required.
NDH Communication Proficiency | An extension to express a practitioner’s spoken proficiency with the language indicated in practitioner.communication.
NDH Contactpoint Availabletime | An extension representing the days and times a contact point is available
NDH Delivery Method | An extension describing the service delivery method. If service delivery is virtual, one or more delivery modalities should be specified.
NDH Dynamic Registration | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
NDH Endpoint Access Control Mechanism | Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems. They standardize methods to secure endpoints, ensuring interoperability and security. In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example, the Unified Data Access Profile (UDAP) uses JWT access tokens.
NDH Endpoint EnvironmentType | Endpoint Environment Type
NDH Endpoint IHE Specific Connection Type | Endpoint IHE Specific Connection Type. This is to be used when the connectionType cannot be used. Such as when the endpoint support is more specific than a code in the connectionType ValueSet.
NDH Endpoint Rank | Order established by a Role, Organization… for Endpoints capable of transferring the same content
NDH Endpoint Reference | The technical details of an endpoint that can be used for electronic services
NDH Endpoint Testing Certification | An extension for endpoint testing certification
NDH Funding Source | The sources of funding for a service or organization
NDH HealthcareService or Program Requirement | Service or Program requirement indicates whether the program is available to anyone, or only to those meeting certain criteria.
NDH Identifier Status | Describes the status of an identifier
NDH Implementation Guide Supported | Implementation Guide Supported, when the connectionType and EndpointIheSpecificConnectionType can't be used.
NDH InsurancePlan Reference | Reference insurance plans accepted by the organization.
NDH Language Speak | Language Speak
NDH Location Reference | A reference to a Location resource (NDH-Location) defining the coverage area of a health insurance provider network
NDH Logo | Logo
NDH Network Reference | A reference to the healthcare provider insurance networks (NdhNetwork) the practitioner participates in through their role
NDH New Patients | New Patients indicates whether new patients are being accepted in general, or from a specific network. This extension is included in the PractitionerRole, HealthcareService, and Location profiles. This provides needed flexibility for specifying whether a provider accepts new patients by location and network.
NDH New Patients Characteristics | Characteristics of accepted patients
NDH Org Description | An extension to provide a human-readable description of an organization
NDH Organization Alias Period | The period of time the organization alias was actively used
NDH Organization Alias Type | Type of organization alias (legal alternative, historical)
NDH Payment Accepted | Methods of payment that can be used for a healthcare service
NDH Practitioner Qualification | An extension to add status and whereValid elements to a practitioner’s qualifications.
NDH Qualification | An extension to add qualifications for an organization (e.g. accreditation) or practitionerRole (e.g. registered to prescribe controlled substances).
NDH Rating | Rating
NDH Rating Details | Rating Details
NDH Required Document | Documents that are required in order to access or use services (eg. Gov't issued ID, passport)
NDH Secure Exchange Artifacts | This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.
NDH Trust Framework | A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).
NDH Verification Status | Indicates a resource instance verification status
NDH Via Intermediary | A reference to an alternative point of contact (NdhPractitionerRole, NdhOrganization, NdhOrganizationAffiliation, or NdhLocation) for this organization

### Terminology: Value Sets

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

Accepting Patients Codes Value Set | Codes to identify if the practice is accepting new patients
Accessibility Value Set | Codes for documenting general categories of accommodations available
Age Range Value Set | Codes for documenting age range
Associated Servers Type Value Set | Associated Servers Type
Benefit Type Value Set | Codes for Insurance Benefit Type.
Employment Status Value Set | Codes for documenting employment status
Endpoint Access Control Mechanism Value Set | Codes for documenting access control mechanism
Endpoint Connection Types Value Set | Endpoint Connection Types
Endpoint FHIR Mimetype Value Set | Endpoint FHIR mimetype
Endpoint IHE Specific Connection Types Value Set | Endpoint IHE Specific Connection Types
Endpoint Payload Type Value Set | Endpoint Payload Types are constrained to NA (Not Applicable) as part of this IG
Endpoint Testing Method Value Set | Codes for documenting testing method
Healthcare Service Category Value Set | Broad categories of healthcare services being performed or delivered.
Healthcare Service Eligibility Code Value Set | Codes for Healthcare Service Eligibility Code
HealthcareService Type Value Set | HealthCareService type Value Set
Identifier Status Value Set | Codes for Identifier Status
Individual Specialties, Degrees, Licenses, and Certificates Value Set | Individual Specialties, Degrees, Licenses, and Certificates
Individual and Group Specialties | Individual and Group Specialties from National Uniform Claim Committee (NUCC) Health Care Provider Taxonomy code set.
Insurance Status Value Set | Codes for documenting insurance status
NDH Endpoint Environment Value Set | Codes for NDH Endpoint Environment
NDH Verification Process Value Set | Codes for documenting verification process
NDH Verification Status Value Set | Codes for verification status
NDH endpoint Implementation Guide Value Set | NDH endpoint Implementation Guide Value Set of supported IGs
Network Type Value Set | Single value describing networks.
Organization Alias Type Value Sete | Categories of an organization's Alias based on criteria in provider directories.
Organization Type Value Set | Categories of organizations based on criteria in provider directories.
OrganizationAffiliation Roles | Value Set for Organization Affiliation Roles
PractitionerRole Code Value Set | Codes for the capabilities that an individual, group, or organization is acknowledged to have in a payer network, including general codes from the HL7 PractitionerRole Code System
Qualification Status Value Set | The state indicating if a qualification is currently valid.
Secure Exchange Artifacts Value Set | Secure Exchange Artifacts
Specialties, Degrees, Licenses, and Certificates Value Set | Specialties and Degree License and Certificates
Trust Framework Type Value Set | Trust Framework Type
Trust Profile Value Set | Codes for documenting trust profile
Virtual Modalities Value Set | Codes for virtual service delivery modalities

### Terminology: Code Systems

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

Endpoint Access Control Mechanism Code System | Endpoint Access Control Mechanism
Endpoint Connection Types (additional) Code System | Extension codes for http://terminology.hl7.org/CodeSystem/endpoint-connection-type
Insurance Benefit Type Code System | Categories of insurance benefits.
NDH Age Range Code System | This code system includes codes for indicating the age range of a person.
NDH Associated Servers Type Code System | NDH Associated Servers Type
NDH Direct Trust Endpoint Usecase Code System | NDH Direct Trust Endpoint Usecase
NDH Endpoint Environment Code System | NDH Endpoint Environment
NDH FHIR Endpoint Use Case Code System | NDH FHIR Endpoint Use Case
NDH Insurance Status Code System | This code system includes codes for indicating the status of a person's insurance coverage.
NDH Practitioner Role Codes Code System | A capability that an individual, group, or organization is acknowledged to have in a payer network.
NDH Resource Instance Verification Status Code System | NDH Resource Instance Verification Status
NDH Secure Exchange Artifacts Code System | NDH Secure Exchange Artifacts
NDH Trust FrameworkType Code System | Trust Framework Type
NDH Trust Profile Code System | Trust Profile
Ndh Endpoint Testing Method Code System | Endpoint Testing Method
Ndh Organization Type Code System | Categories of organizations based on criteria in provider directories.

### 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
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-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
aGroup | A group of practitioners
location-bundle | All location resources