Skip to main content

HL7 Message Segments

Kevin U
  • Updated

MSH: Message Header Segment

Below are the fields contained in the MSH segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Field Name Type Description Required
1-Field Separator ST

Separates fields in a message

Use the pipe character: |

 Y
2-Encoding Characters ST

Defines the other separator characters in following order: component, field repeat, escape character, subcomponent.

Use the following characters: ^~\&

 Y
3-Sending Application HD    
4-Sending Facility HD Vendor-specific facility ID (initially provided by MealSuite). Y
5-Receiving Application HD    
6-Receiving Facility HD    
7-Date/Time of Message DTM    
8-Security ST    
9-Message Type MSG

Specifies what type of message is being transmitted (e.g., ADT) and what the trigger event is (e.g., A01).

Format: <Message type>^<Trigger event>
Example: ADT^A01

 Y
10-Message Control ID ST This field contains a number or other identifier that uniquely identifies the message. The MealSuite system returns this ID back to the sending system in the message acknowledgment segment (MSA). Y
11-Processing ID PT

Specifies the HL7 processing ID (or processing mode). Values include:

  • D - debugging
  • P - production
  • T - training
 Y
12-Version ID VID

HL7 version used in the message.

Use latest version (2.8).

 Y
13-Sequence Number NM    
14-Continuation Pointer ST    
15-Accept Acknowledgment Type ID    
16-Application Acknowledgment Type ID    
17-Country Code ID    

EVN: Event Type Segment

Below are the fields contained in the EVN segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Fields highlighted blue are captured by the MealSuite UI.

Field Name Type Description Required Maps To
1-Event Type Code ID

The HL7 event type code.

Example: A01

 Y  
2-Recorded Date/Time TS The recorded date and time of the event.
Standard HL7 timestamp: yyyymmddhhmmss		 N

Admit Date field (for ADT-01 - Patient Admit message).

However, if “2-Recorded/Date Time” is not sent, then MealSuite inputs the current date in the Admit Date field.
N

Person Off Premise Start Date field (for ADT-A21 - Start Leave of Absence message).

However, if “2-Recorded/Date Time” is not sent, then MealSuite inputs the current date in the Person Off Premise Start Date field.
Y Person Off Premise End Date field (for ADT-A22 - Return from Leave of Absence message).
3-Date/Time Planned Event TS      
4-Event Reason Code IS      
5-Operator ID XCN      
6-Event Occurred TS      

PID: Patient Identification Segment

Below are the fields contained in the PID segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Fields highlighted blue are captured by the MealSuite UI.

