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. For a full list of available versions, see the Directory of published versions
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
http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory
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.
Summary of Search Criteria
Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
---|---|---|---|---|---|
Organization | HSD Organization | address-city, address-postalcode, address-state, address-country, name, type, identifier, _id, _lastUpdated | HealthcareService:organization, Location:organization | ||
Location | HSD Location | accessibility, address-city, address-postalcode, address-state, address-country, name, organization, hoursofoperation, _id, _lastUpdated | Location:organization | HealthcareService:location | |
HealthcareService | HSD HealthcareService | communication, location, name, organization, program, service-category, service-type, active, _id, _lastUpdated | HealthcareService:location, HealthcareService:organization |
Conformance Expectation: SHALL
Reference Policy: resolves
Profile Interaction Summary:
search-type
, read
.vread
.Fetch and Search Criteria:
GET [base]/Organization/[id]
GET [base]/Organization/[id]/_history/vid
GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService:organization
GET [base]/Organization?[parameter=value]&_revinclude=Location:organization
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | name | string | GET [base]/Organization?name=[name] |
SHALL | type | token | GET [base]/Organization?type=[system]|[code] |
SHALL | address-city | string | GET [base]/Organization?address-city=[address-city] |
SHALL | identifier | string | GET [base]/Organization?identifier=[identifier] |
SHALL | address-postalcode | string | GET [base]/Organization?address-postalcode=[address-postalcode] |
SHALL | address-state | string | GET [base]/Organization?address-state=[address-state] |
SHALL | address-country | string | GET [base]/Organization?address-country=[address-country] |
SHALL | _id | token | GET [base]/Organization?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/Organization?_lastUpdated=[_lastUpdated] |
Conformance Expectation: SHALL
Supported Profiles: HSD Location
Reference Policy: resolves
Profile Interaction Summary:
search-type
, read
.vread
.Fetch and Search Criteria:
GET [base]/Location/[id]
GET [base]/Location/[id]/_history/vid
GET [base]/Location?[parameter=value]&_include=Location:organization
GET [base]/Location?[parameter=value]&_revinclude=HealthcareService:location
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | name | reference | GET [base]/Location?name=[name] |
SHALL | organization | reference | GET [base]/Location?organization=[organization] |
SHALL | hoursofoperation | reference | GET [base]/Location?hoursofoperation=[hoursofoperation] |
SHALL | accessibility | reference | GET [base]/Location?accessibility=[accessibility] |
SHALL | address-city | string | GET [base]/Location?address-city=[address-city] |
SHALL | address-state | string | GET [base]/Location?address-state=[address-state] |
SHALL | address-postalcode | string | GET [base]/Location?address-postalcode=[address-postalcode] |
SHALL | address-country | string | GET [base]/Location?address-country=[address-country] |
SHALL | _id | token | GET [base]/Location?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/Location?_lastUpdated=[_lastUpdated] |
Conformance Expectation: SHALL
Supported Profiles: HSD HealthcareService
Reference Policy: resolves
Profile Interaction Summary:
search-type
, read
.vread
.Fetch and Search Criteria:
GET [base]/HealthcareService/[id]
GET [base]/HealthcareService/[id]/_history/vid
GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:location
GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:organization
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | name | reference | GET [base]/HealthcareService?name=[name] |
SHALL | organization | reference | GET [base]/HealthcareService?organization=[organization] |
SHALL | location | reference | GET [base]/HealthcareService?location=[location] |
SHALL | program | string | GET [base]/HealthcareService?program=[program] |
SHALL | communication | token | GET [base]/HealthcareService?communication=[system]|[code] |
SHALL | service-category | token | GET [base]/HealthcareService?service-category=[system]|[code] |
SHALL | service-type | token | GET [base]/HealthcareService?service-type=[system]|[code] |
SHALL | active | string | GET [base]/HealthcareService?active=[active] |
SHALL | _id | token | GET [base]/HealthcareService?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/HealthcareService?_lastUpdated=[_lastUpdated] |