National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot 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 1.0.0-ballot 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

CapabilityStatement: National Directory API Base Server Capability Statement

Official URL: http://hl7.org/fhir/us/ndh/CapabilityStatement/national-directory-api-base-server Version: 1.0.0-ballot
Active as of 2022-11-01 Computable Name: NationalDirectoryApiBaseServerCapabilityStatement

This Section describes the expected capabilities of the NDH Server actor 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.

Raw OpenAPI-Swagger Definition file | Download


General

Supported FHIR Version: 4.0.1
Supported exchange formats: xml, json

Jump to:


REST Server behavior

National Directory API Base Server


Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Endpoint SHALL SHALL SHALL SHALL SHALL
CareTeam SHOULD SHOULD SHOULD SHOULD SHOULD
HealthcareService SHOULD SHOULD SHOULD SHOULD SHOULD
InsurancePlan SHOULD SHOULD SHOULD SHOULD SHOULD
Location SHALL SHALL SHALL SHALL SHALL
Organization SHALL SHALL SHALL SHALL SHALL
OrganizationAffiliation SHOULD SHOULD SHOULD SHOULD SHOULD
Practitioner SHALL SHALL SHALL SHALL SHALL
PractitionerRole SHALL SHALL SHALL SHALL SHALL
Consent
VerificationResult SHOULD SHOULD SHOULD SHOULD SHOULD
Subscription SHOULD SHOULD SHOULD

Operations:



Endpoint

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  read SHALL

Read the current state of the resource
  vread SHALL

Read the state of a specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Endpoint:organization

Supported Reverse-Includes: CareTeam:endpoint, HealthcareService:endpoint, InsurancePlan:endpoint, Location:endpoint, Organization:endpoint, OrganizationAffiliation:endpoint, Practitioner:endpoint, PractitionerRole:endpoint

Parameter Name Definition Conformance Type Description
usecase-type EndpointUsecaseTypeSearchParameter SHALL Token

Endpoint usecase type
nonfhir-usecase-type EndpointNonfhirUsecaseTypeSearchParameter SHALL Token

Endpoint nonfhir usecase type
trust-framework-type EndpointTrustFrameworkTypeSearchParameter SHALL Token

Endpoint trust framework type
dynamic-registration-trust-profile EndpointDynamicRegistrationTrustProfileSearchParameter SHALL Token

Endpoint dynamic registration trust profile
access-control-mechanism EndpointAccessControlMechanismSearchParameter SHALL Token

Endpoint access control mechanism
connection-type-version EndpointConnectionTypeVersionSearchParameter SHALL Token

Endpoint connection type version
ihe-connection-type EndpointIheConnectionTypeSearchParameter SHALL Token

Endpoint ihe connection type
verification-status EndpointVerificationStatusSearchParameter SHALL Token

Endpoint verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL Special

supports a more sophisticated grammar for searching
_id _id SHALL Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHALL Date/DateTime

Allows filtering for only records that have changed since last query.
connection-type connection-type SHALL Token

Connection type
identifier identifier SHALL Token

Endpoint identifier
organization organization SHALL Reference

Organization that manages the Endpoint
status status SHALL Token

Endpoint status


CareTeam

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  read SHOULD

Read the current state of the resource
  vread SHOULD

Read the state of a specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: CareTeam:location, CareTeam:organization, CareTeam:service

Parameter Name Definition Conformance Type Description
endpoint CareTeamEndpointSearchParameter SHOULD Reference

Endpoint of the CareTeam
location CareTeamLocationSearchParameter SHOULD Reference

Location of the CareTeam
organization CareTeamOrganizationSearchParameter SHOULD Reference

Organization of the CareTeam
service CareTeamServiceSearchParameter SHOULD Reference

Service of the CareTeam
name CareTeamNameSearchParameter SHOULD String

Name of the CareTeam
verification-status CareTeamVerificationStatusSearchParameter SHOULD Token

Verification status of the CareTeam
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD Special

supports a more sophisticated grammar for searching
_id _id SHOULD Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHOULD Date/DateTime

Allows filtering for only records that have changed since last query.
category category SHOULD Token

Type of team
participant participant SHOULD Reference

Who is involved
status status SHOULD Token

Status of the CareTeam


HealthcareService

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  read SHOULD

Read the current state of the resource
  vread SHOULD

Read the state of a specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: HealthcareService:coverage-area, HealthcareService:endpoint, HealthcareService:location, HealthcareService:new-patient-from-network, HealthcareService:organization

Supported Reverse-Includes: CareTeam:careteam-service, OrganizationAffiliation:service, PractitionerRole:service

Parameter Name Definition Conformance Type Description
new-patient-from-network HealthcareServiceNewPatientFromNetworkSearchParameter SHOULD Reference

