FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/HumanServicesDirectory

Packagehl7.fhir.us.hsds
TypeCapabilityStatement
IdHumanServicesDirectory
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/hsds/https://build.fhir.org/ig/HL7/FHIR-IG-Human-Services-Directory/CapabilityStatement-HumanServicesDirectory.html
URLhttp://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory
Version1.0.0
Statusdraft
Date2023-08-05
NameHumanServicesDirectoryCapabilityStatement
TitleHuman Services Directory Capability Statement
Realmus
Authorityhl7
DescriptionDescribes 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.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
hl7.fhir.us.hsdsFHIR Human Services Directory
SearchParameter
healthcareservice-communicationHSD_sp_healthcareservice_communication
healthcareservice-programHSD_sp_healthcareservice_program
location-accessibilityHSD_sp_location_accessibility
location-address-cityHSD_sp_location_address_city
location-address-countryHSD_sp_location_address_country
location-address-postalcodeHSD_sp_location_address_postalcode
location-address-stateHSD_sp_location_address_state
location-addressHSD_sp_location_address
location-hoursofoperationHSD_sp_location_hoursofoperation
location-nameHSD_sp_location_name
location-organizationHSD_sp_location_organization
organization-address-cityHSD_sp_organization_address_city
organization-address-postalcodeHSD_sp_organization_address_postalcode
organization-address-stateHSD_sp_organization_address_state
organization-addressHSD_sp_organization_address
organization-identifierHSD_sp_organization_identifier
organization-nameHSD_sp_organization_name
organization-typeHSD_sp_organization_type
StructureDefinition
hsds-HealthcareServiceHSDHealthcareService
hsds-LocationHSDLocation
hsds-OrganizationHSDOrganization

Narrative

Note: links and images are rebased to the (stated) source

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]



Source

{
  "resourceType": "CapabilityStatement",
  "id": "HumanServicesDirectory",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "hss"
    }
  ],
  "url": "http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory",
  "version": "1.0.0",
  "name": "HumanServicesDirectoryCapabilityStatement",
  "title": "Human Services Directory Capability Statement",
  "status": "draft",
  "experimental": false,
  "date": "2023-08-05",
  "publisher": "HL7 Human and Social Services Work Group",
  "contact": [
    {
      "name": "HL7 Human and Social Services Work Group",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/hsswg/index.cfm"
        },
        {
          "system": "email",
          "value": "hsswg@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "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.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/hsds/ImplementationGuide/hl7.fhir.us.hsds"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Description of the needed resources to be supported by the FHIR server, and the different possible interactions.",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Location",
          "profile": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location",
          "documentation": "Read a location (details and position information) for a physical place where human and social services are provided.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-name",
              "type": "string",
              "documentation": "Search for locations by a portion of the location's name or alias."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.country",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-country",
              "type": "string",
              "documentation": "Search for locations by a country specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "hoursofoperation",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-hoursofoperation",
              "type": "string",
              "documentation": "Search for locations by hours of operation."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "accessibility",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-accessibility",
              "type": "token",
              "documentation": "Search for locations by accessibiity options."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address",
              "type": "string",
              "documentation": "Search for locations by a (part of the) address of the location."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address-city",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-city",
              "type": "string",
              "documentation": "Search for locations by city specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address-state",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-state",
              "type": "string",
              "documentation": "Search for locations by state specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address-postalcode",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-postalcode",
              "type": "string",
              "documentation": "Search for locations by postal code specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "organization",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-organization",
              "type": "reference",
              "documentation": "Search for locations that are managed by the specified organization."
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization",
          "documentation": "Read a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address",
              "type": "string",
              "documentation": "Search for organizations specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.postalCode",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-postalcode",
              "type": "string",
              "documentation": "Search for organizations by postal code specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.state",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-state",
              "type": "string",
              "documentation": "Search for organizations by state specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.city",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-city",
              "type": "string",
              "documentation": "Search for organizations by city specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-identifier",
              "type": "token",
              "documentation": "Search for organizations by tax identifier (business indentifier) associated with human services organizations."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-name",
              "type": "string",
              "documentation": "Search for organizations by a portion of the organization's name or alias."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-type",
              "type": "token",
              "documentation": "Search for organizations by (a code for) the type of organization."
            }
          ]
        },
        {
          "type": "HealthcareService",
          "profile": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService",
          "documentation": "Read the details of human and social services resources that are available at a location.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "communication",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-communication",
              "type": "string",
              "documentation": "Search for human and social services by the language in which services are delivered."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "program",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-program",
              "type": "token",
              "documentation": "Search for human and social services by the program under which this service is delivered."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-category",
              "type": "token",
              "documentation": "Search for human and social services by the specified category of service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type",
              "type": "token",
              "documentation": "Search for human and social services by the specified type of service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "type": "token",
              "documentation": "Search for human and social services by the specified status of service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "type": "string",
              "documentation": "Search for human and social services by the specified status for the service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "location",
              "type": "reference",
              "documentation": "Search for human and social services offered at the specified location."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "organization",
              "type": "reference",
              "documentation": "Search for human and social services offered by the specified organization."
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "search-system"
        }
      ]
    }
  ]
}