CapabilityStatement-NatlDir

Sourcehl7.fhir.us.directory-attestation#current:National Healthcare Directory Attestation and Verification (v4.0.1)
resourceTypeCapabilityStatement
idNatlDir
canonicalhttp://hl7.org/fhir/us/directory-attestation/CapabilityStatement/NatlDir
version1.0.0-ballot
statusactive
publisherHL7 Patient Administration Working Group
nameDavinciPdexNatlDirCapabilityStatement
titleNatlDir CapabilityStatement
date2020-11-19
experimentalfalse
descriptionThis Section describes the expected capabilities of the NatlDir Server actor which is responsible for providing responses to the queries submitted by the NatlDir Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NatlDir Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access. NatlDir Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.
jurisdictionsus
kindrequirements
fhirVersion4.0.1
formatsxml json application/json-patch+json
implementationGuideshttp://http://hl7.org/fhir/us/directory-attestation/ImplementationGuide/http://hl7.org/fhir/us/directory-attestation
Usages(none)

DavinciPdexNatlDirCapabilityStatement

This Section describes the expected capabilities of the NatlDir Server actor which is responsible for providing responses to the queries submitted by the NatlDir Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NatlDir Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access. NatlDir Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.

Mode SERVER
Description

The NatlDir Server SHALL :

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  4. Support json source formats for all NatlDir interactions.
  5. Identify the NatlDir profiles supported as part of the FHIR meta.profile attribute for each instance.
  6. Support the searchParameters on each profile individually and in combination. 1.Support forward and reverse chaining on all search parameters that specify the 'chain' property

The NatlDir Server SHOULD :

  1. Support xml source formats for all NatlDir interactions.
Transaction
System History
System Search
Resource Type Profile Read V-Read Search Update Create
Endpoint Supported profiles:
   NatDir Endpoint 		y y y
HealthcareService Supported profiles:
   National Directory HealthcareService 		y y y
InsurancePlan Supported profiles:
   NatDir InsurancePlan 		y y y
Location Supported profiles:
   NatDir Location 		y y y
Organization Supported profiles:
   NatDir Network
   NatDir Organization 		y y y
OrganizationAffiliation Supported profiles:
   NatDir OrganizationAffiliation 		y y y
Practitioner Supported profiles:
   NatDir Practitioner 		y y y
PractitionerRole Supported profiles:
   NatDir PractitionerRole 		y y y

Produced 08 Sep 2023