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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Human Services Directory Capability Statement

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. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access. Human Services Directory Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

healthcareservice-active

Select Human and social services by the specified active status

healthcareservice-communication

Select Human and Social services that can be delivered by the organization in the specified language

healthcareservice-location

Select Human and social services offered at the specified location

healthcareservice-name

Select HealthcareServices with the specified name

healthcareservice-organization

Select Human and Social services offered by the specified organization

healthcareservice-program

Select Human and Social services offered under the specified program

healthcareservice-service-category

Select Human and social services by the specified category

healthcareservice-service-type

Select Human and social services by the specified type

location-accessibility

Select locations by the specified accessibility options offered by the location.

location-address

Select locations within the specified address

location-address-city

Select locations within the specified city

location-address-country

Select locations by the country specified in the address

location-address-postalcode

Select locations within the specified postal code

location-address-state

Select locations within the specified state

location-hoursofoperation

Select locations by the country specified in the address

location-name

Select locations with the specified name

location-organization

Select locations managed by the specified organization

organization-address

Select organizations with the specified address (matches any of the string elements of an address)

organization-address-city

Select organizations within the specified city

organization-address-country

Select organizations by the country specified in an address

organization-address-postalcode

Select organizations within the specified postal code

organization-address-state

Select organizations within the specified state

organization-identifier

Select organizations with the specified identifier (Tax ID) supported as an organization identifier

organization-name

Select organizations by (a portion of) the organization’s name

organization-type

Select organizations by (a code for) the type of organization

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

HSDHealthcareService

The HSD HealthcareService profile was introduced in STU 1 of this guide to allow example value sets that are used to search human and social service directories, because based on guidance from the human and social services community, existing human and social services taxonomies have not been deemed suitable for use in the relevant value sets. This profile isbased on the R4 HealthcareService resource, and fully aligned (as opposed to derived from) the Plan-Net HealthcareService profile which enforces use of extensible bindings to the category and type elements. This profile describes the way a human/social service can be contacted to assist patients and clients with unmet social needs. Examples include food, housing/shelter, income & employment, public transportation, public education, legal services, disability and aging and mental and physical health.

HSDLocation

The HSDLocation resource describes the physical place where community-based services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.

HSDOrganization

The HSDOrganization resource is a formal or informal grouping of people or organizations set up to assist people in coping with issues related to various social issues, including but not limited to: adequate housing, substance abuse, domestic conflict, mental health and/or personal/familial problems. Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Community-Based Organization Contacts

An extension to describe the additional details for named contacts for organizations not included in the contact.telecom element.

Community-Based Services Contacts

An extension to describe the additional details for named contacts for services not included in the telecom element.

Qualification

An extension to add qualifications for an organization (e.g. accreditation).

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Human Service Category VS

This example value set includes a subset of codes included in the Plan-Net Healthcare Service Category value set (HealthcareServiceCategoryVS).

Human Service Characteristic VS

This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations.

Human Service Program VS

This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver.

Human Service Type VS

This example value set includes an subset of service-types codes included in the Plan-Net Healthcare Service Type value set (HealthcareServiceTypeVS).

Non-Individual Specialties

Non-Individual Specialties from National Uniform Claim Committee (NUCC) Health Care Provider Taxonomy code set copied from Plan-Net used to allow example value set binding in HSDOrganization profile.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Human Service Characteristic

This example code system provides an example set of codes that describe unique features that can be associated with community-based social services delivered at particular locations.

Human Service Program

This example code system provides an example set of codes that describe Programs under which community-based organizations can organize the social services they deliver.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

FoodBank

Community-Based Organization that provides food pantry services. Since the HSDS source for Organizations does not include organization address, address information has been omitted from the examples. Address information is associated with the locations at which services provided by community-based organizations are provided. In addition, information that is mapped from the HSDS Contact table is mapped to a new extension: OrgContactInfo.

FoodBankLocation

Locations associated with services provided by the Redwood Food Bank

FoodPantryService

Food Pantry Services provided by a Community-Based Organization (CBO)

MealsOnWheels

Food assistance provided to the elderly and low income at their homes.

MealsOnWheelsLocation

Locations associated with services provided by Meals on Wheels

SF9114AllLocation

Locations associated with crisis and domestic violence services provided by Whistlestop Wheels

SFCrisisAndDomesticHotline

Community-Based Organization that provides emergency crisis hotline services. Since the HSDS source for Organizations does not include organization address, address information has been omitted from the examples. Address information is associated with the locations at which services provided by community-based organizations are provided. In addition, information that is mapped from the HSDS Contact table is mapped to a new extension: OrgContactInfo.

SFCrisisAndDomesticHotlineServices

Crisis Hotline Services provided by the Crisis Hotline of San Francisco

WhistlestopTransportationService

Transportation services for the disabled and elderly.

WhistlestopWheels

Community-Based Organization that provides food pantry services. Since the HSDS source for Organizations does not include organization address, address information has been omitted from the examples. Address information is associated with the locations at which services provided by community-based organizations are provided. In addition, information that is mapped from the HSDS Contact table is mapped to a new extension: OrgContactInfo.

WhistlestopwheelsLocation

Locations associated with transportation services provided by Whistlestop Wheels