21.11.1 Master Files (99.1.7)

ANSI/HL7 V2.9-2019

12/9/2019

22 .Master Files (8)

Sandra StuartKaiser Permanente

List Server:

The content of this chapter is "owned" by various Work Groups as listed below:

Infrastructure and Messaging

M01, M13, M14

M04, M17

CDM, PRC, DMI

CM0, CM1, CM2

22.1 CHAPTER 8 CONTENTS (8.1)

22.2 PURPOSE (8.2)

In an open-architecture healthcare environment there often exists a set of common reference files used by one or more application systems. Such files are called master files. Some common examples of master files in the healthcare environment include:

• staff and health practitioner master file

• system user (and password) master file

• location (census and clinic) master file

• device type and location (e.g., workstations, terminals, printers, etc.)

• lab test definition file

• exam code (radiology) definition file

• charge master file

• patient status master

• patient type master

• service item master file

These common reference files need to be synchronized across the various applications at a given site. The Master Files Notification message provides a way of maintaining this synchronization by specifying a standard for the transmission of this data between applications.

In many implementations, one application system will "own" a particular master file such as the staff and practitioner master file. The changes (e.g., adds, deletes, updates) to this file are made available to various other applications on a routine basis. The Master Files Notification message supports this common case, but also supports the situation where an application not "owning" a particular master file transmits update information to other systems (usually to the "owning" system) for review and possible inclusion.

The Master Files Notification message supports the distribution of changes to various master files between systems in either online or batch modes, and allows the use of either original or enhanced acknowledgment modes. These messages use the MSH segment to pass the basic event code (master files notification or acknowledgment). The MFI (master file identification) segment identifies the master file being updated as well as the initial and requested dates for "file-level" events (such as "replace file"). For each record being changed, the MFE (Master File Entry) segment carries the record-level event code (such as add, update, etc.), the initial and requested dates for the event, and the record-level key identifying the entry in the master file. The MFA (master file acknowledgment) segment returns record-specific acknowledgment information.

The master file segments commonly needed across HL7 applications as well as those specific to the various application chapters, are defined in Sections 0 through 4 of this chapter.

A given master files message concerns only a single master file. However, the provision of a record-level event code (and requested activation date) on the MFE and the MFA segments allows a single message to contain several types of changes (events) to that file.

The Master Files Notification events do not specify whether the receiving system must support an automated change of the master file in question, nor do they specify whether the receiving system must create a file in the same form as that maintained on the sending system.

In general, the way in which the receiving system processes the change notification message will depend on both the design of the receiving system and the requirements negotiated at the site. Some systems and/or sites may specify a manual review of all changes to a particular master file. Some may specify a totally automated process. Not every system at every site will need all the fields contained in the master file segment(s) following the MFE segment for a particular master file entry.

This also means that an application acknowledgment (or a deferred application acknowledgment) from a receiving system that it changed a particular record in its version of the master file does not imply that the receiving system now has an exact copy of the information and state that is on the sending system: it means only that whatever subset of that master file's data (and state) that has been negotiated at the site is kept on the receiving system in such a manner that a new Master Files Notification transaction with the same primary key can be applied unambiguously (in the manner negotiated at the site) to that subset of information.

22.3 TRIGGER EVENTS (8.3)

The Master Files Change Notification message can be used for the following message-level trigger events:

It is recommended that site-specific master files use event M13 or M14; alternately a code of the form Znn can be used (see also section 8.5.1, "MFI - Master File Identification Segment.")

The MFN message specifies whether the master file, as a whole, has been replaced or if a record within the file has been updated. See section 8.5.13, "MFI-3 File Event Code," for further details.

The MFN message transmits the specific action taken on a record. See section 8.5.2.1, "MFE-1 Record Event Code," for further details.

22.4 MESSAGES (8.4)

The following messages are defined for master files transactions: MFN, master files notification; MFK, master files application acknowledgment; and MFQ, master files query.

22.4.1 MFN/MFK - Master File Notification [WITHDRAWN] (Event M01) (8.4.1)

Withdrawn in version 2.7 and later; refer to master file messages which follow.

22.4.2 MFN/MFK - Master File Notification - General (Event M13) (8.4.2)

