FHIR Human Services Directory
1.0.0 - STU1 United States of America flag

This page is part of the FHIR IG Human Services Directory (v1.0.0: STU1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: Human Services Directory Capability Statement

Official URL: http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: HumanServicesDirectoryCapabilityStatement

Describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory (HSD) Servers are defined.

Raw OpenAPI-Swagger Definition file | Download

Human Services Directory CapabilityStatement

  • Official URL:http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory
  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: XML, JSON
  • Published: 2023-08-16
  • Published by: HL7 Human and Social Services Working Group (HSSWG)
  • Status: Draft

This section describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory Servers are defined.

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
OrganizationHSD Organizationaddress-city, address-postalcode, address-state, address-country, name, type, identifier, _id, _lastUpdatedHealthcareService:organization, Location:organization
LocationHSD Locationaccessibility, address-city, address-postalcode, address-state, address-country, name, organization, hoursofoperation, _id, _lastUpdatedLocation:organizationHealthcareService:location
HealthcareServiceHSD HealthcareServicecommunication, location, name, organization, program, service-category, service-type, active, _id, _lastUpdatedHealthcareService:location, HealthcareService:organization

Organization

Conformance Expectation: SHALL

HSD Organization

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Organization resource using:
    GET [base]/Organization/[id]
  • A Server SHOULD be capable of returning a Organization resource using:
    GET [base]/Organization/[id]/_history/vid
  • A Server SHALL be capable of supporting the following _includes:
    N/A
  • A Server SHALL be capable of supporting the following _revincludes:
    HealthcareService:organization - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService:organization
    Location:organization - GET [base]/Organization?[parameter=value]&_revinclude=Location:organization

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLnamestringGET [base]/Organization?name=[name]
SHALLtypetokenGET [base]/Organization?type=[system]|[code]
SHALLaddress-citystringGET [base]/Organization?address-city=[address-city]
SHALLidentifierstringGET [base]/Organization?identifier=[identifier]
SHALLaddress-postalcodestringGET [base]/Organization?address-postalcode=[address-postalcode]
SHALLaddress-statestringGET [base]/Organization?address-state=[address-state]
SHALLaddress-countrystringGET [base]/Organization?address-country=[address-country]
SHALL_idtokenGET [base]/Organization?_id=[id]
SHALL_lastUpdateddateGET [base]/Organization?_lastUpdated=[_lastUpdated]

Location

Conformance Expectation: SHALL

Supported Profiles: HSD Location

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Location resource using:
    GET [base]/Location/[id]
  • A Server SHOULD be capable of returning a Location resource using:
    GET [base]/Location/[id]/_history/vid
  • A Server SHALL be capable of supporting the following _includes:
    Location:organization - GET [base]/Location?[parameter=value]&_include=Location:organization
  • A Server SHALL be capable of supporting the following _revincludes:
    HealthcareService:location - GET [base]/Location?[parameter=value]&_revinclude=HealthcareService:location

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLnamereferenceGET [base]/Location?name=[name]
SHALLorganizationreferenceGET [base]/Location?organization=[organization]
SHALLhoursofoperationreferenceGET [base]/Location?hoursofoperation=[hoursofoperation]
SHALLaccessibilityreferenceGET [base]/Location?accessibility=[accessibility]
SHALLaddress-citystringGET [base]/Location?address-city=[address-city]
SHALLaddress-statestringGET [base]/Location?address-state=[address-state]
SHALLaddress-postalcodestringGET [base]/Location?address-postalcode=[address-postalcode]
SHALLaddress-countrystringGET [base]/Location?address-country=[address-country]
SHALL_idtokenGET [base]/Location?_id=[id]
SHALL_lastUpdateddateGET [base]/Location?_lastUpdated=[_lastUpdated]

HealthcareService

Conformance Expectation: SHALL

Supported Profiles: HSD HealthcareService

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a HealthcareService resource using:
    GET [base]/HealthcareService/[id]
  • A Server SHOULD be capable of returning a HealthcareService resource using:
    GET [base]/HealthcareService/[id]/_history/vid
  • A Server SHALL be capable of supporting the following _includes:
    HealthcareService:location - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:location
    HealthcareService:organization - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:organization
  • A Server SHALL be capable of supporting the following _revincludes:
    N/A

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLnamereferenceGET [base]/HealthcareService?name=[name]
SHALLorganizationreferenceGET [base]/HealthcareService?organization=[organization]
SHALLlocationreferenceGET [base]/HealthcareService?location=[location]
SHALLprogramstringGET [base]/HealthcareService?program=[program]
SHALLcommunicationtokenGET [base]/HealthcareService?communication=[system]|[code]
SHALLservice-categorytokenGET [base]/HealthcareService?service-category=[system]|[code]
SHALLservice-typetokenGET [base]/HealthcareService?service-type=[system]|[code]
SHALLactivestringGET [base]/HealthcareService?active=[active]
SHALL_idtokenGET [base]/HealthcareService?_id=[id]
SHALL_lastUpdateddateGET [base]/HealthcareService?_lastUpdated=[_lastUpdated]