This page contains table definitions for HL7 v2.x messages.
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| M | Male | http://hl7.org/fhir/administrative-gender | male |
| F | Female | http://hl7.org/fhir/administrative-gender | female |
| O | Other | http://hl7.org/fhir/administrative-gender | other |
| U | Unknown | http://hl7.org/fhir/administrative-gender | unknown |
Note: This link has been updated from its DSTU3 version (http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender) as of August 2021.
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/v3/MaritalStatus) as of August 2021.
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| I | Inpatient | http://terminology.hl7.org/CodeSystem/v3-ActCode | IMP |
| E | Emergency | http://terminology.hl7.org/CodeSystem/v3-ActCode | EMER |
| O | Outpatient | http://terminology.hl7.org/CodeSystem/v3-ActCode | AMB |
| A | Ambulatory | http://terminology.hl7.org/CodeSystem/v3-ActCode | AMB |
| P | Pre-Admission | http://terminology.hl7.org/CodeSystem/v3-ActCode | PRENC |
| R | Recurring Patient | http://terminology.hl7.org/CodeSystem/v2-0004 | R |
| B | Obstetrics | http://terminology.hl7.org/CodeSystem/v2-0004 | B |
Note: These links have been updated from their DSTU3 versions (http://hl7.org/fhir/v3/ActCode and http://hl7.org/fhir/v2/0004) as of August 2021.
Note: The values here are provided as examples only. Smile CDR does not require specific codes drawn from this table.
| Code | Description |
|---|---|
| A | Accident |
| E | Emergency |
| L | Labor and Delivery |
| R | Routine |
| N | Newborn (Birth in Healthcare Facility) |
| U | Urgent |
| C | Elective |
Note: The values here are provided as examples only. Smile CDR does not require specific codes drawn from this table.
| Code | Description |
|---|---|
| A0 | No functional limitations |
| A1 | Ambulates with assistive device |
| A2 | Wheelchair/stretcher bound |
| A3 | Comatose; non-responsive |
| A4 | Disoriented |
| A5 | Vision impaired |
| A6 | Hearing impaired |
| A7 | Speech impaired |
| A8 | Non-English speaking |
| A9 | Functional level unknown |
| B1 | Oxygen therapy |
| B2 | Special equipment (tubes, IVs, catheters) |
| B3 | Amputee |
| B4 | Mastectomy |
| B5 | Paraplegic |
| B6 | Pregnant |
| Code | Description |
|---|---|
| CG | Charge |
| CD | Credit |
| PY | Payment |
| AJ | Adjustment |
| CO | Co-Payment |
Note: No suggested codes are defined for this table. Any code may be used.
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| A | Some (but not all) Results Available | http://hl7.org/fhir/request-status | active |
| IP | In Progress Unspecified | http://hl7.org/fhir/request-status | active |
| CM | Completed | http://hl7.org/fhir/request-status | completed |
| DC | Discontinued | http://hl7.org/fhir/request-status | completed |
| HD | Hold | http://hl7.org/fhir/request-status | suspended |
| SC | Scheduled | http://hl7.org/fhir/request-status | draft |
| CA | Cancelled | http://hl7.org/fhir/request-status | cancelled |
| RP | Replaced | http://hl7.org/fhir/request-status | cancelled |
| ER | Error, Order Not Found | http://hl7.org/fhir/request-status | cancelled |
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| A | Admitting | http://terminology.hl7.org/CodeSystem/diagnosis-role | AD |
| W | Working | ||
| F | Final | http://terminology.hl7.org/CodeSystem/diagnosis-role | DD |
Note: For completeness, W is mapped to Encounter.diagnosis.role.text with a value of Working diagnosis.
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/diagnosis-role) as of August 2021.
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/v2/0063) as of August 2021.
Note: The values here are provided as examples only. Smile CDR does not require specific codes drawn from this table.
| Code | Description |
|---|---|
| MED | Medical Service |
| SUR | Surgical Service |
| URO | Urology Service |
| PUL | Pulmonary Service |
| CAR | Cardiac Service |
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/v2/0074) as of August 2021.
| Code | Description |
|---|---|
| L | Low |
| H | High |
| LU | Very low |
| HU | Very high |
| < | Off scale low |
| > | Off scale high |
| LL | Critically low |
| HH | Critically high |
| N | Normal |
| A | Abnormal |
| AA | Critically abnormal |
| U | Significant change up |
| D | Significant change down |
| B | Better |
| W | Worse |
| S | Susceptible |
| R | Resistant |
| I | Intermediate |
| MS | Moderately susceptible |
| NS | Non-susceptible |
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| O | Order Received; Specimen not yet received | http://hl7.org/fhir/observation-status | registered |
| P | Preliminary | http://hl7.org/fhir/observation-status | preliminary |
| I | Incomplete | http://hl7.org/fhir/observation-status | preliminary |
| F | Final | http://hl7.org/fhir/observation-status | final |
| C | Corrected | http://hl7.org/fhir/observation-status | corrected |
| X | Cancelled | http://hl7.org/fhir/observation-status | cancelled |
| U | Unknown | http://hl7.org/fhir/observation-status | unknown |
Note: That HL7 Table 0085 normally defines U as a results status change to final without retransmitting results already sent as preliminary; however, this interpretation is not supported when mapping from HL7 v2.x to FHIR as it doesn't make sense in this context. Instead Smile's HL7 v2.x inbound processor supports a mapping of U to unknown as a quality of life improvement, and to coincide with a similar mapping for Table 0123: Result Status. This is to support mapping of OBR-25 (Result Status) to Observation.status where OBX-11 (Observation Status) is not populated (refer to Field OBX-11 (Observation Status).
Note: No suggested codes are defined for this table. Any code may be used.
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| active | Active | http://hl7.org/fhir/account-status | active |
| inactive | Inactive | http://hl7.org/fhir/account-status | inactive |
| entered-in-error | Entered in error | http://hl7.org/fhir/account-status | entered-in-error |
| on-hold | On Hold | http://hl7.org/fhir/account-status | on-hold |
| unknown | Unknown | http://hl7.org/fhir/account-status | unknown |
| Code | Description | Domain | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|---|
| NW | New order/service request | Pharmacy | http://hl7.org/fhir/medication-request-status | active |
| DC | Discontinue order/service request | Pharmacy | http://hl7.org/fhir/medication-request-status | stopped |
| XO | Change order/service request | Pharmacy | http://hl7.org/fhir/medication-request-status | active |
| HD | Hold order request | Pharmacy | http://hl7.org/fhir/medication-request-status | on-hold |
| RL | Release previous hold | Pharmacy | http://hl7.org/fhir/medication-request-status | active |
| RE | Observations/performed service to follow | Pharmacy | http://hl7.org/fhir/medication-request-status | active |
| SC | Status changed | Pharmacy | http://hl7.org/fhir/medication-request-status | active |
| CA | Cancel order/service request | Pharmacy | http://hl7.org/fhir/medication-request-status | active |
| RE | Observations/performed service to follow | Immunizations | http://hl7.org/fhir/event-status | completed |
| CA | Cancel order/service request | Immunizations | http://hl7.org/fhir/event-status | not-done |
Note: This link has been updated from its DSTU3 version (http://terminology.hl7.org/CodeSystem/medicationrequest-status-reason) as of August 2021.
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| O | Order Received; Specimen not yet received | http://hl7.org/fhir/diagnostic-report-status | registered |
| P | Preliminary | http://hl7.org/fhir/diagnostic-report-status | partial |
| I | Incomplete | http://hl7.org/fhir/diagnostic-report-status | partial |
| F | Final | http://hl7.org/fhir/diagnostic-report-status | final |
| C | Corrected | http://hl7.org/fhir/diagnostic-report-status | corrected |
| X | Cancelled | http://hl7.org/fhir/diagnostic-report-status | cancelled |
| U | Unknown | http://hl7.org/fhir/diagnostic-report-status | unknown |
Note: That HL7 Table 0123 does not define a value of U. Smile CDR's HL7 v2.x inbound processor supports a mapping of U to unknown as a quality of life improvement, and to coincide with a similar mapping for Table 0085: Observation Status. This is to support mapping of OBR-25 (Result Status) to Observation.status where OBX-11 (Observation Status) is not populated (refer to Field OBX-11 (Observation Status)).
| Code | Description | Equivalent FHIR Datatype | ADT Support | ORU Support | MDM Support |
|---|---|---|---|---|---|
| ST | String data | string | |||
| TX | Text data | string | |||
| FT | Formatted text | string | |||
| NM | Numeric | Quantity | |||
| SN | Structured numeric | Quantity / Range / Ratio | |||
| DT | Date | date | |||
| TS | Time stamp | dateTime | |||
| TM | Time | time | |||
| CWE | Coded with exceptions | CodeableConcept / Coding | |||
| CE | Coded element | CodeableConcept / Coding | |||
| ED | Encapsulated data | base64Binary |
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| AA | Animal allergy | http://hl7.org/fhir/allergy-intolerance-category | environment |
| DA | Drug allergy | http://hl7.org/fhir/allergy-intolerance-category | medication |
| EA | Environmental allergy | http://hl7.org/fhir/allergy-intolerance-category | environment |
| FA | Food allergy | http://hl7.org/fhir/allergy-intolerance-category | food |
| LA | Pollen allergy | http://hl7.org/fhir/allergy-intolerance-category | environment |
| MA | Miscellaneous allergy | ||
| MC | Miscellaneous contraindication | ||
| PA | Plant allergy | http://hl7.org/fhir/allergy-intolerance-category | environment |
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/ValueSet/allergy-intolerance-category) as of August 2021.
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| SV | Severe | http://hl7.org/fhir/allergy-intolerance-criticality | high |
| MO | Moderate | http://hl7.org/fhir/allergy-intolerance-criticality | high |
| MI | Mild | http://hl7.org/fhir/allergy-intolerance-criticality | low |
| U | Unknown | http://hl7.org/fhir/allergy-intolerance-criticality | unable-to-assess |
Note: No suggested codes are defined for this table. Any code may be used.
| Code | Description | FHIR Mapping System |
|---|---|---|
| BP | Billing contact person | http://terminology.hl7.org/CodeSystem/v2-0131 |
| C | Emergency Contact | http://terminology.hl7.org/CodeSystem/v2-0131 |
| CP | Contact person | http://terminology.hl7.org/CodeSystem/v2-0131 |
| E | Employer | http://terminology.hl7.org/CodeSystem/v2-0131 |
| EP | Emergency contact person | http://terminology.hl7.org/CodeSystem/v2-0131 |
| F | Federal Agency | http://terminology.hl7.org/CodeSystem/v2-0131 |
| I | Insurance Company | http://terminology.hl7.org/CodeSystem/v2-0131 |
| N | Next-of-Kin | http://terminology.hl7.org/CodeSystem/v2-0131 |
| O | Other | http://terminology.hl7.org/CodeSystem/v2-0131 |
| PR | Person preparing referral | http://terminology.hl7.org/CodeSystem/v2-0131 |
| S | State Agency | http://terminology.hl7.org/CodeSystem/v2-0131 |
| U | Unknown | http://terminology.hl7.org/CodeSystem/v2-0131 |
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/v2/0131) as of August 2021.
| Code | Description |
|---|---|
| Y | Yes |
| N | No |
| Code | Description |
|---|---|
| A | Additive |
| B | Base |
| Code | Description |
|---|---|
| H | Home |
| L | Legal Address |
| P | Permanent |
| W | Work |
| B | Firm/Business |
| T | Temporary |
| O | Old/Previous |
| M | Mailing |
| Code | Description | FHIR Mapping System |
|---|---|---|
| AP | Other application data, typically uninterpreted binary data (HL7 V2.3 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| Application | Other application data, typically uninterpreted binary data (HL7 V2.3 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| AU | Audio data (HL7 V2.3 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| Audio | Audio data (HL7 V2.3 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| FT | Formatted text (HL7 V2.2 only) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| IM | Image data (HL7 V2.3 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| Image | Image data (HL7 V2.3 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| multipart | MIME multipart package | http://terminology.hl7.org/CodeSystem/v2-0191 |
| NS | Non-scanned image (HL7 V2.2 only) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| SD | Scanned document (HL7 V2.2 only) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| SI | Scanned image (HL7 V2.2 only) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| TEXT | Machine readable text document (HL7 V2.3.1 and later) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| TX | Machine readable text document (HL7 V2.2 only) | http://terminology.hl7.org/CodeSystem/v2-0191 |
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| L | Official | http://hl7.org/fhir/name-use | official |
| A | Anonymous | http://hl7.org/fhir/name-use | anonymous |
| B | Old (backwards compatibility) | http://hl7.org/fhir/name-use | old |
| M | Maiden Name | http://hl7.org/fhir/name-use | maiden |
| D | Designated | http://hl7.org/fhir/name-use | usual |
| N | Nickname / Alias Name | http://hl7.org/fhir/name-use | nickname |
| Code | Description |
|---|---|
| PRN | Home |
| WPN | Work |
| NET |
| Code | Description |
|---|---|
| PH | Phone |
| FX | Fax |
| CP | Mobile |
| BP | Beeper |
| Internet | URL |
| X.400 |
| Code | Description |
|---|---|
| MR | Patient Medical Record Number |
| VN | Visit/Encounter Number |
| AN | Account Number |
| PLAC | Placer Order Number |
| FILL | Filler Order Number |
| SB | Social Security Number |
Note: The values here are provided as examples only. Smile CDR does not require specific codes drawn from this table.
| Code | Description | FHIR Mapping System |
|---|---|---|
| DI | Dictated | http://terminology.hl7.org/CodeSystem/v2-0271 |
| DO | Documented | http://terminology.hl7.org/CodeSystem/v2-0271 |
| IP | In Progress | http://terminology.hl7.org/CodeSystem/v2-0271 |
| IN | Incomplete | http://terminology.hl7.org/CodeSystem/v2-0271 |
| PA | Pre-authenticated | http://terminology.hl7.org/CodeSystem/v2-0271 |
| AU | Authenticated | http://terminology.hl7.org/CodeSystem/v2-0271 |
| LA | Legally Authenticated | http://terminology.hl7.org/CodeSystem/v2-0271 |
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| AV | Available for patient care | http://hl7.org/fhir/document-reference-status | current |
| CA | Deleted | http://terminology.hl7.org/CodeSystem/v2-0273 | |
| OB | Obsolete | http://terminology.hl7.org/CodeSystem/v2-0273 | |
| UN | Unavailable for patient care | http://terminology.hl7.org/CodeSystem/v2-0273 |
| Code | Description | FHIR Mapping System | SNOMED Mapping Code | Description |
|---|---|---|---|---|
| ROUTINE | Routine appointment - default if not valued | http://hl7.org/fhir/ValueSet/encounter-reason | 308335008 | Patient encounter procedure (procedure) |
| WALKIN | A previously unscheduled walk-in visit | http://hl7.org/fhir/ValueSet/encounter-reason | 270427003 | Patient-initiated encounter (procedure) |
| CHECKUP | A routine check-up, such as an annual physical | http://hl7.org/fhir/ValueSet/encounter-reason | 185349003 | Encounter for check up (procedure) |
| FOLLOWUP | A follow up visit from a previous appointment | http://hl7.org/fhir/ValueSet/encounter-reason | 390906007 | Follow-up encounter (procedure) |
| EMERGENCY | Emergency appointment | http://hl7.org/fhir/ValueSet/encounter-reason | 373110003 | Emergency procedure (procedure) |
| Code | Description | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|
| Pending | Appointment not yet confirmed | http://hl7.org/fhir/appointmentstatus | pending |
| Waitlist | Waitlisted | http://hl7.org/fhir/appointmentstatus | waitlist |
| Booked | Booked | http://hl7.org/fhir/appointmentstatus | booked |
| Started | Appointment begun and in progress | http://hl7.org/fhir/appointmentstatus | checked-in |
| Complete | Appointment successfully completed | http://hl7.org/fhir/appointmentstatus | fulfilled |
| Cancelled | Cancelled | http://hl7.org/fhir/appointmentstatus | cancelled |
| Deleted | Deleted | http://hl7.org/fhir/appointmentstatus | entered-in-error |
| Noshow | Patient did not show up for appointment | http://hl7.org/fhir/appointmentstatus | noshow |
| Proposed | Appointment request not finalized | http://hl7.org/fhir/appointmentstatus | proposed |
| Arrived | Patient has arrived | http://hl7.org/fhir/appointmentstatus | arrived |
| Code | Equivalent MIME Type |
|---|---|
| DICOM | application/dicom |
| GIF | image/gif |
| application/pdf | |
| PNG | image/png |
| RTF | application/rtf |
| TIFF | image/tiff |
Note: These values correspond to Attachment.contentType.
| Code | Description | Comment |
|---|---|---|
| Base64 | Encoding as defined by MIME (Multipurpose Internet Mail Extensions) standard RFC 1521. Four consecutive ASCII characters represent three consecutive octets of binary data. Base64 utilizes a 65-character subset of US-ASCII, consisting of both the upper and lower case alphabetic characters, digits “0” through “9”, “+”, “/”, and “=”. | The Request For Comment (RFC) 1521 standard is available at: http://www.ietf.org/rfc/rfc1521.txt |
| Code | Description | FHIR Mapping System | FHIR Mapping Code | Description |
|---|---|---|---|---|
| C | Clinic | http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | PC | Primary care clinic |
| D | Department | http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | HU | Hospital unit |
| H | Home | http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | PTRES | Patient’s Residence |
| O | Provider's Office | http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | PROFF | Provider’s Office |
| S | SNF | http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | SNF | Skilled nursing facility |
| Code | Description | Domain | FHIR Mapping System | FHIR Mapping Code |
|---|---|---|---|---|
| CP | Complete | Pharmacy | http://terminology.hl7.org/CodeSystem/medication-admin-status | completed |
| RE | Refused | Pharmacy | http://terminology.hl7.org/CodeSystem/medication-admin-status | stopped |
| NA | Not Administered | Pharmacy | http://terminology.hl7.org/CodeSystem/medication-admin-status | stopped |
| PA | Partially Administered | Pharmacy | http://terminology.hl7.org/CodeSystem/medication-admin-status | in-progress |
| CP | Complete | Immunization | http://hl7.org/fhir/event-status | completed |
| RE | Refused | Immunization | http://hl7.org/fhir/event-status | not-done |
| NA | Not Administered | Immunization | http://hl7.org/fhir/event-status | not-done |
Note: This link has been updated from its DSTU3 version (http://hl7.org/fhir/medication-admin-status) as of August 2021.
Note: This table is used for HL7 v2.x field IAM-17 (Allergy Clinical Status). Values in this field are mapped to two separate fields in the FHIR AllergyIntolerance resource:
clinicalStatusverificationStatus| Code | Description | FHIR Mapping Code (Clinical Status) | FHIR Mapping Code (Verification Status) |
|---|---|---|---|
| U | Unconfirmed | active | unconfirmed |
| P | Pending | active | unconfirmed |
| S | Suspect | active | unconfirmed |
| C | Confirmed or verified | active | confirmed |
| I | Confirmed but inactive | inactive | confirmed |
| E | Erroneous | inactive | entered-in-error |
| D | Doubt raised | active | confirmed |
| Code | Description | FHIR Mapping System |
|---|---|---|
| application | Application data | http://terminology.hl7.org/CodeSystem/v2-0834 |
| audio | Audio data | http://terminology.hl7.org/CodeSystem/v2-0834 |
| image | Image data | http://terminology.hl7.org/CodeSystem/v2-0834 |
| model | Model data | http://terminology.hl7.org/CodeSystem/v2-0834 |
| text | Text data | http://terminology.hl7.org/CodeSystem/v2-0834 |
| video | Video data | http://terminology.hl7.org/CodeSystem/v2-0834 |
| multipart | MIME multipart package | http://terminology.hl7.org/CodeSystem/v2-0834 |