CapabilityStatementFhirDirectoryQueryHealthHumanServicesExpanded Capabilities for a Federated Query Server for Health or Human Services where expanded search capabilities are met 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: SHOULD support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-CareTeam.html) endpoint Conformance Expectation: SHALL Supported Profiles: SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Endpoint.html) healthcareService Conformance Expectation: SHALL Supported Profiles: SHALL support:(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-HealthcareService.html) InsurancePlan Conformance Expectation: SHALL Supported Profiles: SHALL 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: SHOULD Supported Profiles: SHOULD 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: SHALL Supported Profiles: SHALL 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) 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 https://hl7.org/fhir/us/directory-query/StructureDefinition-NatlDirEndpointQry-network 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
Capability Statement Health or Human Services Federated Expanded Server
HL7 International - Patient Administration Work Group
Capabilities for a Federated Query Server for Health or Human Services where expanded search capabilities are met
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](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](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](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](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](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](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](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](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](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](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](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](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-CareTeam.html) | endpoint, location, name, organization, service, category | | | | #### CareTeam Conformance Expectation: **SHOULD** Supported Profiles: * **SHOULD** support:[(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-CareTeam.html)](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-CareTeam.html) #### endpoint Conformance Expectation: **SHALL** Supported Profiles: * **SHALL** support:[(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Endpoint.html)](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Endpoint.html) #### healthcareService Conformance Expectation: **SHALL** Supported Profiles: * **SHALL** support:[(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-HealthcareService.html)](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-HealthcareService.html) #### InsurancePlan Conformance Expectation: **SHALL** Supported Profiles: * **SHALL** support:[(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-InsurancePlan.html)](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)](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Location.html) #### network Conformance Expectation: **SHOULD** Supported Profiles: * **SHOULD** support:[(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-Network.html)](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)](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-organization.html) #### OrganizationAffiliation Conformance Expectation: **SHALL** Supported Profiles: * **SHALL** support:[(http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDirEndpointQry-OrganizationAffiliation.html)](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)](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)](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)](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)](http://hl7.org/fhir/us/directory-query/2022Sep/StructureDefinition-NatlDir-Verification.html)
1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations. 1. A client **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code.