The MFN General master file notification transaction is used where the master file is a simple one that contains only a key and the text value of that key. Both values are carried in MFE-4 - Primary Key Value - MFE. The specific master file being updated is identified by MFI-1 - Master File Identifier and MFI-2 - Master Files Application Identifier.

The General master file notification is defined as follows:

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M13^MFN_M13
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MFE Master File Entry	[1..*]	SHALL

 

MFN_M13

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M13^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
NE	AL, SU, ER	-	MFK^M13^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M13^ACK	MFK^M13^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M13^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.4.2.1 hiddentext (8.4.2.0)

22.4.2.2 MFK use notes (8.4.2.1)

The MFA segment carries acknowledgment information for the corresponding MFE segment (identified by MFA-5 - Primary Key Value - MFA). Fields MFE-4 - Primary Key Value - MFE and MFA-5 - Primary Key Value - MFA provide the link between the corresponding segments.

22.4.3 MFN/MFK - Master File Notification - Site Defined (Event M14) (8.4.3)

The MFN Site defined master file notification transaction is used where the master file is not a simple one (as defined for MFN^M13) and is not a transaction type currently defined by HL7, but rather requires one or more HL7 and/or 'Z' segments to carry the master file information.

The Site defined master file notification is defined as follows:

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M14^MFN_Znn
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_SITE_DEFINED	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
Hxx any HL7 segment	[1..1]	SHALL

 

MFN_Znn

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M14^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M14^ACK	-
NE	AL, SU, ER	-	MFK^M14^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M14^ACK	MFK^M14^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M14^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.4.3.1 hiddentext (8.4.3.0)

22.4.3.2 MFN use notes (8.4.3.1)

The master file record identified by the MFE segment is contained in Z-segments immediately following the MFE segment, and is denoted by "..." in the MFN abstract message definition given above. This record may be either a flat record contained in a single segment, or a complex record needing more than a single segment to carry its data and (usually hierarchical) structure.

The definition of this transaction and the associated abstract message structure code (as defined in MSH-9 - Message Type, denoted by MFN_Znn above) are subject to site negotiation. Refer to Chapter 2, section 2.17, "Local Extension" for additional information on 'Z' abstract message structure code definition.

22.4.3.3 MFK use notes (8.4.3.2)

The MFA segment carries acknowledgment information for the corresponding MFE segment (identified by MFA-5 - Primary Key Value - MFA). Fields MFE-4 - Primary Key Value - MFE and MFA-5 - Primary Key Value - MFA provide the link between the corresponding segments.

22.4.4 MFQ/MFR - Master Files Query [WITHDRAWN] (Event M01-M17) (8.4.4)

Withdrawn in version 2.7 and later; refer to Chapter 5 section 5.4 instead. Also, refer to Section 8.4.5 for an example of a master file conformance based query.

22.5 GENERIC MASTER FILE EXAMPLES (8.6)

The following are examples of a generic method of updating a standard HL7 table, covering the following two cases:

• The case with a site-defined "Z" segment. This message type is used when standard HL7 segments are not available to carry all of the required information on the master file. This message type can also be used in the case where standard HL7 segments are available, but the transaction type is not currently defined by HL7. Refer to Section 8.4.3, "MFN/MFK - Master File Notification - Site Defined (Event M14)," for more information on this message type.

• The case without a site-defined "Z" segment. This message type is used when standard HL7 segments are available to carry all of the required information on the master file (in the case of a 'simple' master file that contains only a key and the text value of that key). Refer to Section 8.4.2, "MFN/MFK - Master File Notification - General (Event M13)," for more information on this message type.

The following examples show two records being added to User-defined Table 0006 - Religion (in Chapter 2C, Code Tables).

22.5.1 ZL7 Segment (Proposed Example Only) (8.6.1)

HL7 Attribute Table - ZL7 - (proposed example only)

• Segment (new)
  (base framework)
• Segment (new)
  (w/o profiles)
• Segment (new)
  (w/ profiles)
• Segment (classic)
  (w/ profiles)
• Segment (classic)
  (w/o profiles)
• FHIR
  Structure Definition
• v2.xml
  XSD

Base Framework
	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type