New patient from network
eligibility HealthcareServiceEligibilitySearchParameter SHOULD Token

Eligibility
new-patient HealthcareServiceNewPatientSearchParameter SHOULD Token

New patient
verification-status HealthcareServiceVerificationStatusSearchParameter SHOULD Token

Verification status
network HealthcareServiceNetworkSearchParameter SHOULD Reference

Network
program-requirement-age-group HealthcareServiceProgramRequirementAgeGroupSearchParameter SHOULD Token

Program requirement age group
program-requirement-birthsex HealthcareServiceProgramRequirementBirthsexSearchParameter SHOULD Token

Program requirement birthsex
program-requirement-gender-identity HealthcareServiceProgramRequirementGenderIdentitySearchParameter SHOULD Token

Program requirement gender identity
program-requirement-employment-status HealthcareServiceProgramRequirementEmploymentStatusSearchParameter SHOULD Token

Program requirement employment status
program-requirement-insurance-status HealthcareServiceProgramRequirementInsuranceStatusSearchParameter SHOULD Token

Program requirement insurance status
program-requirement-va-status HealthcareServiceProgramRequirementVaStatusSearchParameter SHOULD Token

Program requirement va status
program-requirement-preferred-language HealthcareServiceProgramRequirementPreferredLanguageSearchParameter SHOULD Token

Program requirement preferred language
social-service-age-group HealthcareServiceSocialServiceAgeGroupSearchParameter SHOULD Token

Social service requirement age group
social-service-birthsex HealthcareServiceSocialServiceBirthsexSearchParameter SHOULD Token

Social service requirement birthsex
social-service-gender-identity HealthcareServiceSocialServiceGenderIdentitySearchParameter SHOULD Token

Social service requirement gender identity
social-service-employment-status HealthcareServiceSocialServiceEmploymentStatusSearchParameter SHOULD Token

Social service requirement employment status
social-service-insurance-status HealthcareServiceSocialServiceInsuranceStatusSearchParameter SHOULD Token

Social service requirement insurance status
social-service-va-status HealthcareServiceSocialServiceVaStatusSearchParameter SHOULD Token

Social service requirement va status
social-service-preferred-language HealthcareServiceSocialServicePreferredLanguageSearchParameter SHOULD Token

Social service requirement preferred language
location HealthcareServiceLocationSearchParameter SHOULD Reference

The location of the Healthcare Service
organization HealthcareServiceOrganizationSearchParameter SHOULD Reference

The organization that provides this Healthcare Service
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD Special

supports a more sophisticated grammar for searching
_id _id SHOULD Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHOULD Date/DateTime

Allows filtering for only records that have changed since last query.
active active SHOULD Token

Whether this HealthcareService record is in active use
coverage-area coverage-area SHOULD Reference

Location service is inteded for/available to
endpoint endpoint SHOULD Reference

Technical endpoints providing access to services operated for the location
identifier identifier SHOULD Token

External identifiers for this item
name name SHOULD String

A portion of the Healthcare service name
program program SHOULD Token

One of the Program Names that categorize the service
service-category service-category SHOULD Token

Service Category of the Healthcare Service
service-type service-type SHOULD Token

The type of service provided by this healthcare service
specialty specialty SHOULD Token

Specialties handled by the HealthcareService


InsurancePlan

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  read SHOULD

Read the current state of the resource
  vread SHOULD

Read the state of a specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: InsurancePlan:administered-by, InsurancePlan:endpoint, InsurancePlan:owned-by, InsurancePlan:coverage-area, InsurancePlan:coverage-network, InsurancePlan:plan-network, InsurancePlan:network

Parameter Name Definition Conformance Type Description
coverage-area InsuranceCoverageAreaSearchParameter SHOULD Reference

InsurancePlan coverage area
coverage-benefit-type InsuranceplanCoverageBenefitTypeSearchParameter SHOULD Token

InsurancePlan coverage benefit type
coverage-type InsuranceplanCoverageTypeSearchParameter SHOULD Token

InsurancePlan coverage type
coverage-network InsuranceplanCoverageNetworkSearchParameter SHOULD Reference

InsurancePlan coverage network
network InsuranceplanPlanNetworkSearchParameter SHOULD Reference

InsurancePlan network
plan-network InsuranceplanPlanNetworkSearchParameter SHOULD Reference

InsurancePlan plan network
plan-type InsuranceplanPlanTypeSearchParameter SHOULD Token

InsurancePlan plan type
verification-status InsuranceplanVerificationStatusSearchParameter SHOULD Token

Verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD Special

supports a more sophisticated grammar for searching
_id _id SHOULD Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHOULD Date/DateTime

