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

FHIR Human Services Directory, published by HL7 Human and Social Services Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/FHIR-IG-Human-Services-Directory/ and changes regularly. See the Directory of published versions

Resource Profile: HSDHealthcareService

Official URL: http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: 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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... newpatients 0..0(Complex)
... deliverymethod 0..0(Complex)
... identifier 0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1Reference(Organization)Organization that issued id (may be just text)
... active S1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy S1..1Reference(HSDOrganization)Organization that provides this service
... category 1..1CodeableConceptThis is an example value set. In addition to the Plan-Net codes defined in this IG, concepts drawn from the 211 LA or Open Eligibility taxonomies as well as the FHIR SDOHCC ValueSet SDOH Category could be used until the social care community recommends an appropriate standard.
Binding: Human Service Category VS (example)
... type 0..*CodeableConceptThis is an example value set. In addition to the Plan-Net codes defined in this IG, concepts drawn from either the 211 LA or Open Eligibility taxonomies could be used until the social care community recommends an appropriate standard.
Binding: Human Service Type VS (example)
... specialty 0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Non-Individual Specialties (preferred)
... location S0..*Reference(HSDLocation)Location(s) where service may be provided
... name S0..1stringDescription of service as presented to a consumer while searching
... comment 0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo 0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... contactpoint-availabletime 0..0(Complex)
.... via-intermediary 0..0Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)
.... service-contactinfo 0..*(Complex)Additional contact information for services
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... rank 0..1positiveIntSpecify preferred order of use (1 = highest)
.... period 0..1PeriodTime period when the contact point was/is in use
... coverageArea 0..*Reference(HSDLocation)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... code 0..1CodeableConceptCoded value for the eligibility
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptThis example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver.
Binding: Human Service Program VS (example)
... characteristic 0..*CodeableConceptThis example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations.
Binding: Human Service Characteristic VS (example)
... communication 0..*CodeableConceptThe language that this service is offered in
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HealthcareService.categoryexampleHumanServiceCategoryVS
HealthcareService.typeexampleHumanServiceTypeVS
HealthcareService.specialtypreferredNonIndividualSpecialtiesVS
HealthcareService.programexampleHumanServiceProgramVS
HealthcareService.characteristicexampleHumanServiceCharacteristicVS

 

Other representations of profile: CSV, Excel, Schematron