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

Resource Profile: HSDLocation - Mappings

Page standards status: Trial-use Maturity Level: 2

Mappings for the hsds-Location resource profile.

Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)

HSDLocation
LocationOrganization
   identifier
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   name./PrimaryAddress and ./OtherAddresses
   telecom
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   addressn/a
      use./AddressPurpose
      line./StreetAddress (newline delimitted)
      city./Jurisdiction
      state./Region, ./Sites
      postalCode./PostalIdentificationCode
      country./Country
      period./StartDate and ./EndDate

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

HSDLocation
LocationEntity. Role, or Act, .Role[classCode=SDLC]
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   modifierExtensionN/A
   identifier.id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   status.statusCode
   operationalStatusn/a
   name.name
   alias.name
   description.playingEntity[classCode=PLC determinerCode=INSTANCE].desc
   telecom.telecom
      idn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   address.addr
      idn/a
      extensionn/a
      useunique(./use)
      typeunique(./use)
      text./formatted
      lineAD.part[parttype = AL]
      cityAD.part[parttype = CTY]
      districtAD.part[parttype = CNT | CPA]
      stateAD.part[parttype = STA]
      postalCodeAD.part[parttype = ZIP]
      countryAD.part[parttype = CNT]
      period./usablePeriod[type="IVL<TS>"]
   physicalType.playingEntity [classCode=PLC].code
   position.playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
      idn/a
      extensionn/a
      modifierExtensionN/A
      longitude(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
      latitude(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
      altitude(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
   managingOrganization.scopingEntity[classCode=ORG determinerKind=INSTANCE]
   hoursOfOperation.effectiveTime
      idn/a
      extensionn/a
      modifierExtensionN/A
      daysOfWeek.effectiveTime
      allDay.effectiveTime
      openingTime.effectiveTime
      closingTime.effectiveTime
   availabilityExceptionsn/a
   endpointn/a

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

HSDLocation
Location
   identifierFiveWs.identifier
   statusFiveWs.status
   operationalStatusFiveWs.status
   physicalTypeFiveWs.class

Mappings for HSDS (HSDS)

This section describes the way HSDS version 2.0.1 elements are mapped from HSDS tables to the FHIR HSDLocation profile. The left hand column contains the FHIR HSDLocation 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.

HSDLocation
Location
   metaNote: The HSDS metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.
      lastUpdatedmetadata.last_action_date Note: The date when data was changed. Since there may be more than one metadata record for each location, the latest max(last_action_date) needs to be used from metadata where location.id = metadata.resource_id.
   textNo Source. May be excluded from the mapping. Note: This DomainResource.text is meant for textual summary of the resource.
   extension (accessibility)For ADA compliant disability options: location.extension:accessibility.value[x] = HSDS location.transportation location.extension:accessibility.url = 'pubtrans'; For public transportation: location.extension:accessibility.value[x]= accessibility_for_disabilities.accessibility location.extension:accessibility.url = 'adacomp'. Note: This FHIR extension describes accessibility options offered by the location. Based on the the Accessibility valuset defined for this extension i.e. http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/AccessibilityVS, there are two different data sources in HSDS that may be mapped. However, the HSDS source for this is not coded data so the content in value may not be in sync with the code used as extension.url.
   extension (location-boundary-geojson)No Source. Note: This is a GAP in HSDS. This is a Plan-Net extension to represent the location boundary in GEOJson format as an Attachment data type.
   identifierNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      idNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      useNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      typeNo Source. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      systemNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      valueNo Source. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      periodNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
      assignerNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.
   statusFixed value = 'active' Note: HSDS location does not have a status but this is required in FHIR so fixed value is proposed to indicate that location is active.
   namelocation.name
   aliaslocation.alternate_name
   descriptionlocation.description While description is not unique in HSDS model, US Core limits description cardinality to 0..1
   telecom
      extensionNo Source. Phone extension is a GAP in HSDS.
      systemif 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' Note: There are only phone numbers in HSDS for location telecom data so the type will not include 'email' or 'url'. Drawn from the ContactPointSystem value set [http://hl7.org/fhir/ValueSet/contact-point-system]
      valuephone.number Note: For phone, HSDS location table will be linked to the phone table using location.id = phone.location_id. There are only phone numbers in HSDS for location telecom data so the value will not include any email or url records.
      useFixed 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.
      rankNo Source. May be excluded from the mapping. Note: This 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 iit can be excluded since there is no source.
      periodNo 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.
   addressNote: In HSDS,two address tables are used, one for postal_address, the other for physical_address. This linkage is based on location.id = address.location_id. If there are multiple addresses, only the latest one will be used to populate the FHIR address data since it allows only one address.
      idpostal_address.id or physical_address_id Note: This data element may be ignored as having the id for the address record isn't essential. If populated, it should be the id from one of the address tables that particular address is referring to.
      useFixed 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 AddressUse value set http://hl7.org/fhir/R4/valueset-address-use.html.
      typeFixed value = 'postal' or 'physical' Note: This is a GAP in HSDS but it can be inferred by which table is used as a source in the HSDS i.e. postal_address or physical_address respectively.
      textConcatenation of address_1, city, state_province, postal_code and country; all separated by comma (,) except dash (-) between state_province and postal_code. Note: The address data elements will be from postal_address or physical_address depending on which address is sourced. In FHIR, this element specifies the entire address as it should be displayed.
      linepostal_address.address_1 or physical_address.address_1 Note: address.line in FHIR is an array (list) so address_1 is populated in the first position of the array. If address_2 is available (although deprecated in HSDS), it may be populated in the second position of the array.
      citypostal_address.city or physical_address.city
      districtpostal_address.region or physical_address.region
      statepostal_address.state_province_code or physical_address.state_province_code
      postalCodepostal_address.postal_code or physical_address.postal_code
      countrypostal_address.country or physical_address.country
      periodNo Source. May be excluded from the mapping. Note: This a GAP in HSDS. In FHIR, this data element represents the time period when the address was in use for the location.
   physicalTypeNo Source. May be excluded from the mapping. Note: This is a GAP in HSDS. This element is bound to an example value set location-physical-type that defines a set of codes to indicate the physical form of the Location.
   positionThe absolute geographic location in FHIR
      idNo Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the position record is not essential and not available in HSDS.
      longitudelocation.longitude Note: X coordinate of location expressed in decimal degrees in WGS84 datum.
      latitudelocation.latitude Note: Y coordinate of location expressed in decimal degrees in WGS84 datum.
      altitudeGAP in HSDS, optional element in FHIR.
   managingOrganizationlocation.organization.id
   hoursOfOperationNote: This structure identifies the days/times during a week this location is usually open. Linkage to schedule is from location.id = schedule.location_id.
      idschedule.id Note: This data element may be ignored as having the id for the schedule record isn't essential.
      daysOfWeekschedule.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.
      allDayNo Source. Note: This is a GAP in HSDS. May be derived from other HSDS data elements but may not be an accurate representation.
      openingTimeschedule.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.)
      closingTimeschedule.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.)
   availabilityExceptionsNo Source. Note: This is a GAP in HSDS. This is a Must Support but optional element in the base Plan-Net profile.
   endpointNo Source. Note: This is for the technical implementation of web services for the location 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 location-specific web services have been identified so it may be ignored.