Field Name Type Description Required Maps To
1-Set ID – PID SI      
2-Patient ID (External ID) CX   N Client ID
3-Patient ID (Internal ID) CX   N Client ID (only if the “2-Patient ID (External ID)” element is empty.
4-Alternate Patient ID CX      
5.1-Family Name ST   Y First Name
5.2-Given Name ST   Y Last Name
5.3-Middle Initial or Name ST   N M.I.
5.5-Prefix ST   N Title
6-Mother's Maiden Name XPN      
7-Date/Time of Birth TS Standard HL7 timestamp: yyyymmdd Y

Date of Birth (for ADT-A01 - Patient Admit message).

However, if “7-Date/Time of Birth” is not sent in an ADT-A01 - Patient Admit message, then MealSuite inputs the default date of “Jan 01, 1900” in the Date of Birth field.
8-Sex IS

Possible values:

  • M - Male
  • F -Female
  • O - Other
 N

Gender

If no value is sent, then MealSuite inputs "Other" into the Gender field
9-Patient Alias XPN      
10-Race IS      
11-Patient Address XAD      
11.1-Street Address ST      
11.3-Other Designation ST      
11.3-City ST      
11.4-State or Province ST      
11.5-Zip or Postal Code ST      
11.6-Country ST      
12-Country Code IS      
13-Phone Number - Home XTN      
14-Phone Number - Business XTN      
15-Primary Language CE      
16-Marital Status IS      
17-Religion IS      
18-Patient Account Number CX   N MRN
19-SSN Number - Patient ST      
20-Driver’s License Number - Patient DLN      
21-Mother’s Identifier CX      
22-Ethnic Group IS      
23-Birth Place ST      
24-Multiple Birth Indicator ID      
25-Birth Order NM      
26-Citizenship IS      
27-Veteran’s Military Status CE      
28-Nationality CE      
29-Patient Death Date and Time TS      
30-Patient Death Indicator ID Y - The patient is deceased Y or N value required for ADT-A03 - Patient Discharge message. Does not map to a MealSuite field, but the value informs MealSuite to either archive or delete the person, as per the “Deceased People are” setting in the Connect Interface Settings.
N - The patient is not deceased Does not map to a MealSuite field, but the value informs MealSuite to either archive or delete the person, as per the “Discharged people are” setting in the Connect Interface Settings.

PV1: Patient Visit Segment

Below are the fields contained in the PV1 segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Fields highlighted blue are captured by the MealSuite UI.

Field Name Type Description Required Maps To
1-Set ID – PV1 ST      
2-Patient Class ID      
3.2-Room ST  

Required for ADT-A02 - Transfer Patient message

 Room 
3.3-Bed ST   Required for ADT-A02 - Transfer Patient message Bed
3.4-Facility ST   Required for ADT-A02 - Transfer Patient message Area
3.8-Floor ST   Required for ADT-A02 - Transfer Patient message Floor
4-Admission Type ID      
5-Pre-admit Number CX      
6-Prior Patient Location PL      
7-Attending Doctor XCN      
8-Referring Doctor XCN      
9-Consulting Doctor XCN      
10-Hospital Service IS      
11-Temporary Location PL      
12-Pre-admit Test Indicator IS      
13-Re-admission Indicator IS      
14-Admit Source IS      
15-Ambulatory Status IS      
16-VIP Indicator IS      
17-Admitting Doctor XCN      
18-Patient Type IS      
19-Visit Number CX      
20-Financial Class FC      
21-Charge Price Indicator IS      
22-Courtesy Code IS      
23-Credit Rating IS      
24-Contract Code IS      
25-Contract Effective Date DT      
26-Contract Amount NM      
27-Contract Period NM      
28-Interest Code IS      
29-Transfer to Bad Debt Code IS      
30-Transfer to Bad Debt Date DT      
31-Bad Debt Agency Code IS      
32-Bad Debt Transfer Amount NM      
33-Bad Debt Recovery Amount NM      
34-Delete Account Indicator IS      
35-Delete Account Date DT      
36-Discharge Disposition IS      
37-Dischargeed to Location CM-DLD      
38-Diet Type IS      
39-Servicing Facility IS      
40-Bed Status IS      
41-Account Status IS      
42-Pending Location PL      
43-Prior Temporary Location PL      
44-Admit Date/Time TS   Not required for an ADT-A01 Patient Admit message because MealSuite uses the “2-Recorded Date/Time” field from the EVN Type segment to map to the Admit Date field.  
45-Discharge Date/Time TS   Not required for an ADT-A03 - Patient Discharge message because MealSuite uses the current date the message is sent.  
46-Current Patient Balance NM      
47-Total Charges NM      
48-Total Adjustments NM      
49-Total Payments CX      
50-Alternate Visit ID CX      
51-Visit Indicator IS      
52-Other Healthcare Provider XCN      

AL1: Patient Allergy Information Segment

Most EHRs send allergy info through the AL1 segment, which is included in the ADT-A01 - Patient Admit message and the ADT-A08 - Demographic Update message. (The other means to send allergy info is via the ADT-A60 - Update Allergy message. )

Below are the fields contained in the AL1 segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Fields highlighted blue are captured by the MealSuite UI.

Field Name Type Description Required
1.1 - Set ID - AL1 SI

The AL1 is a repeating segment with each allergy containing a unique Set ID number. 

As such, the Set ID of the first allergy is 1, the Set ID of the second allergy is 2, etc. 

 Y
1.2 - Allergy Type IS

Generally, a food allergy is indicated as FA. Non-food allergy codes are ignored by MealSuite. 

Y
1.3 -  Allergy Code/Mnemonic/ Description ST Maps to the Allergens field in a MealSuite people profile.

Y
1.4 - Allergy Severity IS NA N
1.5 - Allergy Reaction ST NA

N
1.6 - Identification Date DT NA N

IAM: Patient Averse Reaction Information Segment

Below are the fields contained in the IAM segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Fields highlighted blue are captured by the MealSuite UI.

Field Name Type Description Required
1 - Set ID - IAM SI    
2 - Allergen Type Code CE

Enter FA for Food Allergy.

 N
3.1 - Allergen Code > Identifier ST Drug framework substance identifier N (but preferred)
3.2 - Allergen Code > Text ST

Substance description (i.e., name of allergen)

Maps to the Allergens field in a MealSuite people profile.

 Y
3.3 - Allergen Code > Type ST

Possible values:

  • Allergy
  • Intolerance

N

If value is not sent, then MealSuite treats it as allergy.
4 - Allergy Severity Code CE    
5 - Allergy Reaction Code ST    
6 - Allergy Action Code CNE

Values:

  • A - add allergy
  • D - delete
  • U - update allergy
 Y
7 - Allergy Unique Identifier EI    
8 - Action Reason ST    
9 - Sensitivity to Causative Agent Code CE    
10 - Allergen Group Code/Mnemonic/Description CE    
11 - Onset Date DT    
12 - Onset Date Text ST    
13 - Report Date/Time TS    
14 - Reported By XPN    
15 - Relationship to Patient Code CE    
16 - Alert Device Code CE    
17 - Allergy Clinical Status Code CE    
18 - Statused by Person XCN    
19 - Staused by Organization XCN    
20 - Statused at Date/Time TS    

ODS: Dietary Orders, Supplements, and Preferences

Below are the fields contained in the ODS segment.

Fields indicated as required are needed for a successful call to a MealSuite Connect interface.

Fields highlighted blue are captured on the MealSuite UI.

Field Name Description Required Maps To
Segment ID Unique ID to identify transaction Y -
Service Period The MealSuite system assumes that the diet order will be for all service periods. N -
DietSupplementOrPreferenceCode Contains D as the value (to indicate diet code). Y -
Diet Contains diet type(s).

N if API settings have the Process Partial Orders setting enabled. 

Y if API settings have the Process Partial Orders setting disabled.* 

 Diet element maps to Diets field.
Texture Contains texture type.

N if API settings have the Process Partial Orders setting enabled. 

Y if API settings have the Process Partial Orders setting disabled.* 

 Texture element maps to Texture field.
Fluid Contains fluid type.

N if API settings have the Process Partial Orders setting enabled. 

Y if API settings have the Process Partial Orders setting disabled.* 

 Fluid element maps to Fluid field.
Modifiers Contains diet intervention.  N Modifiers element maps to Standard Diet Interventions field.

NPOFlag

 Contains "true" or "false" N

NPOFlag = “true” then “NPO” value is mapped to Diets, Texture and Fluid fields.

NPOFlag = “false” then “NPO” value is removed from Diets, Texture and Fluid fields.
DietaryNotes Contains any notes.  N DietaryNotes maps to Profile Notes
Action

If API settings have the Add & Cancel setting enabled, the Action field indicates if the diet order message is an add/new (Add or NW) or a discontinued/cancel (CA or OD) to a person's profile in MealSuite.

Y if the API settings have the Add & Cancel setting enabled.

N if the API settings have the Replace setting enabled.**  

 -

*Contact your MealSuite support representative for more information about processing partial diet orders in a Connect message. 

**Contact your MealSuite support representative for more information on adding to existing diet orders or replacing diet orders. 

ORC: Common Order Segment

The ORC segment is mandatory for diet order messages only. 

Field Name Type Description Required Maps To
1 - Order Control ID

Possible values:

  • CA - Order was cancelled
  • CM and OD - Order is completed
  • DC - Order was discontinued
  • ER - Error, order not found
  • HD - Order is on hold
  • IP - In process, unspecified
  • RP - Order has been replaced
  • SC and SN - In process, scheduled

Note: The values may differ depending on the EMR. 

 Y for a diet order message Diet order type
7.4 - Service Period ST

Start date and time for the diet order.

Note: The service period can be another element depending on client requirements. 

 Y for a diet order message Start Date for the diet order