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-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
| Official URL: http://hl7.org/fhir/us/ndh/CapabilityStatement/ndh-update-server | Version: 2.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: NdhUpdateCapabilityStatement | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.13.3 | |||||
The NDH Update Server CapabilityStatement defines the requirements for a server that accepts new and corrected directory data from authorized update requesters through the FHIR API. Query and retrieval of published directory data is defined by the NDH Server CapabilityStatement.
Raw OpenAPI-Swagger Definition file | Download
Language: en
Profile: CapabilityStatement
xml, jsonapplication/json-patch+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverUpdate requesters submit resources conforming to the NDH profiles. The NDH Update Server validates each submission and returns an OperationOutcome describing each problem when a submission is not valid. Update requesters identify the records they maintain by business identifier, using conditional update to replace a record and conditional patch (PATCH [base]/[type]?identifier=[system]|[value]) to change individual elements. The NDH Update Server SHOULD support ETag and If-Match for collision handling. Records are deactivated rather than deleted: active set to false, period.end recorded on PractitionerRole and OrganizationAffiliation, or status set to inactive (Location), off (Endpoint), or retired (InsurancePlan). The delete interaction is not supported. VerificationResult and Provenance are populated by the directory; update requesters are not required to write them.
The NDH Update Server SHALL meet the security conformance requirements for NDH servers, SHALL authenticate each update requester, and SHALL authorize each write. Identity proofing, record ownership, adjudication of conflicting submissions, and publication of submitted data to the NDH Server are determined by the directory operator.
transactioninteraction described as follows:Submit interdependent resources as one atomic transaction Bundle.
batchinteraction described as follows:Submit independent resources as a batch Bundle.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | P | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|
| Endpoint | Supported Profiles NDH Endpoint Profile | Y | Y | Y | Y | Y | identifier | |||
| HealthcareService | Supported Profiles NDH HealthcareService Profile | Y | Y | Y | Y | Y | identifier | |||
| InsurancePlan | Supported Profiles NDH InsurancePlan Profile | Y | Y | Y | Y | Y | identifier | |||
| Location | Supported Profiles NDH Location Profile | Y | Y | Y | Y | Y | identifier | |||
| Organization | Supported Profiles NDH Organization Profile NDH Network Profile | Y | Y | Y | Y | Y | identifier | |||
| OrganizationAffiliation | Supported Profiles NDH OrganizationAffiliation Profile | Y | Y | Y | Y | Y | identifier | |||
| Practitioner | Supported Profiles NDH Practitioner Profile | Y | Y | Y | Y | Y | identifier | |||
| PractitionerRole | Supported Profiles NDH PractitionerRole | Y | Y | Y | Y | Y | identifier | |||
| Group | Supported Profiles NDH Group | Y | Y | Y | Y | Y | identifier |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHOULD | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier used to select the record for conditional update |
literal, localupdateUpdate an existing resource by its id or by business identifier using conditional update
createCreate a new resource with a server assigned id
patchChange individual elements of an existing resource by its id or by business identifier using conditional patch
readRead the current state of the resource
search-typeSearch by business identifier to locate an existing resource
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHOULD | identifier | token | Business identifier used to select the record for conditional update |