FHIR-Based Terminology Translation
As of the 2023.02.R01 release of Smile CDR, the HL7 v2.x Listening Endpoint module uses FHIR ConceptMap resources to encode the table-based portion of the HL7 v2-to-FHIR translation. As an example, Table 0004 (Patient Class), used in PV1-12, maps to http://terminology.hl7.org/CodeSystem/v3-ActCode
, used in Encounter.class
.
If the HL7 v2.x Listening Endpoint module declares a dependency on a Validation Support module, concept mappings between HL7 v2.x tables and FHIR Resource concepts are now stored and managed in automatically created ConceptMap resources. When the HL7 v2.x Listening Endpoint module starts, all required ConceptMap resources will be automatically created in the FHIR Storage (RDBMS) module that is used as a validation support dependency.
Users can update these automatically created ConceptMap resources in order to update the mappings applied at runtime. Note that changes to the live ConceptMap resources may take up to 1 minute to take effect due to internal caching. If such a resource is deleted, it will be recreated at the next module boot, with pre-existing defaults.
The following is a table which summarizes the information surrounding this new ConceptMap-based terminology translation.
HL7 v2.x Table | FHIR Field | ConceptMap Canonical URI |
PID-8 (Administrative Sex) | Patient.gender |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0001ToFhirAdministrativeGender
|
PID-16 (Marital Status) | Patient.maritalStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0002ToFhirMaritalStatus
|
PV1-2 (Patient Class) | Encounter.class |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0004ToFhirActCode
|
MSH-2-9 (Message Trigger) | Encounter.status |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0003ToFhirEncounterStatus
|
ORC-5 (Status) | ServiceRequest.status |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0038ToFhirRequestStatus
|
OBR-24 (Diagnostic Service Section ID) | DiagnosticReport.category |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0074ToFhirDiagnosticServiceSectionId
|
ORC-1 (Order Control) | MedicationRequest.MedicationRequestStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0119AToFhirMedicationRequestStatus
|
ORC-1 (Order Control) | Immunization.ImmunizationStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0119BToFhirImmunizationStatus
|
OBR-25 (Result Status) | DiagnosticReport.status |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0123ToFhirDiagnosticReportStatus
|
IAM-2 (Allergen Type Code) | AllergyIntolerance.AllergyIntoleranceCategory |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0127ToFhirAllergyIntoleranceCategory
|
IAM-4 (Allergy Severity Code) | AllergyIntolerance.AllergyIntoleranceCriticality |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0128ToFhirAllergyIntoleranceCriticality
|
XAD-7 (Address Type) | Address.AddressType |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0190AToFhirAddressType
|
XAD-7 (Address Type) | Address.AddressUse |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0190BToFhirAddressUse
|
PID-13 (Phone/Telecom List - Home) | ContactPoint.ContactPointUse |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0202AToFhirContactPointUse
|
PID-13 (Phone/Telecom List - Home) | ContactPoint.ContactPointSystem |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0202BToFhirContactPointSystem
|
SCH-7 (Appointment Reason) | Appointment.reasonCode |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0276ToFhirAppointmentReason
|
SCH-25 (Filler Status) | Appointment.status |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0278ToFhirAppointmentStatus
|
AIL (Location Resource) | Location.type |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0305ToFhirRoleCode
|
RXA-20 (Completion Status) | MedicationAdministration.MedicationAdministrationStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0322AToFhirMedicationAdminStatusCodes
|
RXA-20 (Completion Status) | Immunization.ImmunizationStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0322BToFhirImmunizationStatus
|
IAM-17 (Clinical Status) | clinicalStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0438AToFhirAllergyIntoleranceClinicalStatusCodes
|
IAM-17 (Clinical Status) | verificationStatus |
https://smilecdr.com/fhir/ns/ConceptMap/HL7v2/HL7v2Table0438BToFhirAllergyIntoleranceVerificationStatusCodes
|