ZL7
	1	00000	Display-sort-key	= Truncation not allowed!	SHOULD	[1..1]		3		NM Numeric
	2	00000	Display-sort-key	= Truncation not allowed!	SHOULD	[1..1]		3		NM Numeric

	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type
ZL7
	1	00000	Display-sort-key	= Truncation not allowed!	SHALL	[1..1]		3		NM Numeric
	2	00000	Display-sort-key	= Truncation not allowed!	SHALL	[1..1]		3		NM Numeric

Base Framework											Base Standard Profile
	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type	Implement	Vocabulary
ZL7
	1	00000	Display-sort-key	= Truncation not allowed!	SHOULD	[1..1]		3		NM Numeric	SHALL
	2	00000	Display-sort-key	= Truncation not allowed!	SHOULD	[1..1]		3		NM Numeric	SHALL

Base Framework											Base Standard Profile
	Seq#	Data Element	Description	Flags	Optionality	Repetition	Length	C.LEN	Table	Data Type	Optionality	Table
ZL7
	1	00000	Display-sort-key		O			3=		NM Numeric	R
	2	00000	Display-sort-key		O			3=		NM Numeric	R

	Seq#	Data Element	Description	Optionality	Repetition	Length	C.LEN	Table	Data Type
ZL7
	1	00000	Display-sort-key	R			3=		NM Numeric
	2	00000	Display-sort-key	R			3=		NM Numeric

22.5.1.1 ZL7 Field Definitions (8.6.1.0)

22.5.1.2 ZL7-1 Primary Key Value - ZL7 (CWE) (8.6.1.1)

Definition: This field contains HL7 table values for identifier and text encoded as a CWE data type.

22.5.1.3 ZL7-2 Display-Sort-Key (NM) (8.6.1.2)

Definition: This field is used to specify a non-alphabetic ordering for display or print versions of a standard HL7 table.

22.5.2 MFN Message with Original Acknowledgment Mode (8.6.2)

22.5.2.1 hiddentext (8.6.2.0)

22.5.2.2 Example message (8.6.2.1)

The initiating system constructs an MFN^M14 message. In this example, the message contains site-defined "Z" segments. The following message is sent to the responding system:

MSH|^~\&|HL7REG|UH|HL7LAB|CH|200106290544||MFN^M14^MFN_Z99|MSGID001|P|2.9

MFI|HL70006^RELIGION^HL70175||UPD|||AL

MFE|MAD|6772331|200106290500|BUD^Buddhist^HL70006|CWE

ZL7|BUD^Buddhist^HL70006|3

MFE|MAD|6772332|200106290500|BOT^Buddhist: Other^HL70006|CWE

ZL7|BOT^Buddhist: Other^HL70006|4

The responder receives the message and performs necessary validation on the message. In this example, it determines the message just received is acceptable for processing. The following MFK^M14 message is constructed by the responder and sent to the initiating system to indicate acknowledgment of the MFN^M14 message:

MSH|^~\&|HL7LAB|CH|HL7REG|UH|200106290545||MFK^M14^MFK_M01|MSGID99001|P|2.9

MSA|AA|MSGID001

MFI|HL70006^RELIGION^HL70175||UPD|||AL

MFA|MAD|6772331|200106290545|S|BUD^Buddhist^HL70006|CWE

MFA|MAD|6772332|200106290545|S|BOT^Buddhist: Other^HL70006|CWE

Note that MSA-1 - Acknowledgment Code contains 'AA' to indicate the message was received and processed successfully. This value could also have been 'AE' or 'AR' to indicate the message was received but not processed successfully. MSA-2 - Message Control ID contains the value from MSH-10 - Message Control ID in the initiating MFN^M14 message (MSGID001) to link the acknowledgment response to the initiating message.

22.5.3 MFN message with enhanced Mode Application-Level Acknowledgment (8.6.3)

22.5.3.1 hiddentext (8.6.3.0)

22.5.3.2 Example message (8.6.3.1)

The initiating system constructs an MFN^M13 message. In this example, the message does not contain site-defined "Z" segments. The following message is sent to the responding system:

MSH|^~\&|HL7REG|UH|HL7LAB|CH|200106290544||MFN^M13^MFN_M13|MSGID004|P|2.9||AL|AL

