CapabilityStatement in National Directory1.0.0

National Directory API Capability Statement

requirementsactiveFHIR 4.0.1

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.

http://hl7.org/fhir/us/ndh/CapabilityStatement/national-directory-api-server

Metadata

Version
1.0.0
Publisher
HL7 International / Patient Administration
Date
2022-11-01
Formats
xml, json

REST Resources (12)

Endpoint
Supported Profiles:
ndh-ndapi-Endpoint
Interactions
search-typereadvreadhistory-instancehistory-type
Search Parameters (15)
usecase-type:tokennonfhir-usecase-type:tokentrust-framework-type:tokendynamic-registration-trust-profile:tokenaccess-control-mechanism:tokenconnection-type-version:tokenihe-connection-type:tokenverification-status:token_filter:special_id:token+5 more
CareTeam
Supported Profiles:
ndh-ndapi-CareTeam
Interactions
search-typereadvreadhistory-instancehistory-type
Search Parameters (12)
endpoint:referencelocation:referenceorganization:referenceservice:referencename:stringverification-status:token_filter:special_id:token_lastUpdated:datecategory:token+2 more
HealthcareService
Supported Profiles:
ndh-ndapi-HealthcareService
Interactions
search-typereadvreadhistory-instancehistory-type
Search Parameters (31)
new-patient-from-network:referenceeligibility:tokennew-patient:tokenverification-status:tokennetwork:referenceprogram-requirement-age-group:tokenprogram-requirement-birthsex:tokenprogram-requirement-employment-status:tokenprogram-requirement-insurance-status:tokenprogram-requirement-va-status:token+21 more
InsurancePlan
Supported Profiles:
ndh-ndapi-InsurancePlan
Interactions
search-typereadvreadhistory-instancehistory-type
Search Parameters (23)
coverage-area:referencecoverage-benefit-type:tokencoverage-type:tokencoverage-network:referencenetwork:referenceplan-network:referenceplan-type:tokenverification-status:token_filter:special_id:token+13 more
Location
Supported Profiles:
ndh-ndapi-Location
Interactions
search-typereadvreadhistory-instancehistory-type
Search Parameters (21)
accessibility:tokencontains:specialnew-patient-from-network:referencenew-patient:tokenverification-status:token_filter:special_id:token_lastUpdated:dateaddress:stringaddress-city:string+11 more
Organization
Supported Profiles:
ndh-ndapi-Organizationndh-ndapi-Network
Interactions
search-typereadvreadhistory-instancehistory-type
Search Parameters (17)
coverage-area:referenceverification-status:token_filter:special_id:token_lastUpdated:dateactive:tokenaddress:stringaddress-city:stringaddress-country:stringaddress-postalcode:string+7 more
OrganizationAffiliation
Supported Profiles:
ndh-ndapi-OrganizationAffiliation
Interactions
history-instancehistory-typereadsearch-typevread
Search Parameters (13)
location:referenceparticipating-organization:referenceprimary-organization:referenceverification-status:token_filter:special_id:token_lastUpdated:dateendpoint:referenceidentifier:tokennetwork:reference+3 more
Practitioner
Supported Profiles:
ndh-ndapi-Practitioner
Interactions
readsearch-typevreadhistory-instancehistory-type
Search Parameters (11)
endpoint:referencequalification-issuer:referencequalification-code:tokenverification-status:token_filter:special_id:token_lastUpdated:dateactive:tokenname:stringgender:token+1 more
PractitionerRole
Supported Profiles:
ndh-ndapi-PractitionerRole
Interactions
readsearch-typevreadhistory-instancehistory-type
Search Parameters (16)
network:referencenew-patient:tokennew-patient-from-network:referencelocation:referenceorganization:referenceverification-status:token_filter:special_id:token_lastUpdated:dateactive:token+6 more
Consent
Supported Profiles:
ndh-Restriction
Interactions
readsearch-typevreadhistory-instancehistory-type
Search Parameters (7)
action:tokenactor:referencecategory:tokenpurpose:tokensecurity-label:tokenscope:tokenstatus:token
VerificationResult
Supported Profiles:
ndh-Verification
Interactions
readsearch-typevreadhistory-instancehistory-type
Search Parameters (8)
attestation-who:referenceprimarysource-validation-status:tokenprimarysource-type:tokenstatus:tokentarget:reference_filter:special_id:token_lastUpdated:date
Subscription
Supported Profiles:
backport-subscription
Interactions
readcreateupdate