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: Workflow Directory Server Endpoint Basic Query Capability Statement

Official URL: http://hl7.org/fhir/us/ndh/CapabilityStatement/wds-endpoint-basic-query-server Version: 1.0.0-ballot
Active as of 2022-11-01 Computable Name: WdsEndpointBasicQueryCapabilityStatement

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

Workflow Directory Endpoint Basic Query Server


Resource summary



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

_id _id SHALL 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.

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 MAY

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

  read MAY

Read the current state of the resource

  vread MAY

Read the state of a specific version of the resource

  history-instance MAY

Retrieve the history of the resource

  history-type MAY

Retrieve the history of the resource type

Search

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

Parameter Name Definition Conformance Type Description
endpoint CareTeamEndpointSearchParameter MAY Reference

Endpoint of the CareTeam

location CareTeamLocationSearchParameter MAY Reference

Location of the CareTeam

organization CareTeamOrganizationSearchParameter MAY Reference

Organization of the CareTeam

service CareTeamServiceSearchParameter MAY Reference

Service of the CareTeam

name CareTeamNameSearchParameter MAY String

Name of the CareTeam

careteam-verification-status CareTeamVerificationStatusSearchParameter MAY Token

Verification status of the CareTeam

_id _id MAY Token

Logical id allows to retrive more than one in a single call

_lastUpdated _lastUpdated MAY Date/DateTime

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

category category MAY Token

Type of team

participant participant MAY Reference

Who is involved

status status MAY 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 MAY

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

  read MAY

Read the current state of the resource

  vread MAY

Read the state of a specific version of the resource

  history-instance MAY

Retrieve the history of the resource

  history-type MAY

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:service, OrganizationAffiliation:service, PractitionerRole:service

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

New patient from network

eligibility HealthcareServiceEligibilitySearchParameter MAY Token

Eligibility

new-patient HealthcareServiceNewPatientSearchParameter MAY Token

New patient

verification-status HealthcareServiceVerificationStatusSearchParameter MAY Token

Verification status

_id _id MAY Token

Logical id allows to retrive more than one in a single call

_lastUpdated _lastUpdated MAY Date/DateTime

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

active active MAY Token

Whether this HealthcareService record is in active use

coverage-area coverage-area MAY Reference

Location service is inteded for/available to

endpoint endpoint MAY Reference

Technical endpoints providing access to services operated for the location

identifier identifier MAY Token

External identifiers for this item

name name MAY String

A portion of the Healthcare service name

program program MAY Token

One of the Program Names that categorize the service

service-category service-category MAY Token

Service Category of the Healthcare Service

service-type service-type MAY Token

The type of service provided by this healthcare service

specialty specialty MAY Token

Specialties handled by the HealthcareService

location HealthcareServiceLocationSearchParameter MAY Reference

The location of the Healthcare Service

organization HealthcareServiceOrganizationSearchParameter MAY Reference

The organization that provides this Healthcare Service



InsurancePlan

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

Interactions

Name Conformance Description
  search-type MAY

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

  read MAY

Read the current state of the resource

  vread MAY

Read the state of a specific version of the resource

  history-instance MAY

Retrieve the history of the resource

  history-type MAY

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 MAY Reference

InsurancePlan coverage area

coverage-benefit-type InsuranceplanCoverageBenefitTypeSearchParameter MAY Token

InsurancePlan coverage benefit type

coverage-type InsuranceplanCoverageTypeSearchParameter MAY Token

InsurancePlan coverage type

coverage-network InsuranceplanCoverageNetworkSearchParameter MAY Reference

InsurancePlan coverage network

network InsuranceplanPlanNetworkSearchParameter MAY Reference

InsurancePlan network

plan-network InsuranceplanPlanNetworkSearchParameter MAY Reference

InsurancePlan plan network

plan-type InsuranceplanPlanTypeSearchParameter MAY Token

InsurancePlan plan type

verification-status InsuranceplanVerificationStatusSearchParameter MAY Token

Verification status

_id _id MAY Token

Logical id allows to retrive more than one in a single call

_lastUpdated _lastUpdated MAY Date/DateTime

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

address address MAY String

InsurancePlan contact address

address-city address-city MAY String

InsurancePlan contact address-city

address-country address-country MAY String

InsurancePlan contact address-country

address-postalcode address-postalcode MAY String

InsurancePlan contact address-postalcode

address-state address-state MAY String

InsurancePlan contact address-state

administered-by administered-by MAY Reference

InsurancePlan administered by

endpoint endpoint MAY Reference

InsurancePlan endpoint

identifier identifier MAY Token

InsurancePlan identifier

name name MAY String

InsurancePlan name

owned-by owned-by MAY Reference

InsurancePlan owned by

status status MAY Token

InsurancePlan status

type type MAY Token

InsurancePlan type



Location

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: 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 SHOULD Token

Location accessibility

contains LocationContainsSearchParameter SHOULD Special