MFI|HL70006^RELIGION^HL70175||UPD|||AL

MFE|MAD|6772333|200106290500|BUD^Buddhist^HL70006|CWE

MFE|MAD|6772334|200106290500|BOT^Buddhist: Other^HL70006|CWE

The responder receives the message and performs necessary validation on the message. In this example, it determines the message just received is acceptable for processing. Since MSH-15 - Accept Acknowledgment of the initiating message indicates an accept acknowledgment is required ('AL'), the following ACK message is constructed by the responder and sent to the initiating system to indicate acknowledgment of the MFN^M13 message:

MSH|^~\&|HL7LAB|CH|HL7REG|UH|200106290545||ACK^M13^ACK|MSGID99004|P|2.9

MSA|CA|MSGID004

Note that MSA-1 - Acknowledgment Code contains 'CA' to indicate the message was received and committed to safe storage. This value could also have been 'CE' or 'CR' to indicate the message was received but not processed successfully. MSA-2 - Message Control ID contains the value from MSH-10 - Message Control ID in the initiating MFN^M13 message (MSGID004) to link the acknowledgment response to the initiating message.

The initiating system indicated in this example via MSH-16 - Application Acknowledgment Type that it requires an application level acknowledgment ('AL'). The responder, at some point following the sending of the above ACK message to the initiating system, will process the MFN^M13 message. Once message processing is complete, the application acknowledgment is sent from the responder to the initiating system to indicate the message was processed. The responder constructs an MFK^M13 acknowledgment message, and sends it to the initiating system:

MSH|^~\&|HL7LAB|CH|HL7REG|UH|200106290550||MFK^M13^MFK_M13|MSGID99501|P|2.9||AL|

MSA|AA|MSGID004

MFI|HL70006^RELIGION^HL70175||UPD|||AL

MFA|MAD|6772333|200106290550|S|BUD^Buddhist^HL70006|CWE

MFA|MAD|6772334|200106290550|S|BOT^Buddhist: Other^HL70006|CWE

Note that MSA-1 - Acknowledgment Code contains 'AA' to indicate the message was received and processed successfully. This value could also have been 'AE' or 'AR' to indicate the message was received but not processed successfully. This value applies to all MFA segments which follow. MSA-2 - Message Control ID contains the value from MSH-10 - Message Control ID in the initiating MFN^M13 message (MSGID004) to link the application acknowledgment response to the initiating message.

The initiating system receives the application acknowledgment message from the responder, and forms an ACK message to acknowledge it. The following message is sent to the responder system:

MSH|^~\&|HL7REG|UH|HL7LAB|CH|200106290551||ACK^M13^ACK|MSGID445|P|2.9

MSA|CA|MSGID99501

Note that MSA-2 - Message Control ID contains the value from MSH-10 - Message Control ID in the MFK^M13 message just received (MSGID99501), and NOT from the initiating MFN^M13 message.

22.6 STAFF AND PRACTITIONER MASTER FILES (8.7)

22.6.1 MFN/MFK - Staff/Practitioner Master File Message (Event M02) (8.7.1)

The staff identification (STF), practitioner detail (PRA), practitioner organization unit segment (ORG), professional affiliation (AFF), language detail (LAN), educational detail (EDU), and certificate detail (CER) segments can be used to transmit master files information between systems. The STF segment provides general information about personnel; the PRA, ORG, AFF, LAN, EDU, CER and NTE segments provide detailed information for a staff member.

When the STF, PRA, ORG, AFF, LAN, EDU, CER and NTE segments are used in an MFN message, the abstract definition is as follows:

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M02^MFN_M02
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_STAFF	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
STF Staff Identification	[1..1]	SHALL
PRA Practitioner Detail
ORG Practitioner Organization Unit
AFF Professional Affiliation
LAN Language Detail
EDU Educational Detail
CER Certificate Detail
NTE Notes and Comments

 

MFN_M02

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M02^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M02^ACK	-
NE	AL, SU, ER	-	MFK^M02^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M02^ACK	MFK^M02^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M02^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.6.2 Example: Staff and Health Practitioner Master File MFN Message (8.7.2)

