On this page:
   22.5    Segment Definitions
  • HL7 v2.x Support
  • 22.0 Introduction
  • 22.1 Inbound Messaging
  • 22.2 Outbound Messaging
  • 22.3 Transactions
  • 22.4 Structure Definitions
  • 22.5 Segment Definitions
  • 22.6 Table Definitions
  • 22.7 Naming System Mapping
  • 22.8 Processing Results Feeds
  • 22.9 Protocol
    • 22.7    Naming System Mapping   
       Table of Contents

    Table Definitions

    22.6Table Definitions

     

    This page contains table definitions for HL7 v2.x messages.

    22.6.1Table 0001: Administrative Sex

     
    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

    22.6.2Table 0002: Marital Status

     
    Code Description FHIR Mapping System FHIR Mapping Code
    A Separated http://hl7.org/fhir/v3/MaritalStatus L
    D Divorced http://hl7.org/fhir/v3/MaritalStatus D
    M Married http://hl7.org/fhir/v3/MaritalStatus M
    S Single http://hl7.org/fhir/v3/MaritalStatus U
    W Widowed http://hl7.org/fhir/v3/MaritalStatus W
    C Common law http://hl7.org/fhir/v3/MaritalStatus T
    G Living together http://hl7.org/fhir/v3/MaritalStatus T
    P Domestic partner http://hl7.org/fhir/v3/MaritalStatus T
    R Registered domestic partner http://hl7.org/fhir/v3/MaritalStatus T
    E Legally Separated http://hl7.org/fhir/v3/MaritalStatus E
    N Annulled http://hl7.org/fhir/v3/MaritalStatus A
    I Interlocutory http://hl7.org/fhir/v3/MaritalStatus I
    B Unmarried http://hl7.org/fhir/v3/MaritalStatus U
    U Unknown http://hl7.org/fhir/v3/NullFlavor UNK
    O Other http://hl7.org/fhir/v3/NullFlavor UNK
    T Unreported http://hl7.org/fhir/v3/NullFlavor UNK

    22.6.3Table 0004: Patient Class

     
    Code Description FHIR Mapping System FHIR Mapping Code
    I Inpatient http://hl7.org/fhir/v3/ActCode IMP
    E Emergency http://hl7.org/fhir/v3/ActCode EMER
    O Outpatient http://hl7.org/fhir/v3/ActCode AMB
    A Ambulatory http://hl7.org/fhir/v3/ActCode AMB
    P Pre-Admission http://hl7.org/fhir/v3/ActCode PRENC
    R Recurring Patient http://hl7.org/fhir/v2/0004 R
    B Obstetrics http://hl7.org/fhir/v2/0004 B

    22.6.4Table 0007: Admission Type

     

    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
    E Labor and Delivery
    R Routine
    N Newborn
    U Urgent
    E Elective

    22.6.5Table 0009: Ambulatory Status

     

    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

    22.6.6Table 0017: Transaction Type

     
    Code Description
    CG Charge
    CD Credit
    PY Payment
    AJ Adjustment
    CO Co-Payment

    22.6.7Table 0018: Patient Type

     

    No suggested codes are provided for this table. Any code may be used.

    22.6.8Table 0038: Order Status

     
    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

    22.6.9Table 0052: Diagnosis Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    A Admitting http://hl7.org/fhir/diagnosis-role AD
    W Working
    F Final http://hl7.org/fhir/diagnosis-role DD

    Note: For completeness, W is mapped to Encounter.diagnosis.role.text with a value of Working diagnosis.

    22.6.10Table 0063: v2 Relationship

     
    Code Description FHIR Mapping System FHIR Mapping Code
    ASC Associate http://hl7.org/fhir/v2/0063
    BRO Brother http://hl7.org/fhir/v2/0063
    CGV Care giver http://hl7.org/fhir/v2/0063
    CHD Child http://hl7.org/fhir/v2/0063
    DEP Handicapped dependent http://hl7.org/fhir/v2/0063
    DOM Life partner http://hl7.org/fhir/v2/0063
    EMC Emergency contact http://hl7.org/fhir/v2/0063
    EME Employee http://hl7.org/fhir/v2/0063
    EMR Employer http://hl7.org/fhir/v2/0063
    EXF Extended family http://hl7.org/fhir/v2/0063
    FCH Foster child http://hl7.org/fhir/v2/0063
    FND Friend http://hl7.org/fhir/v2/0063
    FTH Father http://hl7.org/fhir/v2/0063
    GCH Grandchild http://hl7.org/fhir/v2/0063
    GRD Guardian http://hl7.org/fhir/v2/0063
    GRP Grandparent http://hl7.org/fhir/v2/0063
    MGR Manager http://hl7.org/fhir/v2/0063
    MTH Mother http://hl7.org/fhir/v2/0063
    NCH Natural child http://hl7.org/fhir/v2/0063
    NON None http://hl7.org/fhir/v2/0063
    OAD Other adult http://hl7.org/fhir/v2/0063
    OTH Other http://hl7.org/fhir/v2/0063
    OWN Owner http://hl7.org/fhir/v2/0063
    PAR Parent http://hl7.org/fhir/v2/0063
    SCH Stepchild http://hl7.org/fhir/v2/0063
    SEL Self http://hl7.org/fhir/v2/0063
    SIB Sibling http://hl7.org/fhir/v2/0063
    SIS Sister http://hl7.org/fhir/v2/0063
    SPO Spouse http://hl7.org/fhir/v2/0063
    TRA Trainer http://hl7.org/fhir/v2/0063
    UNK Unknown http://hl7.org/fhir/v2/0063
    WRD Ward of court http://hl7.org/fhir/v2/0063

    22.6.11Table 0069: Hospital Service

     

    Smile CDR does not require specific codes drawn from this table.

    22.6.12Table 0074: Dianostic Service Section ID

     
    Code Description FHIR Mapping System FHIR Mapping Code
    AU Audiology http://hl7.org/fhir/v2/0074
    BG Blood Gases http://hl7.org/fhir/v2/0074
    BLB Blood Bank http://hl7.org/fhir/v2/0074
    CG Cytogenetics http://hl7.org/fhir/v2/0074
    CH Chemistry http://hl7.org/fhir/v2/0074
    CP Cytopathology http://hl7.org/fhir/v2/0074
    CT CAT Scan http://hl7.org/fhir/v2/0074
    CTH Cardiac Catheterization http://hl7.org/fhir/v2/0074
    CUS Cardiac Ultrasound http://hl7.org/fhir/v2/0074
    EC Electrocardiac (e.g. EKG, EEC, Holter) http://hl7.org/fhir/v2/0074
    EN Electroneuro (EEG, EMG, EP, PSG) http://hl7.org/fhir/v2/0074
    GE Genetics http://hl7.org/fhir/v2/0074
    HM Hematology http://hl7.org/fhir/v2/0074
    ICU Bedside ICU Monitoring http://hl7.org/fhir/v2/0074
    IMG Diagnostic Imaging http://hl7.org/fhir/v2/0074
    IMM Immunology http://hl7.org/fhir/v2/0074
    LAB Laboratory http://hl7.org/fhir/v2/0074
    MB Microbiology http://hl7.org/fhir/v2/0074
    MCB Mycobacteriology http://hl7.org/fhir/v2/0074
    MYC Mycology http://hl7.org/fhir/v2/0074
    NMR Nuclear Magnetic Resonance http://hl7.org/fhir/v2/0074
    NMS Nuclear Medicine Scan http://hl7.org/fhir/v2/0074
    NRS Nursing Service Measures http://hl7.org/fhir/v2/0074
    OSL Outside Lab http://hl7.org/fhir/v2/0074
    OT Occupational Therapy http://hl7.org/fhir/v2/0074
    OTH Other http://hl7.org/fhir/v2/0074
    OUS OB Ultrasound http://hl7.org/fhir/v2/0074
    PAR Parasitology http://hl7.org/fhir/v2/0074
    PAT Pathology (gross & histopath, not surgical) http://hl7.org/fhir/v2/0074
    PF Pulmonary Function http://hl7.org/fhir/v2/0074
    PHR Pharmacy http://hl7.org/fhir/v2/0074
    PHY Physician (Hx. Dx, admission note, etc.) http://hl7.org/fhir/v2/0074
    PT Physical Therapy http://hl7.org/fhir/v2/0074
    RAD Radiology http://hl7.org/fhir/v2/0074
    RC Respiratory Care (therapy) http://hl7.org/fhir/v2/0074
    RT Radiation Therapy http://hl7.org/fhir/v2/0074
    RUS Radiology Ultrasound http://hl7.org/fhir/v2/0074
    RX Radiograph http://hl7.org/fhir/v2/0074
    SP Surgical Pathology http://hl7.org/fhir/v2/0074
    SR Serology http://hl7.org/fhir/v2/0074
    TX Toxicology http://hl7.org/fhir/v2/0074
    URN Urinalysis http://hl7.org/fhir/v2/0074
    VR Virology http://hl7.org/fhir/v2/0074
    VUS Vascular Ultrasound http://hl7.org/fhir/v2/0074
    XRC Cineradiograph http://hl7.org/fhir/v2/0074

    22.6.13Table 0078: Observation Interpretation Codes

     
    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

    22.6.14Table 0085: Observation Status

     
    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 partial
    I Incomplete http://hl7.org/fhir/observation-status partial
    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

    22.6.15Table 0112: Discharge Disposition

     

    No suggested codes are provided for this table. Any code may be used.

    22.6.16Table 0119: Order Control

     
    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

    22.6.17Table 0123: Result Status

     
    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

    22.6.18Table 0125: Observation Value Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    ST String String
    TX Text String
    FT Formatted Text String
    NM Number Quantity
    DT DateTime DateTime
    TS Timestamp DateTime
    TM Time Time
    CWE Coded Value CodeableConcept / Coding

    22.6.19Table 0127: Allergen Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    AA Animal allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category environment
    DA Drug allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category medication
    EA Environmental allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category environment
    FA Food allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category food
    LA Pollen allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category environment
    MA Miscellaneous allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category
    MC Miscellaneous contraindication http://hl7.org/fhir/ValueSet/allergy-intolerance-category
    PA Plant allergy http://hl7.org/fhir/ValueSet/allergy-intolerance-category environment

    22.6.20Table 0128: Allergen Severity

     
    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

    22.6.21Table 0129: Accommodation Code

     

    No suggested codes are provided for this table. Any code may be used.

    22.6.22Table 0131: v2 Contact Role

     
    Code Description FHIR Mapping System FHIR Mapping Code
    BP Billing contact person http://hl7.org/fhir/v2/0131
    C Emergency Contact http://hl7.org/fhir/v2/0131
    CP Contact person http://hl7.org/fhir/v2/0131
    E Employer http://hl7.org/fhir/v2/0131
    EP Emergency contact person http://hl7.org/fhir/v2/0131
    F Federal Agency http://hl7.org/fhir/v2/0131
    I Insurance Company http://hl7.org/fhir/v2/0131
    N Next-of-Kin http://hl7.org/fhir/v2/0131
    O Other http://hl7.org/fhir/v2/0131
    PR Person preparing referral http://hl7.org/fhir/v2/0131
    S State Agency http://hl7.org/fhir/v2/0131
    U Unknown http://hl7.org/fhir/v2/0131

    22.6.23Table 0136: Yes/No

     
    Code Description FHIR Mapping System FHIR Mapping Code
    Y Yes
    N No

    22.6.24Table 0166: RX Component Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    A Additive
    B Base

    22.6.25Table 0190: Address Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    H Home
    L Legal Address
    P Permanent
    W Work
    B Firm/Business
    T Temporary
    O Old/Previous
    M Mailing

    22.6.26Table 0200: Name Type Code

     
    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

    22.6.27Table 0201: Telecom Use

     
    Code Description FHIR Mapping System FHIR Mapping Code
    PRN Home
    WPN Work
    NET Email

    22.6.28Table 0202: Telecom Equipment Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    PH Phone
    FX Fax
    CP Mobile
    BP Beeper
    Internet URL
    X.400 Email

    22.6.29Table 0203: Identifier Type

     
    Code Description FHIR Mapping System FHIR Mapping Code
    MR Patient Medical Record Number
    VN Visit/Encounter Number
    AN Account Number
    PLAC Placer Order Number
    FILL Filler Order Number
    SB Social Security Number

    22.6.30Table 0276: Appointment Reason Codes

     
    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)

    22.6.31Table 0278: Filler Status Code

     
    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

    22.6.32Table 0305: Person Location Type

     
    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

    22.6.33Table 0322: Completion Status

     
    Code Description Domain FHIR Mapping System FHIR Mapping Code
    CP Complete Pharmacy http://hl7.org/fhir/medication-admin-status completed
    RE Refused Pharmacy http://hl7.org/fhir/medication-admin-status stopped
    NA Not Administered Pharmacy http://hl7.org/fhir/medication-admin-status stopped
    PA Partially Administered Pharmacy http://hl7.org/fhir/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

    22.6.34Table 0438: Allergy Clinical Status Code

     

    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:

    • clinicalStatus
    • verificationStatus
    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
       22.5    Segment Definitions
  • HL7 v2.x Support
  • 22.0 Introduction
  • 22.1 Inbound Messaging
  • 22.2 Outbound Messaging
  • 22.3 Transactions
  • 22.4 Structure Definitions
  • 22.5 Segment Definitions
  • 22.6 Table Definitions
  • 22.7 Naming System Mapping
  • 22.8 Processing Results Feeds
  • 22.9 Protocol
    • 22.7    Naming System Mapping