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: NDH Verification Server Capability Statement

Official URL: http://hl7.org/fhir/us/ndh/CapabilityStatement/ndh-verification-server Version: 1.0.0-ballot
Active as of 2022-11-01 Computable Name: NdhVerificationCapabilityStatement

This Section describes the expected capabilities of the NDH Verification Server which is responsible for receiving information from primary source. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NDH Verification Servers are defined.

Raw OpenAPI-Swagger Definition file | Download


General

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

Jump to:


REST server behavior

NDH Verification Server


Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Endpoint SHALL SHALL SHALL SHALL SHALL SHALL SHALL
Location SHOULD SHOULD SHOULD SHOULD SHOULD SHOULD SHOULD
Organization SHALL SHALL SHALL SHALL SHALL SHALL SHALL
Practitioner SHALL SHALL SHALL SHALL SHALL SHALL SHALL
PractitionerRole SHOULD SHOULD SHOULD SHOULD SHOULD SHOULD SHOULD


Endpoint

Supported Profile(s):

Behavior

Versioning support: versioned

Reference policy: literal, local

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
  create SHALL

Create a new resource with a server assigned id
  update SHALL

Update an existing resource by its id or create it if it is new
  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: Location:endpoint, Location:endpoint, Organization:endpoint, Practitioner: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 http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
connection-type http://hl7.org/fhir/SearchParameter/Endpoint-connection-type SHALL token

Connection type
identifier http://hl7.org/fhir/SearchParameter/Endpoint-identifier SHALL token

Endpoint identifier
organization http://hl7.org/fhir/SearchParameter/Endpoint-organization SHALL reference

Organization that manages the Endpoint
status http://hl7.org/fhir/SearchParameter/Endpoint-status SHALL token

Endpoint status


Location

Supported Profile(s):

Behavior

Versioning support: versioned

Reference policy: literal, local

Interactions

Name Conformance Description
  create SHOULD

Create a new resource with a server assigned id
  update SHOULD

Update an existing resource by its id or create it if it is new
  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: 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
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD special

supports a more sophisticated grammar for searching
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.
address http://hl7.org/fhir/SearchParameter/Location-address SHOULD string

Location address
address-city http://hl7.org/fhir/SearchParameter/Location-address-city SHOULD string

Location address-city
address-country http://hl7.org/fhir/SearchParameter/Location-address-country SHOULD string

Location address-country
address-postalcode http://hl7.org/fhir/SearchParameter/Location-address-postalcode SHOULD string

Location address-postalcode
address-state http://hl7.org/fhir/SearchParameter/Location-address-state SHOULD string

Location address-state
address-use http://hl7.org/fhir/SearchParameter/Location-address-use SHOULD token

Location address-use
endpoint http://hl7.org/fhir/SearchParameter/Location-endpoint SHALL reference

Location endpoint
identifier http://hl7.org/fhir/SearchParameter/Location-identifier SHALL token

Location identifier
name http://hl7.org/fhir/SearchParameter/Location-name SHALL string

Location name
near http://hl7.org/fhir/SearchParameter/Location-near SHALL special

Location position
partof http://hl7.org/fhir/SearchParameter/Location-partof SHALL reference

Location partof
organization http://hl7.org/fhir/SearchParameter/Location-organization SHOULD reference

Location organization
type http://hl7.org/fhir/SearchParameter/Location-type SHOULD token

Location type


Organization

Supported Profile(s):

Behavior

Versioning support: versioned

Reference policy: literal, local

Interactions

Name Conformance Description
  create SHALL

Create a new resource with a server assigned id
  update SHALL

Update an existing resource by its id or create it if it is new
  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: Endpoint:organization, Location:organization, Location:new-patient-from-network, 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
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL special

supports a more sophisticated grammar for searching
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/Organization-active SHALL token

Organization active
address http://hl7.org/fhir/SearchParameter/Organization-address SHALL string

Organization address
address-city http://hl7.org/fhir/SearchParameter/Organization-address-city SHALL string

Organization address-city
address-country http://hl7.org/fhir/SearchParameter/Organization-address-country SHALL string

Organization address-country
address-postalcode http://hl7.org/fhir/SearchParameter/Organization-address-postalcode SHALL string

Organization address-postalcode
address-state http://hl7.org/fhir/SearchParameter/Organization-address-state SHALL string

Organization address-state
address-use http://hl7.org/fhir/SearchParameter/Organization-address-use SHALL token

Organization address-use
endpoint http://hl7.org/fhir/SearchParameter/Organization-endpoint SHALL reference

Organization endpoint
identifier http://hl7.org/fhir/SearchParameter/Organization-identifier SHALL token

Organization identifier
name http://hl7.org/fhir/SearchParameter/Organization-name SHALL string

Organization name
partof http://hl7.org/fhir/SearchParameter/Organization-partof SHALL reference

Organization partof
type http://hl7.org/fhir/SearchParameter/Organization-type SHALL token

Organization type


Practitioner

Supported Profile(s):

Behavior

Versioning support: versioned

Reference policy: literal, local

Interactions

Name Conformance Description
  create SHALL

Create a new resource with a server assigned id
  update SHALL

Update an existing resource by its id or create it if it is new
  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, Practitioner:verification-attestation-who

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
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHALL special

supports a more sophisticated grammar for searching
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/Practitioner-active SHALL token

Whether this practitioner's record is in active use
name http://hl7.org/fhir/SearchParameter/Practitioner-name SHALL string

A portion of either family or given name of the practitioner
gender http://hl7.org/fhir/SearchParameter/individual-gender SHALL token

Practitioner gender
identifier http://hl7.org/fhir/SearchParameter/Practitioner-identifier SHALL token

A practitioner's Identifier


PractitionerRole

Supported Profile(s):

Behavior

Versioning support: versioned

Reference policy: literal, local

Interactions

Name Conformance Description
  create SHOULD

Create a new resource with a server assigned id
  update SHOULD

Update an existing resource by its id or create it if it is new
  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: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
_filter http://hl7.org/fhir/SearchParameter/Resource-filter SHOULD special

supports a more sophisticated grammar for searching
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/PractitionerRole-active SHOULD token

Whether this practitioner's record is in active use
identifier http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier SHOULD token

A practitioner's Identifier
practitioner http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner SHOULD reference

Practitioner that is able to provide the defined services for the organization
role http://hl7.org/fhir/SearchParameter/PractitionerRole-role SHOULD token

The practitioner can perform this role at for the organization
service http://hl7.org/fhir/SearchParameter/PractitionerRole-service SHOULD reference

The list of healthcare services that this worker provides for this role's Organization/Location
specialty http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty SHOULD token

The practitioner has this specialty at an organization