Allows filtering for only records that have changed since last query.
address address SHOULD String

InsurancePlan contact address
address-city address-city SHOULD String

InsurancePlan contact address-city
address-country address-country SHOULD String

InsurancePlan contact address-country
address-postalcode address-postalcode SHOULD String

InsurancePlan contact address-postalcode
address-state address-state SHOULD String

InsurancePlan contact address-state
administered-by administered-by SHOULD Reference

InsurancePlan administered by
endpoint endpoint SHOULD Reference

InsurancePlan endpoint
identifier identifier SHOULD Token

InsurancePlan identifier
name name SHOULD String

InsurancePlan name
owned-by owned-by SHOULD Reference

InsurancePlan owned by
status status SHOULD Token

InsurancePlan status
type type SHOULD Token

InsurancePlan type


Location

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  read SHALL

Read the current state of the resource
  vread SHALL

Read the state of a specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Location:endpoint, Location:new-patient-from-network, Location:organization, Location:partof

Supported Reverse-Includes: CareTeam:location, HealthcareService:coverage-area, HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location

Parameter Name Definition Conformance Type Description
accessibility LocationAccessibilitySearchParameter SHALL Token

Location accessibility
contains LocationContainsSearchParameter SHALL Special

Location contains
new-patient-from-network LocationNewPatientFromNetworkSearchParameter SHALL Reference

Location new patient from network
new-patient LocationNewPatientSearchParameter SHALL Token

Location new patient
verification-status LocationVerificationStatusSearchParameter SHALL Token

Verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL Special

supports a more sophisticated grammar for searching
_id _id SHALL Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHALL Date/DateTime

Allows filtering for only records that have changed since last query.
address address SHALL String

Location address
address-city address-city SHALL String

Location address-city
address-country address-country SHALL String

Location address-country
address-postalcode address-postalcode SHALL String

Location address-postalcode
address-state address-state SHALL String

Location address-state
address-use address-use SHALL Token

Location address-use
endpoint endpoint SHALL Reference

Location endpoint
identifier identifier SHALL Token

Location identifier
name name SHALL String

Location name
near near SHALL Special

Location position
partof partof SHALL Reference

Location partof
organization organization SHALL Reference

Location organization
type type SHALL Token

Location type


Organization

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  read SHALL

Read the current state of the resource
  vread SHALL

Read the state of a specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Organization:endpoint, Organization:partof

Supported Reverse-Includes: CareTeam:organization, Endpoint:organization, Endpoint:identifier-assigner, HealthcareService:organization, HealthcareService:new-patient-from-network, InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-network, InsurancePlan:plan-network, InsurancePlan:network, Location:organization, Location:new-patient-from-network, OrganizationAffiliation:network, OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization, Practitioner:qualification-issuer, PractitionerRole:organization, PractitionerRole:network, PractitionerRole:new-patient-from-network

Parameter Name Definition Conformance Type Description
coverage-area NetworkCoverageAreaSearchParameter SHALL Reference

network organization type is needed for searching network coverage area
verification-status OrganizationVerificationStatusSearchParameter SHALL Token

Verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL Special

supports a more sophisticated grammar for searching
_id _id SHALL Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHALL Date/DateTime

Allows filtering for only records that have changed since last query.
active active SHALL Token

Organization active
address address SHALL String

Organization address
address-city address-city SHALL String

Organization address-city
address-country address-country SHALL String

Organization address-country
address-postalcode address-postalcode SHALL String

Organization address-postalcode
address-state address-state SHALL String

Organization address-state
address-use address-use SHALL Token

Organization address-use
endpoint endpoint SHALL Reference

Organization endpoint
identifier identifier SHALL Token

Organization identifier
name name SHALL String

Organization name
partof partof SHALL Reference

Organization partof
type type SHALL Token

Organization type


OrganizationAffiliation

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type
  read SHOULD

Read the current state of the resource
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  vread SHOULD

Read the state of specific version of the resource

Search

Supported Includes: OrganizationAffiliation:network, OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization

Parameter Name Definition Conformance Type Description
location OrganizationAffiliationLocationSearchParameter SHOULD Reference

OrganizationAffiliation location
participating-organization OrganizationAffiliationParticipatingOrganizationSearchParameter SHOULD Reference

OrganizationAffiliation participating-organization
primary-organization OrganizationAffiliationPrimaryOrganizationSearchParameter SHOULD Reference

OrganizationAffiliation primary-organization
verification-status OrganizationAffiliationVerificationStatusSearchParameter SHOULD Token

Verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD Special

supports a more sophisticated grammar for searching
_id _id SHOULD Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHOULD Date/DateTime

Allows filtering for only records that have changed since last query.
endpoint endpoint SHOULD Reference

