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

NDH Search Parameters

Page standards status: Normative

To facilitate efficient data retrieval and standardized querying from the NDH, a series of search parameters have been defined:

EndpointAccessControlMechanismSearchParameter

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

EndpointDynamicRegistrationTrustProfileSearchParameter

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

EndpointIheConnectionTypeSearchParameter

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.

EndpointSecurityDetailsSearchParameter

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

GroupServiceOfferedSearchParameter

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

HealthcareServiceEligibilitySearchParameter

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

HealthcareServiceLocationSearchParameter

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

HealthcareServiceNetworkSearchParameter

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

HealthcareServiceNewPatientAndFromNetworkSearchParameter

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

HealthcareServiceNewPatientFromNetworkSearchParameter

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.

HealthcareServiceNewPatientSearchParameter

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

HealthcareServiceOrganizationSearchParameter

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

HealthcareServiceProgramRequirementAgeGroupSearchParameter

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.

HealthcareServiceProgramRequirementBirthsexSearchParameter

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.

HealthcareServiceProgramRequirementEmploymentStatusSearchParameter

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.

HealthcareServiceProgramRequirementInsuranceStatusSearchParameter

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

HealthcareServiceProgramRequirementPreferredLanguageSearchParameter

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

HealthcareServiceProgramRequirementVaStatusSearchParameter

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

HealthcareServiceSocialServiceAgeGroupSearchParameter

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.

HealthcareServiceSocialServiceBirthsexSearchParameter

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.

HealthcareServiceSocialServiceEmploymentStatusSearchParameter

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.

HealthcareServiceSocialServiceInsuranceStatusSearchParameter

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

HealthcareServiceSocialServicePreferredLanguageSearchParameter

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

HealthcareServiceSocialServiceVaStatusSearchParameter

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

InsuranceCoverageAreaSearchParameter

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

InsuranceplanCoverageBenefitTypeSearchParameter

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

InsuranceplanCoverageNetworkSearchParameter

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

InsuranceplanCoverageTypeSearchParameter

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

InsuranceplanPlanNetworkSearchParameter

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

InsuranceplanPlanNetworkSearchParameter

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

InsuranceplanPlanTypeSearchParameter

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

LocationAccessibilitySearchParameter

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

LocationContainsSearchParameter

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.

NetworkCoverageAreaSearchParameter

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

OrganizationAffiliationLocationSearchParameter

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

OrganizationAffiliationParticipatingOrganizationSearchParameter

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

OrganizationAffiliationPrimaryOrganizationSearchParameter

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

PractitionerEndpointSearchParameter

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

PractitionerQualificationCodeSearchParameter

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

PractitionerQualificationIssuerSearchParameter

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

PractitionerroleLocationSearchParameter

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

PractitionerroleNetworkSearchParameter

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

PractitionerroleNewPatientFromNetworkSearchParameter

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

PractitionerroleNewPatientSearchParameter

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

PractitionerroleOrganizationSearchParameter

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

VerificationStatusSearchParameter

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.

VerificationResultAttestationWhoSearchParameter

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

VerificationResultPrimarysourceTypeSearchParameter

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

VerificationResultPrimarysourceValidationStatusSearchParameter

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

VerificationResultPrimarysourceWhoSearchParameter

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

VerificationResultStatusSearchParameter

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

VerificationResultTargetSearchParameter

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