MSH|^~\&|HL7REG|UH|HL7LAB|CH|200102280700||MFN^M02^MFN_M02|MSGID002|P|2.9|||AL|NE

MFI|PRA^Practitioner Master File^HL70175||UPD|||AL

MFE|MAD|U2246|200102280700|PMF98123789182^^PLW|CWE

STF|PMF98123789182^^PLW|U2246^^^PLW~444444444^^^USSSA^SS|Hippocrates^Harold^H^JR^DR^M.D.|P|M|19511004|A|^ICU|^MED|^WPN^PH^^^555^5551003~^PRN^PH^^^955^5551003|1003 Healthcare Drive ^^Ann Arbor^MI^^^H~4444 Healthcare Dr^^Ann Arbor^MI^^^O|19890125^&Level Seven Healthcare, Inc.&L01||PMF88123453334|74160.2326@COMPUSERV.COM|B

PRA|PMF98123789182^^PLW|^Level Seven Healthcare|ST|I|OB/GYN^STATE BOARD OF OBSTETRICS AND GYNECOLOGY^C^19790123|1234887609^UPIN~1234987^CTY^MECOSTA~223987654^TAX~1234987757^DEA~12394433879^MDD^CA|ADMIT&&ADT^MED&&L2^19941231~DISCH&&ADT^MED&&L2^19941231|

AFF|1|AMERICAN MEDICAL ASSOCIATION|123 MAIN STREET^^OUR TOWN^CA^98765^USA^M |19900101|

LAN|1|ESL^SPANISH^ISO639|1^READ^HL70403|1^EXCELLENT^HL70404|

LAN|2|ESL^SPANISH^ISO639|2^WRITE^HL70403|2^GOOD^HL70404|

LAN|3|FRE^FRENCH^ISO639|3^SPEAK^HL70403|3^FAIR^HL70404|

EDU|1|BA|19810901^19850601||19850604|YALE UNIVERSITY^L|U^HL70402|456 CONNECTICUT AVENUE^^NEW HAVEN^CO^87654^USA^M|

EDU|2|MD|19850901^19890601||19890604|HARVARD MEDICAL SCHOOL^L |M^HL70402|123 MASSACHUSETTS AVENUE^^CAMBRIDGE^MA^76543^USA^M|

22.7 SERVICE/TEST/OBSERVATIONS MASTER FILES (8.8)

22.7.1 General Approach of Service/Test/Observation Master Files (8.8.1)

These segments define the format for the general information about the observations that a clinical or diagnostic service produces and sends to its "clients." This format can be used to send the producer's entire service/test/observation definition or a few of the producer's observations, such as those with procedure, technique, or interpretation changes.

In anticipation of an object-oriented organization of segments in future releases of this Standard, the attributes of observations/batteries have been grouped into seven different segments:

• OM1 contains the attributes that apply to all observations

• OM2 applies to numerically-valued observations

• OM3 applies to text or code-valued observations

• OM4 applies to observations or batteries that require specimens

• OM5 contains the attributes of batteries, or sets of observations or other batteries

• OM6 contains the quantities (observations in a most general sense) that are calculated from one or more other observations

• OM7 contains additional basic attributes that apply to the definition of most observations/services.

Thus, the full definition of a numerically-valued laboratory observation would require the transmission of OM1, OM2, and OM4.

In the following discussion, we use OMx to refer to any of the seven observation-defining segments. Each instance of an OMx segment contains the information about one observation or observation battery. These OMx segments are designed to be "inclusive" and accommodate the attributes of many kinds of observations. Thus, the fact that a field is listed in a particular segment should not be construed as meaning that a producer must include information about that item in its definition transmission. Many fields will apply to some terms; others will not. One observation producer may choose to populate one set of fields; another may choose to populate a different set of fields, according to the requirements of that producer's "client."

Most of the fields of data type TX in those segments are intended to include information typically contained in a diagnostic service's user manual. Such fields should describe how the data is to be interpreted or used, and are not intended for computer interpretation.

