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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: HSDOrganization - Mappings

Page standards status: Trial-use

Maturity Level: 2

Mappings for the hsds-Organization resource profile.

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

HSDOrganization
Organization	Organization
identifier	./Identifiers, n/a
identifier (NPI)	./Identifiers, n/a
identifier (CLIA)	./Identifiers, n/a
identifier (IRS)	./Identifiers, n/a
system	./IdentifierType
value	./Value
period	./StartDate and ./EndDate
assigner	./IdentifierIssuingAuthority
active	./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
type	n/a
name	.PreferredName/Name, ./PrimaryAddress and ./OtherAddresses
telecom	./ContactPoints
system	./ContactPointType
value	./Value
use	./ContactPointPurpose
period	./StartDate and ./EndDate
contact
telecom
system	./ContactPointType
value	./Value
use	./ContactPointPurpose
period	./StartDate and ./EndDate

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

HSDOrganization
Organization	(also see master files messages)
identifier	XON.10 / XON.3
identifier (NPI)	XON.10 / XON.3
identifier (CLIA)	XON.10 / XON.3
identifier (IRS)	XON.10 / XON.3
use	N/A
type	CX.5
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
active	No equivalent in HL7 v2
type	No equivalent in v2
name	XON.1
telecom	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
contact
name	PID-5, PID-9
telecom	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	PID-11

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

HSDOrganization
Organization	Entity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
meta
id	n/a
extension	n/a
text	Act.text?
contained	N/A
extension
extension (qualification)
id	n/a
extension
extension (identifier)
id	n/a
url	N/A
value[x]	N/A
extension (code)
id	n/a
url	N/A
value[x]	N/A
extension (issuer)
id	n/a
url	N/A
value[x]	N/A
extension (status)
id	n/a
url	N/A
value[x]	N/A
extension (period)
id	n/a
url	N/A
value[x]	N/A
extension (whereValid)
id	n/a
url	N/A
value[x]	N/A
url	N/A
modifierExtension	N/A
identifier	.scopes[Role](classCode=IDENT)
identifier (NPI)	.scopes[Role](classCode=IDENT)
identifier (CLIA)	.scopes[Role](classCode=IDENT)
identifier (IRS)	.scopes[Role](classCode=IDENT)
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	Role.effectiveTime or implied by context
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
active	.status
type	.code
name	.name
alias	.name
telecom	.telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
contact	.contactParty
id	n/a
extension	n/a
modifierExtension	N/A
purpose	./type
name	./name
telecom	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	./addr
endpoint	n/a

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

HSDOrganization
Organization
identifier	FiveWs.identifier
identifier (NPI)	FiveWs.identifier
identifier (CLIA)	FiveWs.identifier
identifier (IRS)	FiveWs.identifier
active	FiveWs.status
type	FiveWs.class

Mappings for HSDS (HSDS)

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