OrganizationAffiliation endpoint
identifier identifier SHOULD Token

OrganizationAffiliation identifier
network network SHOULD Reference

OrganizationAffiliation network
role role SHOULD Token

OrganizationAffiliation role
service service SHOULD Reference

OrganizationAffiliation service
specialty specialty SHOULD Token

OrganizationAffiliation specialty


Practitioner

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  read SHALL

Read the current state of the resource
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  vread SHALL

Read the state of specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Practitioner:endpoint, Practitioner:qualification-issuer

Supported Reverse-Includes: PractitionerRole:practitioner

Parameter Name Definition Conformance Type Description
endpoint PractitionerEndpointSearchParameter SHALL Reference

Practitioner endpoint
qualification-issuer PractitionerQualificationIssuerSearchParameter SHALL Reference

Practitioner qualification issuer
qualification-code PractitionerQualificationCodeSearchParameter SHALL Token

Practitioner qualification code
verification-status PractitionerVerificationStatusSearchParameter SHALL Token

Verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL Special

supports a more sophisticated grammar for searching
_id _id SHALL Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHALL Date/DateTime

Allows filtering for only records that have changed since last query.
active active SHALL Token

Whether this practitioner's record is in active use
name name SHALL String

A portion of either family or given name of the practitioner
gender gender SHALL Token

Practitioner gender
identifier identifier SHALL Token

A practitioner's Identifier


PractitionerRole

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  read SHALL

Read the current state of the resource
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  vread SHALL

Read the state of specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:network, PractitionerRole:new-patient-from-network, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service

Parameter Name Definition Conformance Type Description
network PractitionerroleNetworkSearchParameter SHALL Reference

PractitionerRole network
new-patient PractitionerroleNewPatientSearchParameter SHALL Token

PractitionerRole new-patient
new-patient-from-network PractitionerroleNewPatientFromNetworkSearchParameter SHALL Reference

PractitionerRole new-patient from network
verification-status PractitionerroleVerificationStatusSearchParameter SHALL Token

Verification status
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL Special

supports a more sophisticated grammar for searching
_id _id SHALL Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHALL Date/DateTime

Allows filtering for only records that have changed since last query.
active active SHALL Token

Whether this practitioner's record is in active use
endpoint endpoint SHALL Reference

Technical endpoints providing access to services operated for the practitioner with this role
identifier identifier SHALL Token

A practitioner's Identifier
location location SHALL Reference

One of the locations at which this practitioner provides care
organization organization SHALL Reference

The identity of the organization the practitioner represents / acts on behalf of
practitioner practitioner SHALL Reference

Practitioner that is able to provide the defined services for the organization
role role SHALL Token

The practitioner can perform this role at for the organization
service service SHALL Reference

The list of healthcare services that this worker provides for this role's Organization/Location
specialty specialty SHALL Token

The practitioner has this specialty at an organization


Consent

Supported Profile(s):

Behavior

Reference policy: Literal References, Local References Only

Interactions

Name Description

Search

Parameter Name Definition Conformance Type Description
action action SHOULD Token

Actions controlled by this rule
actor actor SHOULD Reference

Resource for the actor or group - by role
category category SHOULD Token

Classification of the consent statement - for indexing/retrieval
purpose purpose SHOULD Token

Context of activities covered by this rule
security-label security-label SHOULD Token

Security Labels that define affected resources
scope scope SHOULD Token

Which of the four areas this resource covers - extensible
status status SHOULD Token

draft; proposed active rejected inactive or entered-in-error


VerificationResult

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  read SHOULD

Read the current state of the resource
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  vread SHOULD

Read the state of specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: VerificationResult:target, VerificationResult:attestation-who

Parameter Name Definition Conformance Type Description
attestation-who VerificationResultAttestationWhoSearchParameter SHOULD Reference

VerificationResult attestation who
primarysource-validation-status VerificationResultPrimarysourceValidationStatusSearchParameter SHOULD Token

VerificationResult primarysource validation-status
primarysource-type VerificationResultPrimarysourceTypeSearchParameter SHOULD Token

VerificationResult primarysource type
status VerificationResultStatusSearchParameter SHOULD Token

VerificationResult status
target VerificationResultTargetSearchParameter SHOULD Reference

VerificationResult target
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD Special

supports a more sophisticated grammar for searching
_id _id SHOULD Token

Logical id allows to retrive more than one in a single call
_lastUpdated _lastUpdated SHOULD Date/DateTime

Allows filtering for only records that have changed since last query.


Subscription

Supported Profile(s):

Interactions

Name Conformance Description
  read SHOULD

Read Topic
  create SHOULD

Create Topic
  update SHOULD

Update Topic