CapabilityStatement-fhir-national-directory

Sourcehl7.fhir.us.directory-exchange#current:National Healthcare Directory Exchange (v4.0.1)
resourceTypeCapabilityStatement
idfhir-national-directory
canonicalhttp://hl7.org/fhir/us/directory-exchange/CapabilityStatement/fhir-national-directory
version1.0.0-ballot
statusdraft
publisherHL7 Patient Administration Working Group
nameCapabilityStatementFhirNationalDirectory
titleCapability Statement National Directory
date2022-02-15T07:15:00.000000-04:00
experimentaltrue
descriptionCapabilities for a validated national directory server
jurisdictionsus
kindrequirements
fhirVersion4.0.1
formatsxml json
implementationGuideshttps://hl7.org/fhir/us/directory-exchange/
Usages(none)

CapabilityStatementFhirNationalDirectory

Capabilities for a validated national directory server

Mode SERVER
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 Type Profile Read Search Update Create
Endpoint Supported profiles:
   National Directory Endpoint
HealthcareService Supported profiles:
   National Directory HealthcareService
InsurancePlan Supported profiles:
   National Directory InsurancePlan
Location Supported profiles:
   National Directory Location
Organization Supported profiles:
   National Directory Organization
   National Directory Network
OrganizationAffiliation Supported profiles:
   National Directory OrganizationAffiliation
Practitioner Supported profiles:
   National Directory Practitioner
PractitionerRole Supported profiles:
   National Directory PractitionerRole
Consent Supported profiles:
   National Directory Restriction
VerificationResult Supported profiles:
   National Directory Validation
CareTeam Supported profiles:
   National Directory Care Team

Produced 08 Sep 2023