HSDOrganization
Organization
id	organization.id Note: Each organization must have a unique system identifier in the source system.
meta	Note: The HSDS metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.
id	metadata.id Note: This data element may be ignored as having the id for the date metadata isn't essential. If populated, it should be id corresponding to the latest action date for given organization as described below.
lastUpdated	metadata.last_action_date Note: The date when data was changed. Since there may be more than one metadata record for each organization, the latest max(last_action_date) needs to be used from metadata where (FHIR) Organization.id = (HSDS) metadata.resource_id.
text	No Source. May be excluded from the mapping. Note: This DomainResource.text is meant for textual summary of the resource so organization description is mapped to the org-description extension added by Plan-Net profile.
extension (qualification)	extension[qualification]:code.url = 'code' extension[qualification]:code.valueCodeableConcept.text = service.accreditations Note: This is a GAP in HSDS that can be resolved by having qualifications collected at the organization level. As a workaround, suggested mapping uses the unique set of accreditations from service and concatenated for the organization level as described below.
extension (org-description)	organization.description Note: This Plan-Net profile added this extension for organization description as opposed to using DomainResource.text data element which is meant for textual summary of the resource.
identifier
identifier (NPI)	NPI identifiers are not relevant to the identification of community based organizations at this time.
identifier (CLIA)	CLIA identifiers are also currently not relevant for use in the identification of community based organizations.
identifier (IRS)	For Community Based Organizations, the closest identifier usedfor the purpose of identifying the organization is a government issued identifier used for the purpose of tax administration.
id	No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the identifier record isn't essential and is not available in HSDS since the tax ID is directly on the organization table.
use	Fixed value = 'official' Note: Since the organization business identifier in HSDS is organization.tax id which is used for official purpose, this element is to be set with a fixed value 'official' drawn from the code system IdentifierUse http://hl7.org/fhir/identifier-use.
type	Fixed value = 'TAX' Note: Since the organization business identifier in HSDS is organization.tax id which is used for the tax, this element is to be set with a fixed value 'TAX' drawn from the IdentifierType code system – http://terminology.hl7.org/CodeSystem/v2-0203 [an HL7-defined code system of concepts specifying type of identifier].
system	Fixed value = 'urn:us:gov:irs' Note: Since the organization business identifier in HSDS is organization.tax id which is issued by IRS, this element is to be set with a fixed value with IRS URN.
value	organization.tax_id Note: This is the only business identifier in HSDS at this time.
period	organization.year_incorporated Note: HSDS organization.year_incorporated may not always be the same as when the TAX ID was issued (especially if a company merged or split). Technically year_incorporated is a GAP in FHIR and should be added as an extension. Also the effective date of the identifier (mapped to period here) is GAP in HSDS. But until both of those GAPs are addressed, the above mapping is proposed as a work around.
assigner
display	Fixed value = 'www.irs.gov' Note: This is GAP in HSDS but it can be implicitly inferred. Since the organization business identifier in HSDS is organization.tax id which is issued by IRS, this element is to be set with a fixed value with IRS website link as a reference.
active	Fixed value = 'true' Note: HSDS organization does not have a status but this is required in FHIR so fixed value is proposed to indicate that organization is active.
type	Any code is allowed from the type.system = 'http://hl7.org/fhir/us/DaVinci-pdex-plan-net/ValueSet/OrgTypeVS' Note: This is a GAP in HSDS but a required Must Support element in the Plan-Net profile.
name	organization.name
alias	organization.alternate_name Note: Since there is only one alternate name in HSDS but the alias is an array (list) in FHIR, this will map to the first occurrence of the array.
telecom	Note: This FHIR structure contains contact details of the organization using the ContactPoint datatype (Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.).
id	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).
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 = organization.email For Website URL: value = organization.url Note: For phone, HSDS organization linkage is to HSDS phone table using organization.id = phone.organization_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. 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 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.
contact	Note: contact Table The HSDS contact table contains details of the named contacts associated with the organization. This linkage is based on FHIR organization.id = HSDS contact.organization_id. If there are multiple contacts, all of those can be included for organization level contacts in FHIR since there is no indication to identify which contact is primary.
id	contact.id Note: This data element may be ignored as having the id for the contact record isn't essential.
purpose	No Source. May be excluded from the mapping. Note: This is a GAP In HSDS. In FHIR, this element is used to indicate the purpose of which the contact can be reached.
name	contact.name
telecom	No Source. May be excluded from the mapping.
id	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).
extension (org-contactinfo)	This is a GAP in FHIR. Created a new extension org-contactinfo to map HSDS 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' 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' depending on the data populated.
value	For Phone: value = phone.number For Email, value = conact.email Note: For phone, HSDS contact table will be linked to the phone table using contact.id = phone.contact_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. GAP in HSDS. 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.GAP in HSDS. 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.
address	No Source. GAP in HSDS. Addresses are only associated with locations in the HSDS model.
endpoint	No Source. Note: This is for the technical implementation of web services for the organization 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 organizayion specific web services have been identified so it may be ignored.