HSDHealthcareService - Mappings - FHIR Human Services Directory v1.0.0

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

Resource Profile: HSDHealthcareService - Mappings

Page standards status: Trial-use

Maturity Level: 2

Mappings for the hsds-HealthcareService resource profile.

Mappings for RIM Mapping (http://hl7.org/v3)

HSDHealthcareService

HealthcareService

Entity. Role, or Act, act[classCode=ACT][moodCode=DEF]

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

HSDHealthcareService

HealthcareService

identifier

FiveWs.identifier

active

FiveWs.status

Mappings for HSDS (HSDS)

This section describes the way HSDS version 2.0.1 elements are mapped from HSDS tables to the FHIR HSDHealthcareService profile. The left hand column contains the FHIR HSDHealthcareService element name; the right hand column contains the HSDS table.element and any implementation/transformation rules required to support the mapping. The HSDS specification (v.2.0.1) served as the initial basis for requirements, and the mapping/alignment of HSDS data elements to profiles contained in the FHIR IG for Human Service Directories, STU1. HSDS Version 2.0.1 applies string datatypes to nearly all HSDS table 'id' fields/ data elements, including the id field associated with each HSDS [table] (e.g. organization.id [organization], location.id [location], service.id [service], phone.id [phone], etc.)). In the next version of HSDS, v.3.0, each HSDS table.id field will be defined using the UUID data type. FHIR Resource .ids (and the .ids in their profiles) are defined using the FHIR id datatype, a string that supports "Any combination of upper- or lower-case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)". Because UUIDs provide uniqueness to data/resources when they are exchanged across multiple systems, it is recommended that implementers of the FHIR IG for Human Services Directories support UUIDs in all HSDS id fields that are mapped to FHIR .id data elements.

HSDHealthcareService

HealthcareService

service.id Note: Each service must have a unique identifier.

category

category.coding.system = 'http://211hsis.org' category.coding.code = taxonomy_term.term cateory.coding.display = taxonomy_term.description category.text = taxonomy_term.description Note: This mapping is to the service category level taxonomy term that will be a parent to service type level taxonomy term. Linkage to category level term is from service.id = service_attribute_id, service_attribute.taxonomy_term_id = taxonomy_term.id, (child) taxonomy_term.parent.id = (parent) taxonomy_term.id. This assumes a two-level hierarchy of taxonomy terms. If there are more levels of hierarchy, then this will require traversing through the hierarchy until category level taxonomy_term parent is reached. Service Category binding will be to specific concepts from 211 Human Services Indexing System.

type

specialty

No Source. Note: This is a GAP in HSDS. specialty is defined as Must Support in the Plan-Net profile but optional element. The Plan-Net profile defines as required binding to valueset that refers to the standardized NUCC taxonomy https://taxonomy.nucc.org/. However, this taxonomy does not contain most of the human services specific provider types (except 332U00000X: Home Delivered Meals). This mapping will be ignored for the time being until NUCC is extended to include human service providers and HSDS is modified to include the specialty of providers who can provide this service.

location

reference.reference = service_at_location.location_id reference.type = 'Location' reference.display = location.name Note: This element is of data type Reference that refers to the location resource where a given service can be provided. Linkage to location is service.id = service_at_location.service_id, service_at_location.location_id = location.id. There may be multiple locations for a given service. Since FHIR location is an array (list), each location will be populated in an individual position in the array.

name

service.name

comment

No Source. Note: This is a GAP in HSDS. There is no comment or description for a service. There is a description in service_at_location but that will not be just specific to service but the combination of service and location.

extraDetails

Fixed value 'Funding Source:' appended with funding.source Note: Ths data element name extraDetails is not obvious about its content and this mapping to the funding source is not a direct mapping. Therefore it is advised to map this as a name-value pair, i.e., add a label before the value e.g., 'Funding Source '. Linkage to the funding source is service.organiztion_id = funding.organization_id and service.id = funding.service_id. If there are multiple funding sources for this combiation, they are concatenated.

