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


Location

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

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
verification-status LocationVerificationStatusSearchParameter 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

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


Practitioner

Supported Profile(s):

Behavior

Versioning support: Versioned

Reference policy: Literal References, Local References Only

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

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
  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
verification-status PractitionerroleVerificationStatusSearchParameter 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.
active active SHOULD Token

Whether this practitioner's record is in active use
endpoint endpoint SHOULD 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