HL7.FHIR.US.DIRECTORY-QUERY\directory-query-health-or-human-services-endpoint

National Healthcare Directory Query
1.0.0-ballot - ballot US

This page is part of the National Healthcare Query (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: directory-query-health-or-human-services-endpoint (Experimental)

Official URL: http://hl7.org/fhir/us/directory-query/CapabilityStatement/directory-query-health-or-human-services-endpoint				Version: 1.0.0-ballot
Draft as of 2022-02-15				Computable Name: CapabilityStatementFhirDirectoryQueryHealthHumanServicesEndpoint

Capabilities for a Federated Query Server for Health or Human Services where endpoint search capabilities are met

Raw OpenAPI-Swagger Definition file | Download

CapabilityStatementFhirDirectoryQueryHealthHumanServicesEndpoint

Capabilities for a Federated Query Server for Health or Human Services where endpoint search capabilities are met

Mode SERVER

Description

A Federated Query server SHALL:

Support all profiles defined below in this Capability Statement. Implement the RESTful behavior according to the FHIR specification. 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. Support json source formats for all Federated Query interactions. Identify the Federated Query profiles supported as part of the FHIR meta.profile attribute for each instance. Support the searchParameters on each profile individually and in combination. The Federated Query Server SHOULD:

Support xml source formats for all Federated Query interactions.

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

endpoint

Conformance Expectation: SHALL

Supported Profiles:

SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Endpoint.html)

healthcareService

Conformance Expectation: MAY

Supported Profiles:

MAY support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-HealthcareService.html)

InsurancePlan

Conformance Expectation: MAY

Supported Profiles:

MAY support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-InsurancePlan.html)

location

Conformance Expectation: SHALL

Supported Profiles:

SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Location.html)

network

Conformance Expectation: SHALL

Supported Profiles:

MAY support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Network.html)

organization

Conformance Expectation: SHALL

Supported Profiles:

SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-organization.html)

OrganizationAffiliation

Conformance Expectation: MAY

Supported Profiles:

MAY support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-OrganizationAffiliation.html)

Practitioner

Conformance Expectation: SHALL

Supported Profiles:

SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Practitioner.html)

PractitionerRole

Conformance Expectation: SHALL

Supported Profiles:

SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-PractitionerRole.html)

Restriction

Conformance Expectation: SHALL

Supported Profiles:

SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDir-Restriction.html)

Validation

Conformance Expectation: MAY

Supported Profiles:

MAY support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDir-Verification.html)

CareTeam

Conformance Expectation: MAY

Supported Profiles:

MAY support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-CareTeam.html)

Transaction

System History

System Search

Resource Type	Profile	Read	Search	Update	Create
Endpoint	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-Endpoint
HealthcareService	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-HealthcareService
InsurancePlan	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-InsurancePlan
Location	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-location
Organization	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-organization
OrganizationAffiliation	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-OrganizationAffiliation
Practitioner	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-Practitioner
PractitionerRole	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-PractitionerRole
Consent	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-Restriction
VerificationResult	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-Validation
CareTeam	Supported profiles: https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-CareTeam

IG © 2021+ HL7 International - Patient Administration Work Group. Package hl7.fhir.us.directory-query#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-08-09
Links: Table of Contents | QA Report | Version History | | Propose a change