Remember that the magnitude of a treatment can also be regarded as an observation and, as such, can be represented as an observation within these segments. Many examples exist. When a blood gas is transmitted, the requesting service usually transmits the amount of inspired O2 (a treatment) on requisition. (In an electronic transmission, the service would send this as an OBX segment, along with the electronic order for the test.) When blood levels are drawn, the amount and time of the last dose are routinely included as observations on the request for service. A pharmacy system could routinely send to a medical record system the average daily dose of each outpatient medication it dispenses. In such cases, the treatment amounts would be observations to the receiving system and would be transmitted as OBX segments. When received, they would be treated like any other observation. A medical record system could then create, for example, a flowchart of lab results, or lab results mixed with relevant treatments.

22.7.2 MFN/MFK - Master File Notification - Test/Observation [WITHDRAWN] (Event M03) (8.8.2)

Withdrawn in version 2.7 and later; refer to master file messages which follow (Events M08, M09, M10, M11 and M12).

22.7.3 MFN/MFK - Master File Notification - Test/Observation (Numeric) (Event M08) (8.8.3)

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M08^MFN_M08
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_TEST_NUMERIC	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
OM1 General Segment	[1..1]	SHALL
OMC Supporting Clinical Information
PRT Participation Information
OM2 Numeric Observation	[0..1]
OM3 Categorical Service/Test/Observation	[0..1]
OM4 Observations that Require Specimens

 

MFN_M08

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M08^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M08^ACK	-
NE	AL, SU, ER	-	MFK^M08^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M08^ACK	MFK^M08^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M08^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.7.4 MFN/MFK - Master File Notification - Test/Observation (Categorical) (Event M09) (8.8.4)

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M09^MFN_M09
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_TEST_CATEGORICAL	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
OM1 General Segment	[1..1]	SHALL
OMC Supporting Clinical Information
PRT Participation Information
MF_TEST_CAT_DETAIL	[0..1]
OM3 Categorical Service/Test/Observation	[1..1]	SHALL
OM4 Observations that Require Specimens

 

MFN_M09

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M09^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M09^ACK	-
NE	AL, SU, ER	-	MFK^M09^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M09^ACK	MFK^M09^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M09^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.7.5 MFN/MFK - Master File Notification - Test/Observation Batteries (Event M10) (8.8.5)

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M10^MFN_M10
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_TEST_BATTERIES	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
OM1 General Segment	[1..1]	SHALL
OMC Supporting Clinical Information
PRT Participation Information
MF_TEST_BATT_DETAIL	[0..1]
OM5 Observation Batteries (Sets)	[1..1]	SHALL
OM4 Observations that Require Specimens

 

MFN_M10

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M10^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M10^ACK	-
NE	AL, SU, ER	-	MFK^M10^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M10^ACK	MFK^M10^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M10^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.7.6 MFN/MFK - Master File Notification - Test/Calculated Observations (Event M11) (8.8.6)

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M11^MFN_M11
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_TEST_CALCULATED	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
OM1 General Segment	[1..1]	SHALL
OMC Supporting Clinical Information
PRT Participation Information
MF_TEST_CALC_DETAIL	[0..1]
OM6 Observations that are Calculated from Other Observations	[1..1]	SHALL
OM2 Numeric Observation	[1..1]	SHALL

 

MFN_M11

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M11^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M11^ACK	-
NE	AL, SU, ER	-	MFK^M11^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M11^ACK	MFK^M11^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M11^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.7.7 MFN/MFK - Master File Notification - Additional Basic Observation/Service Attributes (Event M12) (8.8.7)

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M12^MFN_M12
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_OBS_ATTRIBUTES	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
OM1 General Segment	[1..1]	SHALL
PRT Participation Information
MF_OBS_OTHER_ATTRIBUTES	[0..1]
OM7 Additional Basic Attributes	[1..1]	SHALL
PRT Participation Information

 

MFN_M12

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M12^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M12^ACK	-
NE	AL, SU, ER	-	MFK^M12^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M12^ACK	MFK^M12^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M12^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.7.8 MFN/MFK - Master File Notification - Test/Observation (Payer) (Event M18) (8.8.8)

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M18^MFN_M18
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_PAYER	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
PAYER_MF_ENTRY	[1..*]	SHALL
PM1 Payer Master File	[1..1]	SHALL
PAYER_MF_COVERAGE	[1..*]	SHALL
MCP Master File Coverage	[1..1]	SHALL
DPS Diagnosis and Procedure Code Segment

 