photo

No Source. May be excluded from the mapping. Note: This is a GAP in HSDS.

telecom

Note: This FHIR structure contains contact details of the service using the ContactPoint datatype (Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.).

No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email or website URL).

extension (service-contactinfo)

This is a GAP in FHIR. Created a new extension: service-contactinfo to map HSDS contact.name, contact.title, contact.department, and contact.email

system

For Phone: if phone.type = 'voice' then system = 'phone' if phone.type = 'cell' then system = 'phone' if phone.type = 'fax' then system = 'fax' if phone.type = 'pager' then system = 'pager' if phone.type = 'text' then system = 'sms' if phone.type = 'textphone' then system = 'sms' if phone.type = 'video' then system = 'other' For Email: Fixed value = 'email' For Website URL: Fixed value = 'url' Note: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' or 'url' depending on the data populated. Drawn from the ContactPointSystem value set [http://hl7.org/fhir/ValueSet/contact-point-system]

value

For Phone: value = phone.number For Email, value = service.email For Website URL: value = service.url Note: For phone, HSDS service linkage is to phone table using service.id = phone.service_id.

use

Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work-related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html.

rank

No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.

period

No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.

coverageArea

reference.display = service_area.service_area Note: FHIR HealthcareService.coverageArea is a reference of location resource so service_area cannot be directly used. Although generally not recommended, this is mapped to Reference.display since there is no other corresponding data element in FHIR to HSDS service area. If there are multiple service_area records for a given service, they are concatenated to make a single string.

serviceProvisionCode

No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. That element is the code describing healthcare service provision conditions such as 'free', 'disc' or 'cost'.

eligibility

No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. Eligibility is currently out of scope for this release of the IG as Eligibility is not addressed by the HSDS eligibility specification (insufficient details to capture eligibility details as only a primary key (eligibility.id) and eligibility.service_id are included in the table.)

No Source. May be excluded from the mapping.

code

No Source. May be excluded from the mapping.

comment

No Source. May be excluded from the mapping.

program

program[0].text = program.name Note: Since HSDS does not have any code for the program, only the text element of codeableConcept is mapped. Also, the program data element in FHIR is an array (list), so the program name from HSDS is populated in the first occurrence of the array.

characteristic

characteristic[0].text = service.interpretation_services Note: This is not an obvious mapping but interpretation services is one of the characteristics of the service provision. Also, this data element in FHIR is an array (list), so the interpretation services data from HSDS is populated in the first occurrence of the array.

communication

communication[0].text = language.language. Note: This data element in FHIR is an array (list), so the language from HSDS is populated in the first occurrence of the array.

referralMethod

No Source. May be excluded from the mapping. Note: This is a GAP in HSDS.

appointmentRequired

No Source. Note: This is a GAP in HSDS.

availableTime

Note: This structure identifies the days/times during a week this service may be provided. Linkage to the schedule is from service.id = schedule.service_id.

schedule.id Note: This data element may be ignored as having the id for the schedule record isn't essential.

extension

extension[0].valueSting = schedule.description Note: This is not an obvious mapping but the extension is available to provide additional details. Since the extension is an array (list), the description will be populated in the first occurrence of the extension.

daysOfWeek

schedule.byday Note: This is a comma-separated value of days of the week. e.g. SU,MO,TU,WE,TH,FR,SA. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is last Friday.

allDay

No Source. Note: This is a GAP in HSDS. May be derived from other HSDS data elements but may not be an accurate representation.

availableStartTime

schedule.opens_at Note: This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)

availableEndTime

schedule.closes_at Note: This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)

notAvailable

No Source. Note: This is a GAP in HSDS.

availabilityExceptions

No Source. Note: This is a GAP in HSDS. This is a Must Support but an optional element in the base Plan-Net profile.

endpoint

No Source. Note: This is for the technical implementation of web services for the healthcare service and it is not for source-specific business data. It is marked as Must Support though optional in the Plan-Net profile. At this point, no service- specific web services have been identified so it may be ignored.