Location contains

new-patient-from-network LocationNewPatientFromNetworkSearchParameter SHOULD Reference

Location new patient from network

new-patient LocationNewPatientSearchParameter SHOULD Token

Location new patient

verification-status LocationVerificationStatusSearchParameter SHOULD Token

Verification status

_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

Location address

address-city address-city SHOULD String

Location address-city

address-country address-country SHOULD String

Location address-country

address-postalcode address-postalcode SHOULD String

Location address-postalcode

address-state address-state SHOULD String

Location address-state

address-use address-use SHOULD Token

Location address-use

endpoint endpoint SHOULD Reference

Location endpoint

identifier identifier SHOULD Token

Location identifier

name name SHOULD String

Location name

near near SHOULD Special

Location position

partof partof SHOULD Reference

Location partof

organization organization SHOULD Reference

Location organization

type type SHOULD 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, 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

_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 MAY

Retrieve the history of the resource

  history-type MAY

Retrieve the history of the resource type

  read MAY

Read the current state of the resource

  search-type MAY

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

  vread MAY

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 MAY Reference

OrganizationAffiliation location

participating-organization OrganizationAffiliationParticipatingOrganizationSearchParameter MAY Reference

OrganizationAffiliation participating-organization

primary-organization OrganizationAffiliationPrimaryOrganizationSearchParameter MAY Reference

OrganizationAffiliation primary-organization

verification-status OrganizationAffiliationVerificationStatusSearchParameter MAY Token

Verification status

_id _id MAY Token

Logical id allows to retrive more than one in a single call

_lastUpdated _lastUpdated MAY Date/DateTime

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

endpoint endpoint MAY Reference

OrganizationAffiliation endpoint

identifier identifier MAY Token

OrganizationAffiliation identifier

network network MAY Reference

OrganizationAffiliation network

role role MAY Token

OrganizationAffiliation role

service service MAY Reference

OrganizationAffiliation service

specialty specialty MAY Token

OrganizationAffiliation specialty



Practitioner

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: Practitioner:endpoint, Practitioner:qualification-issuer

Supported Reverse-Includes: PractitionerRole:practitioner

Parameter Name Definition Conformance Type Description
qualification-issuer PractitionerQualificationIssuerSearchParameter SHOULD Reference

Practitioner qualification issuer

qualification-code PractitionerQualificationCodeSearchParameter SHOULD Token

Practitioner qualification code

verification-status PractitionerVerificationStatusSearchParameter SHALL Token

Verification status

_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 practitioner's record is in active use

name name SHOULD String

A portion of either family or given name of the practitioner

gender gender SHOULD Token

Practitioner gender

identifier identifier SHOULD 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 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: 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 SHOULD Reference

PractitionerRole network

new-patient PractitionerroleNewPatientSearchParameter SHOULD Token

PractitionerRole new-patient

new-patient-from-network PractitionerroleNewPatientFromNetworkSearchParameter SHOULD Reference

PractitionerRole new-patient from network

location PractitionerroleLocationSearchParameter SHOULD Reference

One of the locations at which this practitioner provides care

organization PractitionerroleOrganizationSearchParameter SHOULD Reference

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

verification-status PractitionerroleVerificationStatusSearchParameter SHALL Token

Verification status

_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 practitioner's record is in active use

endpoint endpoint MAY Reference

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

identifier identifier SHOULD Token

A practitioner's Identifier

practitioner practitioner SHOULD Reference

Practitioner that is able to provide the defined services for the organization

role role SHOULD Token

The practitioner can perform this role at for the organization

service service SHOULD Reference

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

specialty specialty SHOULD 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 MAY Token

Actions controlled by this rule

actor actor MAY Reference

Resource for the actor or group - by role

category category MAY Token

Classification of the consent statement - for indexing/retrieval

purpose purpose MAY Token

Context of activities covered by this rule

security-label security-label MAY Token

Security Labels that define affected resources

scope scope MAY Token

Which of the four areas this resource covers - extensible

status status MAY 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 MAY

Read the current state of the resource

  search-type MAY

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

  vread MAY

Read the state of specific version of the resource

  history-instance MAY

Retrieve the history of the resource

  history-type MAY

Retrieve the history of the resource type

Search

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

Parameter Name Definition Conformance Type Description
_id _id MAY Token

Logical id allows to retrive more than one in a single call

_lastUpdated _lastUpdated MAY Date/DateTime

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

attestation-who VerificationResultAttestationWhoSearchParameter MAY Reference

VerificationResult attestation who

primarysource-validation-status VerificationResultPrimarysourceValidationStatusSearchParameter MAY Token

VerificationResult primarysource validation-status

primarysource-type VerificationResultPrimarysourceTypeSearchParameter MAY Token

VerificationResult primarysource type

status VerificationResultStatusSearchParameter MAY Token

VerificationResult status

target VerificationResultTargetSearchParameter MAY Reference

VerificationResult target