MFN_M18

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M18^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M18^ACK	-
NE	AL, SU, ER	-	MFK^M18^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M18^ACK	MFK^M18^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M18^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.8 LOCATION MASTER FILES (8.9)

22.8.1 MFN/MFK - Patient Location Master File Message (event M05) (8.9.1)

This section is specifically concerned with describing a master file message that should be used to transmit information which identifies the inventory of healthcare patient locations, such as nursing units, rooms, beds, clinics, exam rooms, etc. In a network environment, this segment can be used to define patient locations to other applications. The segment also includes the readiness states and support locations for the patient locations.

The LOC, LCH, LRL, LDP, and LCC segments must be preceded by the MFI and MFE segments, as described in Section 8.5, "GENERAL MASTER FILE SEGMENTS." In the following message, the MFI-1 - Master File Identifier field should equal "LOC"

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M05^MFN_M05
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_LOCATION	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
LOC Location Identification	[1..1]	SHALL
LCH Location Characteristic
LRL Location Relationship
MF_LOC_DEPT	[1..*]	SHALL
LDP Location Department	[1..1]	SHALL
LCH Location Characteristic
LCC Location Charge Code

 

MFN_M05

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M05^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M05^ACK	-
NE	AL, SU, ER	-	MFK^M05^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M05^ACK	MFK^M05^MFK_M01

We need some ER7 examples...

We need some XML examples...

When the LCH segment appears immediately following the LOC segment, it communicates characteristics which are the same across multiple departments that may use the same room. When the LCH segment appears immediately following the LDP segment, it communicates characteristics which differ for different departments that may use the same room.

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M05^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.8.2 Example: MFN Location Master File Message (8.9.7)

MSH|^~\&|HL7REG|UH|HL7LAB|CH|19910918060544||MFN^M05^MFN_M05|MSGID002|P|2.8||AL|NE

MFI|LOC||UPD|||AL

MFE|MAD|PMF98123789182|199110011230|3A^RM17^17-2^FAC1|PL

LOC|3A^RM17^17-2^FAC1|BEST BED IN UNIT|B|UNIVERSITY HOSPITAL|54326 SAND P0INT WAY^^SEATTLE^WA^98199|(206)689-1329|92837465998|OXY

LCH|3A^RM17^17-2^FAC1|||IMP|Y

LRL|3A^RM17^17-2^FAC1|||LAB|3WEST PATH LAB

LDP|3A^RM17^17-2^FAC1|PED|MED|PIN|I|A|19941004||||(206)689-1363

LCC|3A^RM17^17-2^FAC1|PED|PIC|R38746

22.9 CHARGE DESCRIPTION MASTER FILES (8.10)

22.9.1 MFN/MFK - Charge Description Master File Message (Event M04) (8.10.1)

The charge description (CDM) master file segment should be used in conjunction with the general master file segments in Section 8.5, "GENERAL MASTER FILE SEGMENTS." Interfacing systems often need not only to communicate data about a patient's detailed charges, but also to communicate the charge identification entries by which an application knows how to handle a particular charge code. The charge description master is a master file.

The NTE segment may also contain other information to the provider to convey other requirements or context. For example:

Convey the status of Federal Drug Administration (FDA) approval of the test. For example, the test may have FDA approval but is not validated yet because of limited gathering of data to confirm the validity of the test.

Convey that a patient's consent must be obtained before the test is ordered. This requirement can be conveyed in this NTE as well.

The CDM segment below is a specially designed master file segment for interfacing charge description masters. In the following message, the MFI-master file identifier should equal "CDM." When the CDM segment is used in an MFN message, the abstract definition is as follows:

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M04^MFN_M04
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
NTE Notes and Comments
MF_CDM	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
NTE Notes and Comments
CDM Charge Description Master	[1..1]	SHALL
NTE Notes and Comments
PRC Pricing

 

MFN_M04

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M04^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M04^ACK	-
NE	AL, SU, ER	-	MFK^M04^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M04^ACK	MFK^M04^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M04^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...

22.9.2 Example: MFN Message Charge Description Master File (8.10.4)

