National Healthcare Directory Exchange
1.0.0-ballot - ballot United States of America flag

National Healthcare Directory Exchange, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-exchange/ and changes regularly. See the Directory of published versions

CapabilityStatement: fhir-national-directory (Experimental)

Official URL: http://hl7.org/fhir/us/directory-exchange/CapabilityStatement/fhir-national-directory Version: 1.0.0-ballot
Draft as of 2022-02-15 Computable Name: CapabilityStatementFhirNationalDirectory

Capabilities for a validated national directory server

Raw OpenAPI-Swagger Definition file | Download

CapabilityStatementFhirNationalDirectory

Capabilities for a validated national directory server

ModeSERVER
Description
Resource Type Supported Interactions Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations
endpoint http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-HealthcareService.html identifier, usecase-type
healthcare Service http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-HealthcareService.html service-category, coverage-area, endpoint, location, name, organization, specialty, service-type
InsurancePlan http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-InsurancePlan.html coverage-area, administrated-by, coverage-benefit-type, coverage-network, identifier, type, name, owned-by
location http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Location.html address, endpoint, organization, physicalType, partOf, type
network http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Network.html coverage-area, name
Organization http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Organization.html type, address, endpoint, identifier, name, partOf
OrganizationAffiliation http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-OrganizationAffiliation.html endpoint, location, network, participating-organization, primary-organization, role, service, specialty
Practitioner http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Practitioner.html name, family, given, identifier, identifier-assigner, qualification-code, qualification-issuer
PractitionerRole http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-PractitionerRole.html endpoint, location, network, organization, Practicioner, role, service, specialty
Restriction http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDir-Restriction.html _id, _id, _lastUpdated, plan-type, name, coverage-area, owned=by, administrated-by
Validation http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDir-Verification.html attestation-who, primarysource-who, target
CareTeam http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-CareTeam.html endpoint, location, name, organization, service, category

CareTeam

Conformance Expectation: SHOULD

Supported Profiles:

endpoint

Conformance Expectation: SHALL

Supported Profiles:

healthcareService

Conformance Expectation: SHALL

Supported Profiles:

InsurancePlan

Conformance Expectation: SHALL

Supported Profiles:

location

Conformance Expectation: SHALL

Supported Profiles:

network

Conformance Expectation: SHOULD

Supported Profiles:

organization

Conformance Expectation: SHALL

Supported Profiles:

OrganizationAffiliation

Conformance Expectation: SHALL

Supported Profiles:

Practitioner

Conformance Expectation: SHALL

Supported Profiles:

PractitionerRole

Conformance Expectation: SHALL

Supported Profiles:

Restriction

Conformance Expectation: SHALL

Supported Profiles:

Validation

Conformance Expectation: MAY

Supported Profiles:

Transaction
System History
System Search
Resource TypeProfileReadSearchUpdateCreate
EndpointSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Endpoint
HealthcareServiceSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-HealthcareService
InsurancePlanSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-InsurancePlan
LocationSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Location
OrganizationSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Organization
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Network
OrganizationAffiliationSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-OrganizationAffiliation
PractitionerSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Practitioner
PractitionerRoleSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-PractitionerRole
ConsentSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Restriction
VerificationResultSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Validation
CareTeamSupported profiles:
  http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-CareTeam