MSH|^~\&|HL7REG|UH|HL7LAB|CH|19910918060544||MFN^M04^MFN_M04|MSGID002|P|2.9||AL|NE

MFI|CDM||UPD|||AL

MFE|MAD|CDM98123789182|199110011230|P2246^^PLW|CWE

CDM|P2246^^PLW |2445|APPENDECTOMY|APPENDECTOMY|X||244.34|A|2321||||N

PRC|P2246^^PLW |FAC3|SURG|O~A|100.00^UP |formula |1|1 |100.00^USD|1000.00^USD|19941031||Y|GL545|Y|A|

22.10 CLINICAL TRIALS MASTER FILES (8.11)

22.10.1 MFN/MFK - Clinical Trials Master File Message (Event M06-M07) (8.11.1)

The CM0 (Clinical Study Master), CM1 (Clinical Study Phase), and CM2 (Clinical Study Schedule) segments can be used to transmit master files information between systems. The CM0 segment contains the information about the study itself; the CM1 contains the information about one phase of the study identified in the preceding CM0; and the CM2 contains the information about the scheduled time points for the preceding study or phase-related treatment or evaluation events. When these segments are used in an MFN message, the abstract definition is described below.

Case 1: MFN message for Clinical Study with phases and schedules

MFI-1 - Master File Identifier Code = CMA

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFN^M06^MFN_M06
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MFI Master File Identification	[1..1]	SHALL
MF_CLIN_STUDY	[1..*]	SHALL
MFE Master File Entry	[1..1]	SHALL
CM0 Clinical Study Master	[1..1]	SHALL
MF_PHASE_SCHED_DETAIL
CM1 Clinical Study Phase Master	[1..1]	SHALL
CM2 Clinical Study Schedule Master

 

MFN_M06

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	-	MFK^M06^MFK_M01
NE	NE	-	-
AL, SU, ER	NE	ACK^M06^ACK	-
NE	AL, SU, ER	-	MFK^M06^MFK_M01
AL, SU, ER	AL, SU, ER	ACK^M06^ACK	MFK^M06^MFK_M01

We need some ER7 examples...

We need some XML examples...

• Message
• ACK Choreography
• FHIR Structure Definition
• v2.xml XSD
• ER7 Example
• XML Example

Segment	Cardinality	Implement	Status
MFK^M06^MFK_M01
MSH Message Header	[1..1]	SHALL
SFT Software Segment
UAC User Authentication Credential Segment	[0..1]
MSA Message Acknowledgment	[1..1]	SHALL
ERR Error
MFI Master File Identification	[1..1]	SHALL
MFA Master File Acknowledgment

 

MFK_M01

MSH-15	MSH-16	Immediate ACK	Application Ack
Blank	Blank	ACK^M15^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	ACK^M04^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M06^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M07^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M05^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M16^ACK	-
Blank	Blank	-	-
Blank	Blank	ACK^M17^ACK	-
Blank	Blank	-	-
Blank	Blank	-	-
Blank	Blank	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
NE	NE	-	-
AL, SU, ER	NE	ACK^M13^ACK	-
AL, SU, ER	NE	ACK^M19^ACK	-
AL, SU, ER	NE	ACK^M14^ACK	-
AL, SU, ER	NE	ACK^M17^ACK	-
AL, SU, ER	NE	ACK^M02^ACK	-
AL, SU, ER	NE	ACK^M16^ACK	-
AL, SU, ER	NE	ACK^M08^ACK	-
AL, SU, ER	NE	ACK^M18^ACK	-
AL, SU, ER	NE	ACK^M09^ACK	-
AL, SU, ER	NE	ACK^M07^ACK	-
AL, SU, ER	NE	ACK^M10^ACK	-
AL, SU, ER	NE	ACK^M06^ACK	-
AL, SU, ER	NE	ACK^M11^ACK	-
AL, SU, ER	NE	ACK^M04^ACK	-
AL, SU, ER	NE	ACK^M12^ACK	-
AL, SU, ER	NE	ACK^M05^ACK	-
AL, SU, ER	NE	ACK^M15^ACK	-
NE	AL, SU, ER	-	-
AL, SU, ER	AL, SU, ER	ACK^M19^ACK	-

We need some ER7 examples...

We need some XML examples...