Professional Documents
Culture Documents
Communication Specifications
Original Instructions
V1.4.2
Contents
1. Introduction....................................................................................................................... 1
1.1. Reference ........................................................................................................................... 1
1.2. Motion Mode...................................................................................................................... 1
2. Interface Specifications..................................................................................................... 2
2.1. Transmission medium (from Layer 1 “Physical Layer” to Layer 2 “Data Link Layer” in
the OSI reference model) ............................................................................................................. 2
2.2. IEEE 802 (LAN) ................................................................................................................ 2
2.2.1. From Layer 1 “Physical Layer” to Layer 4 “Transport Layer” in the OSI Reference
Model .................................................................................................................................... 2
2.3. RS-232C ............................................................................................................................. 2
3. Application Layer Protocol ............................................................................................... 3
3.1. Glossary ............................................................................................................................. 3
3.1.1. Trigger Event ............................................................................................................. 3
3.1.2. Message ...................................................................................................................... 3
3.1.3. Segment...................................................................................................................... 3
3.1.4. Field............................................................................................................................ 3
3.1.5. Field Components ...................................................................................................... 3
3.1.6. Message Delimiters ................................................................................................... 3
3.1.7. Battery ....................................................................................................................... 4
3.2. Use of Escape Sequences in Text Fields........................................................................... 4
3.3. Editing Method for Unicode(UTF-8) ................................................................................ 5
3.4. Message and Trigger Event Supported by BiOLiS.......................................................... 6
3.5. Message Framework Summary........................................................................................ 6
3.6. Segment Framework Summary ....................................................................................... 6
3.7. Other Rules ....................................................................................................................... 7
3.8. Message Composition ....................................................................................................... 8
3.8.1. Explanatory Notes ..................................................................................................... 8
3.8.2. Clinical Test Order..................................................................................................... 8
3.8.3. Clinical Test Result.................................................................................................... 8
3.8.4. Patient Information Notification .............................................................................. 8
3.8.5. Test Result Information Referral – Patient Basis .................................................... 9
3.8.6. Test Result Information Referral – Sample Basis.................................................... 9
3.8.7. Test Order Information Referral ............................................................................. 10
3.9. Segment Component ....................................................................................................... 10
3.9.1. MSH - Message header segment ..............................................................................11
(1) Field separator ..........................................................................................................11
(2) Encoding characters ................................................................................................ 12
(3) Sending application ................................................................................................. 12
(4) Sending facility ........................................................................................................ 12
(5) Receiving application............................................................................................... 12
(6) Receiving facility...................................................................................................... 12
(7) Date/Time of message .............................................................................................. 12
(8) Security .................................................................................................................... 12
(9) Message type ............................................................................................................ 12
(10) Message control ID .................................................................................................. 13
V1.4.2
Revision History
Edition Date Revision Summary
1.1 2016/04/04 Corrected the mistake of the item from “4.6 Test Result
Referral” to”4.6 Test Order Referral"
1. Introduction
This specifications defines the communication between BiOLiS 30i (BiOLiS) and
Laboratory Information System (LIS). The BiOLiS has the settings of the following
motion modes. Please read this specifications after you decide the operation procedures
by thoroughly talking with users.
1.1. Reference
HL7 Messaging Standard Version 2.5: An Application Protocol for Electronic Data
Exchange in Healthcare Environments
The change of the operation methods may lead the modification of the LIS. Again, we
kindly ask for your understanding.
If there's anything you are unclear on, please contact us.
1
V1.4.2
2. Interface Specifications
2.1. Transmission medium (from Layer 1 “Physical Layer” to Layer 2 “Data Link Layer” in the
OSI reference model)
There may be the following 2 models and the IEEE 802(LAN) has been
implemented.
・IEEE 802 (LAN)
・RS-232C
The RS-232C is Not implemented in consideration of the current trend.
2.3. RS-232C
Not implemented
2
Communication Specifications
3.1.2. Message
A message is the atomic unit of data transferred between systems. It is comprised of a
group of segments in a defined sequence. Each message has a message type that defines its
purpose.
3.1.3. Segment
An HL7 segment is a logical grouping of data fields. Segments of a message may be
required or optional. They may occur only once in a message or they may be allowed to
repeat. Each segment is identified by a unique three character code known as the
Segment ID.
3.1.4. Field
An HL7 field is a string of characters defined by one of the HL7 data types, e.g.
measurement item name. The field may have a group of data describing the detail of
the basic attribute.
3.1.7. Battery
The word battery is used in this specification synonymously with the word profile or
panel. The individual observation elements within a battery may be characteristic of a
physiologic system (e.g., liver function tests), or many different physiologic systems. Vital
signs (conventionally) consist of diastolic and systolic blood pressure, pulse, and respiratory
rate. Electrolytes usually consist of Na+, K+, Cl- and HCO3-. Routine admission tests might
contain CBC, Electrolytes, SMA12, and Urinalysis. (Note that the elements of a battery for
our purposes may also be batteries). Obstetrical ultrasound is a battery made up of
traditional component measurements and the impression, all of which would be returned
as separate results when returned to the requestor. A test involving waveform recording
(such as an EKG) can be represented as a battery comprised of results of many categories,
including digital waveform data, labels and annotations to the data, measurements, and
the impression.
4
Communication Specifications
Exception
¥¥ ¥ Escape character
Characters except for the above special character
¥A¥ Ignorance
¥F...¥ Ignorance
Others
|...¥S| ...^ Regards it as “¥S¥”.
|...¥S...| ... Ignores “¥S...”.
5
V1.4.2
6
Communication Specifications
7
V1.4.2
8
Communication Specifications
9
V1.4.2
11
V1.4.2
12
Communication Specifications
Implementation: The following table is excerpted from the HL7 Table 0076, 0003,
0354 about only the messages being used in this specifications.
Message type Message
OML^o35^OML_o35 Clinical test order
ORL^o36^ORL_o36 Response to the clinical test order
OUL^R23^OUL_R23 Clinical test result
ACK^R23^ACK Response to the clinical test result
ADT^A08^ADT_A01 Patient information notification
ACK^A08^ACK Response to the patient information notification
QBP^ZB5^QBP_Q11 Test result information referral (patient basis)
RSP^ZB6^RSP_ZB6 Response to the test result information referral
(patient basis)
QBP^ZB7^QBP_Q11 Test result information referral (sample basis)
RSP^ZB8^RSP_ZB8 Response to the test result information referral
(sample basis)
QBP^WOS^QBP_Q11 Test order information referral
RSP^WOS^RSP_K11 Response to the test order information referral
(10) Message control ID
Definition: This field contains a number or other identifier that uniquely identifies
the message.
Implementation: YYYYMMDDHHMMSS[FFF] or use a unique number as needed.
(11) Processing ID
Components: <Processing ID(ID)>^<Processing Mode(ID)>
Definition: This field is used to decide whether to process the message.
Implementation: Not used
(12) Version ID
Components: <Version ID(ID)>^<Internationalization
Code(CWE)>^<International Version ID(CWE)>
Definition: This field identifies the version ID and ensure that the message will be
interpreted correctly. The version ID of this rule is designated with 2.5.
Implementation: Only uses Version ID. Fixes “2.5”.
(13) Sequence number
Definition: A non null value in this field implies that the sequence number protocol
is in use. This numeric field is incremented by one for each subsequent
value.
Implementation: Not used
(14) Continuation pointer
Definition: This field is used to define continuations in application-specific ways.
Implementation: Not used
(15) Accept acknowledgment type
Definition: This field identifies the conditions under which accept
acknowledgments are required to be returned in response to this message.
Required for enhanced acknowledgment mode.
Implementation: Not used
(16) Application acknowledgment type
Definition: This field identifies the conditions under which accept
acknowledgments are required to be returned in response to this message.
13
V1.4.2
14
Communication Specifications
15
V1.4.2
16
Communication Specifications
17
V1.4.2
18
Communication Specifications
sequence. Refer to HL7 Table 0201 - Telecommunication Use Code and HL7
Table 0202 - Telecommunication Equipment Type for valid values.
Implementation: Not used
(14) Phone number - Business
Definition: This field contains the patient’s business telephone numbers. All
business numbers for the patient are sent in the following sequence. The
first sequence is considered the patient’s primary business phone number
(for backward compatibility). If the primary business phone number is not
sent, then a re-peat delimiter must be sent in the first sequence. Refer to
HL7 Table 0201 - Telecommunication Use Code and HL7 Table 0202 -
Telecommunication Equipment Type for valid values.
Implementation: Not used
(15) Primary language
Definition: This field contains the patient’s primary language. HL7 recommends
using ISO table 639 as the suggested values in User-defined Table 0296 -
Primary Language.
Implementation: Not used
(16) Marital status
Definition: This field contains the patient’s marital (civil) status. Refer to
User-defined Table 0002 - Marital Status for suggested values.
Implementation: Not used
(17) Religion
Definition: This field contains the patient’s religion. Refer to User-defined Table
0006 - Religion for suggested values.
Implementation: Not used
(18) Patient account number
Definition: This field contains the patient account number assigned by accounting
to which all charges, payments, etc., are recorded. It is used to identify the
patient’s account.
Implementation: Not used
(19) SSN number
Definition: This field contains the patient’s social security number and has been
retained for backward compatibility only.
Implementation: Not used
(20) Driver's license number
Definition: This field contains the patient’s driver’s license number. This field has
been retained for backward compatibility only.
Implementation: Not used
(21) Mother's identifier
Definition: This field is used, for example, as a link field for newborns. Typically a
patient ID or account number may be used.
Implementation: Not used
(22) Ethnic group
Definition: This field further defines the patient’s ancestry.
Implementation: Not used
(23) Birth place
Definition: This field indicates the location of the patient’s birth.
19
V1.4.2
20
Communication Specifications
update date/time, then the EMPI could decide not to apply the
patient’s/person’s demo-graphic and identifying data from this transaction.
Implementation: Not used
(34) Last update facility
Definition: This field identifies the facility of the last update to a patient’s/person’s
identifying and demographic data, as defined in the PID segment. Receiving
systems or users will use this field to determine how to apply the
transaction to their systems. If the receiving system (such as a hospital’s
patient management system) already has a record for the patient/person,
then it may decide to only update its data if the source is a “trusted” source.
A hospital might consider other hospitals trusted sources, but not “trust”
updates from non-acute care facilities.
Implementation: Not used
(35) Species code
Definition: The species of living organism. This may include the common or
scientific name, based on the coding system(s) used. SNOMED is the
recommended coding system. If this field is not valued, a human is assumed.
Refer to User-defined Table 0446 - Species Code for suggested values.
Implementation: Not used
(36) Breed code
Definition: The specific breed of animal. This field, unlike Species and Strain is
specific to animals and cannot be generally used for all living organisms.
SNOMED is the recommended coding system. Refer to User-defined Table
0447 - Breed Code for suggested values.
Implementation: Not used
(37) Strain
Definition: This field contains the specific strain of animal. It can also be expanded
to include strain of any living organism and is not restricted to animals.
Implementation: Not used
(38) Production class code
Definition: This field contains the code and/or text indicating the primary use for
which the living subject was bred or grown. Refer to User-defined Table
0429 - Production Class Code for suggested values. For example:
Implementation: Not used
(39) Tribal citizenship
Definition: This field contains the information related to a person's tribal
citizenship.
Implementation: Not used
21
V1.4.2
22
Communication Specifications
precisely described as ‘capillary venous blood’ but the code set employed
only provided ‘venous blood,’ this attribute could be employed to add the
modifier ‘capillary.’
Refer to User-Defined Table 0541 Specimen Type Modifier for suggested
values.
Implementation: Not used
(6) Specimen additives
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST>^<Original text(ST)>
Definition: This field identifies any additives introduced to the specimen before or
at the time of collection. These additives may be introduced in order to
preserve, maintain or enhance the particular nature or component of the
specimen. Refer to HL7 Table 0371 – Additive for valid values.
Implementation: Not used
(7) Specimen collection method
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: Describes the procedure or process by which the specimen was collected.
Any nationally recognized coding system might be used for this field
including SNOMED; alternatively the HL7 defined table 0488 may be used.
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry.
Implementation: Not used
(8) Specimen source site
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: specifies the source from which the specimen was obtained. For
example, in the case where a liver biopsy is obtained via a percutaneous
needle, the source would be ‘liver.’
Any nationally recognized coding system might be used for this field
including SNOMED; alternatively the HL7 defined table 0070 may be used.
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry.
Implementation: Not used
(9) Specimen source site modifier
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains modifying or qualifying description(s) about the
specimen source site.
24
Communication Specifications
The use of this attribute is to modify, qualify or further specify, the entity
described by SPM-8 – Specimen Source Site. This is particularly useful
when the code set used in SPM-8 does not provide the precision required to
fully describe the site from which the specimen originated. For example, if
the specimen source site was precisely described as ‘left radial vein’ but the
code set employed only provided ‘radial vein,’ this attribute could be
employed to add the modifier ‘left.’
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry. Refer to User-Defined Table 0542 –
Specimen Source Type Modifier for suggested values.
Implementation: Not used
(10) Specimen collection site
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST>^<Original text(ST)>
Definition: This field differs from SPM-8-Specimen Source Site in those cases
where the source site must be approached via a particular site (e.g.,
anatomic location). For example, in the case where a liver biopsy is obtained
via a percutaneous needle, the collection site would be the point of entry of
the needle. For venous blood collected from the left radial vein, the
collection site could be “antecubital fossa”.
Veterinary medicine may choose the tables supported for the components of
this field as decided by their industry.
Refer to User-Defined Table 0543 – Specimen Collection Site for suggested
values.
Implementation: Not used
(11) Specimen role
Components: Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field indicates the role of the sample. Refer to User-defined Table
0369 – Specimen role for suggested values. Each of these values is normally
identifiable by the systems and its components and can influence processing
and data management related to the specimen.
If this field is not populated, then the specimen described has no special, or
specific, role other than serving as the focus of the observation. Such
specimens include patient, environmental and other specimens that are
intended for analysis.
A grouped specimen consists of identical specimen types from multiple
individuals that do not have individual identifiers and upon which the same
services will be performed. If the specimen role value is “G” then the
Grouped Specimen Count (SPM-13) must be valued with the total number
of specimens contained in the group.
If the specimen role is “L”, the repetitions of Parent Specimen ID (SPM-4)
represent the individual parent specimens that contribute to the pooled
25
V1.4.2
26
Communication Specifications
27
V1.4.2
28
Communication Specifications
29
V1.4.2
30
Communication Specifications
Entity identifier.
Sample position mode Not used. However, in this mode, if the sample
is labeled with the barcode, the test result is
displayed in the clinical test result message.
(4) Primary (parent) container identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: If this field is filled in, it identifies the primary container from which
this specimen came. For primary samples this field is empty; for aliquot
samples this field should contain the identifier of primary container.
Implementation: Not used
(5) Equipment container identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the container in a particular device (e.g., one
container in a carousel or rack of containers within an analyzer, analyzer
specific bar code mapping, etc.).
Implementation: Not used
(6) Specimen source
Components: <Specimen source name or
code(CWE)>^<Additives(CWE)>^<Specimen collection
method(TX)>^<Body site(CWE)>^<Site modifier(CWE)>^<Collection
method modifier code(CWE)>^<Specimen role(CWE)>
Definition: This field is the site where the specimen should be obtained or where
the service should be performed. This field is deprecated and retained for
backward compatibility. This field is conditional, meaning that, in case
where the SPM segment is used in a message together with the SAC, this
field should be ignored. The reader is referred to the SPM Specimen
segment in chapter 7.
Implementation: Not used
In case that QC samples are measured by the order from the LIS,
(Sample barcode mode) Special barcodes are made and the LIS judges with
only them. The BiOLiS measures them as patient samples. Conduct QC in
the LIS because the QC in the BiOLiS cannot be used.
For example, Control X-Low=9999900001, Control X-High=9999900002.
(Sample Position Mode) Designates the positions of the containers with
Position in carrier as stated below.
(7) Registration date/time
Definition: This field is the date/time that the container was last registered with
the "automated system.", e.g., reading of a container bar code by a device.
Implementation: Not used
(8) Container Status
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the status of the unique container in which the
specimen resides at the time that the transaction was initiated. Refer to
32
Communication Specifications
HL7 Table 0370 - Container status for valid values. The equipment specific
container status should be sent as <alternate identifier> as needed. The
container states are relevant for the exchange of information among devices
(within the LAS). Not all of them are relevant for information transfer
between the LAS and the LIS.
Implementation: Not used
(9) Carrier type
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the type of the carrier (see section Glossary). Refer
to User-defined Table 0378 – Carrier type for suggested values. Because the
geometry can be different, the carrier type should, if possible, express the
number of positions in the carrier. The definition assumes hierarchical
nesting using the following phrases: container is located in a carrier, carrier
is located in a tray.
Implementation: Not used
(10) Carrier identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the carrier. It is the ID (e.g., number or bar code) of
the carrier where the container (e.g., tube) is located. Example: A carrier
could be a rack with single or multiple specimen containers. A carrier is
usually used for automated specimen transport. Multiple carriers can be
stacked in a tray, which is then used for manual or automatic transport.
Implementation: Not used
(11) Position in carrier
Definition: This field identifies the position of the container in the carrier (e.g.,
1…3…). The sub-components allow, if necessary, to transfer multiple axis
information, e.g., 2-dimensional carrier (X^Y).
Implementation: Required in [Sample position mode]. Not used in [Sample
barcode mode]. However, in case of the [Sample barcode mode], the
information is described in the clinical test result message.
A tray number is described in the first component and a position is
described in the second component.
First Content Second Content
Component Component
1-30 For patient sample
1-50 Patient sample tray
31-45 For QC sample
61-66 Calibration tray 31-45 For QC sample
81-83 QC tray 1-45 For QC sample
(12) Tray type
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field identifies the type of the tray (see section Glossary). Refer to
User-defined Table 0379 – Tray type for suggested values. Because the
33
V1.4.2
geometry can be different, the tray type should if possible express the
number of positions in the tray. The definition assumes hierarchical nesting
using the following phrases: container is located in a carrier, carrier is
located in a tray.
Implementation: Not used
(13) Tray identifier
Components: <Entity identifier(ST)>^<Namespace ID(IS)>^<Universal
ID(ST)>^<Universal ID type(ID)>
Definition: This field identifies the tray identifier (e.g., a number of a tray or a bar
code on the tray), where the container carrier is located.
Implementation: Not used
(14) Position in tray
Definition: This field identifies the position of the carrier in the tray. The
sub-components allow, if necessary, to transfer multiple axis information,
e.g., 2-dimensional tray (X^Y).
Implementation: Not used
(15) Location
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the physical location that the specimen was at the time
that the transaction was initiated. The location description can vary with
the LAS. For example, it can be an X,Y,Z coordinate in a storage system; a
refrigerator number and drawer number where the container-carrier-tray is
located; or it can be the name of the institution and the laboratory which
owns the container currently. The repeating of this field allows for
hierarchical representation of location (lowest level first), e.g., shelf number,
refrigerator storage id, lab name, institution name, etc.
Implementation: Not used
(16) Container height
Definition: This field identifies the height of the container in units specified below.
Implementation: Not used
(17) Container diameter
Definition: This field identifies the outside diameter of the container in units
specified below.
Implementation: Not used
(18) Barrier delta
Definition: This field identifies the distance from the Point of Reference to the
separator material (barrier) within the container in units specified below.
This distance may be provided by the LAS to the instrument and/or
specimen processing/handling device to facilitate the insertion of a sampling
probe into the specimen without touching the separator. Refer to Point Of
Reference definition in section Glossary or in NCCLS standard AUTO5
Laboratory Automation: Electromechanical Interfaces.
Implementation: Not used
(19) Bottom delta
Definition: This field identifies the distance from the Point of Reference to the
34
Communication Specifications
35
V1.4.2
36
Communication Specifications
(31) Temperature
Components:
<Comparator(ST)>^<num1(NM)>^<Separator/Suffix(ST)>^<Num2(NM)>
Definition: This field identifies the specimen temperature in degrees Celsius [°C]
at the time of the transaction specified in the EQU segment.
Implementation: Not used
(32) Hemolysis index
Definition: This field is the index identifier that is being used to describe the
Hemolysis Index of the specimen.
Implementation: Not used
(33) Hemolysis index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Hemolysis Index of the specimen. It is recommended to use g/L. (The
transmission of the index values is added here instead of the original use of
the OBX segments, because the frequency of the transfer of the specimen
details justifies use of more efficient mechanism.)
Implementation: Not used
(34) Lipemia index
Definition: This field is the index identifier that is being used to describe the
Lipemia Index of the specimen. It is recommended to use the optical
turbidity at 600 nm (in absorbance units).
Implementation: Not used
(35) Lipemia index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Lipemia Index of the specimen. If this field is null, the recommended value
is assumed.
Implementation: Not used
(36) Icterus index
Definition: This field is the index identifier that is being used to describe the
Icterus Index of the specimen.
Implementation: Not used
(37) Icterus index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Icterus Index of the specimen. It is recommended to use mMol/L of bilirubin.
Implementation: Not used
(38) Fibrin index
Definition: This field is the index identifier that is being used to describe the
Fibrin Index of the specimen. In the case of only differentiating between
37
V1.4.2
Absent and Present, we recommend using 0 and 1 respectively and send the
field Fibrin Index Units null.
Implementation: Not used
(39) Fibrin index units
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field is the unit's identifier that is being used to describe the
Fibrin Index of the specimen.
Implementation: Not used
(40) System induced contaminants
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes the specimen contaminant identifier that is
associated with the specimen in this container. Refer to User-defined Table
0374 – System induced contaminants for valid values. This table's values
are taken from NCCLS AUTO4. The value set can be extended with user
specific values.
Implementation: Not used
(41) Drug interference
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes the drug interference identifier that is associated
with the specimen. Refer to User-defined Table 0382 – Drug interference for
suggested values.
Implementation: Not used
(42) Artificial blood
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes the artificial blood identifier that is associated with
the specimen. Refer to User-defined Table 0375 – Artificial blood for valid
values. This table's values are taken from NCCLS AUTO4. The value set
can be extended with user specific values.
Implementation: Not used
(43) Special handling consideration
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(IS)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(IS)>
Definition: This field describes any special handling considerations that are
associated with the specimen in the specific container (e.g. centrifugation).
This describes how the specimen needs to be stored during collection, in
transit, and upon receipt. Refer to User-defined Table 0376 – Special
handling code for valid values. The value set can be extended with user
specific values.
38
Communication Specifications
39
V1.4.2
In the implementation of this specifications, all fields in the OBR segment in the
clinical test order message (OML-o35) are Not used. The OBR segment in the clinical
test result message (OUL-R23) and the referral message for clinical result information
(RSP-ZB6/RSP-ZB8) are used about SEQ20:Filler Field1 only.
Moreover, in this specifications, repetition of the OBR segment is Not allowed (one
time use in one message).
SEQ LEN DT OPT RP# ITEM# ELEMENT NAME
1 4 SI N N 00237 Set ID - Observation request
2 22 EI N N 00216 Placer order number
3 22 EI N N 00217 Filler order number
4 250 CWE N N 00238 Universal service ID
5 2 ID N N 00239 Priority
6 26 TS N N 00240 Requested date/time
7 26 TS N N 00241 Observation date/time
8 26 TS N N 00242 Observation end date/time
40
Communication Specifications
41
V1.4.2
42
Communication Specifications
43
V1.4.2
Refer to HL7 Table 0065 - Specimen Action Code for valid values.
Implementation: Not used
(12) Danger code
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the code and/or text indicating any known or
suspected patient or specimen hazards, e.g., patient with active tuberculosis
or blood from a hepatitis patient. Either code and/or text may be absent.
However, the code is always placed in the first component position and any
free text in the second component. Thus, free text without a code must be
preceded by a component delimiter.
Implementation: Not used
(13) Relevant clinical code
Definition: This field contains the additional clinical information about the patient
or specimen. This field is used to report the suspected diagnosis and clinical
findings on requests for interpreted diagnostic studies. Examples include
reporting the amount of inspired carbon dioxide for blood gasses, the point
in the menstrual cycle for cervical pap tests, and other conditions that
influence test interpretations. For some orders this information may be sent
on a more structured form as a series of OBX segments that immediately
follow the order segment.
Implementation: Not used
(14) Specimen received date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field has been retained for backward compatibility only. As of
version 2.5, in messages where the SPM segment is present, the use of
SPM-18 Specimen Received Date/Time is favored over this field.
Implementation: Not used
(15) Specimen source
Components: <Specimen source name or
code(CWE)>^<Additive(CWE)>^<Specimen collection method(TX)>^<Body
site(CWE)>^<Site modifier(CWE)^<Collection method modifier
code(CWE)>^<Specimen role(CWE)>
Definition: This field has been retained for backward compatibility only. As of
version 2.5, in messages where the SPM segment is present, the use of SPM
Specimen segment is favored over this field.
Implementation: Not used
(16) Ordering provider
Components: <ID number(ST)>^<Family Name(FN)>^<Given
name(ST)>^<Second and further given name or initials
thereof(ST)>^<Suffix(e.g.,JR or
Ⅲ)(ST)>^<Prefix(e.g.,DR)(ST)>^<Degree(e.g.,MD)(IS)>^<Source
table(IS)>^<Assigning authority(HD)>^<Name type code(ID)>^<Identifier
check digit(ST)>^<Check digit scheme(ID)>^<Identifier type
code(ID)>^<Assigning facility(HD)>^<Name representation
44
Communication Specifications
45
V1.4.2
46
Communication Specifications
47
V1.4.2
applicable. Refer to HL7 Table 0124 - Transportation Mode for valid codes.
Implementation: Not used
(31) Reason for study
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This is required for some studies to obtain proper reimbursement.
Implementation: Not used
(32) Principal result interpreter
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the physician or other clinician who interpreted the
observation and is responsible for the report content.
Implementation: Not used
(33) Assistant result interpreter
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the clinical observer who assisted with the
interpretation of this study.
Implementation: Not used
(34) Technician
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the performing technician.
Implementation: Not used
(35) Transcriptionist
Components: <Name(CNN)>^<Start date/time(TS)>^<End
date/time(TS)>^<Point of
care(IS)>^<Room(IS)>^<Bed(IS)>^<Facility(HD)>^<Location
status(IS)>^<Patient location type(IS)>^<Building(IS)>^<Floor(IS)>
Definition: This field identifies the report transcriber.
Implementation: Not used
(36) Scheduled date/time
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: This field is the date/time the filler scheduled an observation, when
applicable (e.g., action code in OBR-11-specimen action code = "S"). This is a
result of a request to schedule a particular test and provides a way to inform
the placer of the date/time a study is scheduled (result only).
Implementation: Not used
48
Communication Specifications
49
V1.4.2
50
Communication Specifications
51
V1.4.2
52
Communication Specifications
referral message repeats for the number of times of all test results for the
specimen.
(2) Value type
Definition: This field contains the format of the observation value in OBX.
Implementation: This field in a clinical test order message is Not used. That is ||.
This field in a clinical test result message and test result information
referral message is fixed to CWE type. That is |CWE|. This is the fifth field
in this segment.
(3) Observation identifier
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains a unique identifier for the observation.
Implementation: The <Identifier(ST)> is set on a Test Item ID and is used in NM
type. The BiOLiS has a master of “test item ID” versus “item number in
BiOLiS” and matches them (Required). The <Text(ST)> is set on an Item
Name (Option). The value of this component in a clinical test order message
is ignored. Item Name of BiOLiS is described in this component in a clinical
test result message and a test result information referral message.
The <Name of coding system(ID)> is ignored.
The <Alternate text(ST)> is ignored.
The <Name of alternate coding system(ID)> is ignored.
The <Coding system version ID(ST)> is ignored.
The <Alternate coding system version ID(ST)> is ignored.
The <Original text(ST)> is ignored.
(4) Observation Sub ID
Definition: This field is used to distinguish between multiple OBX segments with
the same observation ID organized under one OBR.
Implementation: This field in a clinical test order message is Not used. That is ||.
This field in a clinical test result message and a test result information
referral message has a meaning as follows. A test item for a specimen may
be tested multiple times. This field is used in NM type and is described how
many times the test results were.
(5) Observation value
Components: <Identifier(ST)>^<Text(ST)>^<Name of coding
system(ID)>^<Alternate identifier(ST)>^<Alternate text(ST)>^<Name of
alternate coding system(ID)>^<Coding system version ID(ST)>^<Alternate
coding system version ID(ST)>^<Original text(ST)>
Definition: This field contains the value observed by the observation producer.
OBX-2-value type contains the data type for this field according to which
observation value is formatted. This field is required for OBX segment. A
response must be recorded by ASCII character code no matter whether this
is a value or a short texts.
Implementation: This field in a clinical test order is Not used. That is ||. This
field in a clinical test result message and a test result information referral
message is fixed for CWE type.
53
V1.4.2
54
Communication Specifications
|12.3-23.4|.
b) If only a lower limit is defined, this is described as |>12.3|.
c) If only an upper limit is defined, this is described as |<23.4|.
(8) Abnormal Flags
Definition: This field contains a table lookup indicating the normalcy status of the
result.
This field in a clinical test order message is Not used. That is ||. This field in a
clinical test result message and a test result information referral message is
described as below:
Value Content
null Within reference range
L Below lower limit
H Above upper limit
(9) Probability
Definition: This field contains the probability of a result being true for results with
categorical values. It mainly applies to discrete coded results.
Implementation: Not used
(10) Nature of abnormal test
Definition: This field contains the nature of the abnormal test. Refer to HL7 Table
0080 - Nature of abnormal testing for valid values. As many of the codes as
apply may be included, separated by repeat delimiters. For example, normal
values based on age, sex, and race would be codes as A~S~R.
Implementation: Not used
(11) Observation result status
Definition: This field contains the observation result status. Refer to HL7 table
0085 - Observation result status codes interpretation for valid values. This
field reflects the current completion status of the results for one
Observation Identifier.
This field in a clinical test order message is Not used. That is ||. This field in a
clinical test result message and a test result information referral message is
described as below:
Value Content
F Final results
D Deletes the OBX record
No result
O
No result, not yet at a referral.
Post original as wrong, e.g., transmitted for wrong patient
W Not guarantee the Observation value due to a disorder of some
kind.
(12) Effective date of reference range
Components: <Time(DTM)>^<DEPRECATED-degree of precision(ID)>
Definition: If the value measured by the old method can’t be compared with the
one by the updated method, this means the changed date of these
measurement methods.
Implementation: Not used
(13) User defined access check
Definition: This field permits the producer to record results-dependent codes for
55
V1.4.2
57
V1.4.2
59
V1.4.2
60
Communication Specifications
used.
BiOLiS Entity identifier
Required. Samples are identified with
Sample barcode mode
Entity identifier values.
Sample position mode Not used
(5) Position in carrier
Components: <Tray number(NM)>^<Position number(NM)>
Implementation: In case of the test result information referral – the specimen
basis (QBP^ZB7/RSP^ZB8) and the test order information referral
(QBP^WOS/RSP^WOS), this is used to identify the sample. The first
component displays the tray number and the second component displays
the position. Doesn’t allow the referral for multiple samples.
First Content Second Content
Component Component
1-30 For patient sample
1-50 Patient sample tray
31-45 For QC sample
61-66 Calibration tray 31-45 For QC sample
81-83 QC tray 1-45 For QC sample
Note: In case of the test result information referral – the specimen basis
(QBP^ZB7/RSP^ZB8) and the test order information referral
(QBP^WOS/RSP^WOS), the extraction condition of the combination of
[Container identifier] and [Position in carrier] is Not allowed. Set “null” for
which one of them.
61
V1.4.2
62
Communication Specifications
Definition: For queries requesting a tabular response, this field specifies by which
fields the response is to be sorted, and the order(s) in which sorting is to be
performed.
Implementation: Not used
(7) Segment group inclusion
Definition: Specifies those optional segment groups which are to be included in the
response. Refer to HL7 Table 0391—Segment group for values for Segment
Group. This is a repeating field, to accommodate inclusion of multiple
segment groups. The default for this field, not present, means that all
relevant groups are included.
Implementation: Not used
63
V1.4.2
64
Communication Specifications
65
V1.4.2
66
Communication Specifications
67
V1.4.2
68
Communication Specifications
69
V1.4.2
Single type
Data type Data type name Length
ST String data 199
TX Text data 65536
NM Numeric 16
SI Sequence ID 4
ID Coded value for HL7 defined tables Variable
IS Coded value for user-defined tables 20
DT Date 8
DTM Date/time 24
Complex type
Data type Data type name
SRT Sort order
CQ Composite quantity with units
MO Money
SN Structured numeric
EI Entity identifier
HD Hierarchic designator
PT Processing type
VID Version identifier
TS Time stamp
CNN Composite ID number and name simplified
CWE Coded with exceptions
CX ID Extended composite ID with check digit
XCN Extended composite ID number and name for persons
EIP Entity identifier pair
ELD Error location and description
MOC Money and charge code
MSG Message type
NDL Name with date and location
OSD Order sequence definition
PRL Parent result link
SPS Specimen source
FN Family name
SAD Street address
XAD Extended address
XPN Extended person name
XTN Extended telecommunication number
NA Numeric array
DLN Driver’s license number
DR Date/time range
RI Repeat interval
70
Communication Specifications
3.10.3. NM - numeric
SEQ Length Content
1 16 Numeric
A number represented as a series of ASCII numeric characters consisting of an
optional leading sign, the digits and an optional decimal point. A leading sign (+) can
be omitted. A place after the decimal point can be omitted.
3.10.4. SI - sequence ID
SEQ Length Content
1 4 Sequence ID
A non-negative integer in the form of a NM field.
3.10.7. DT - date
SEQ Length Content
1 8 Date
This is described as “YYYYMMDD”. In HL7, DD and MMDD can be omitted.
However, this omission is Not allowed in this specifications.
71
V1.4.2
3.10.11. MO - money
SEQ Length DT Content
1 16 NM Quantity
2 3 ID Denomination
The explanation is omitted because the MO is not used in this specifications.
72
Communication Specifications
73
V1.4.2
7 5 IS Degree(e.g.,MD)
8 4 IS Source table
9 20 IS Assigning authority - Namespace ID
10 199 ST Assigning authority - Universal ID
11 6 ID Assigning authority - Universal ID type
The explanation is omitted because the CNN type is not used in this specifications.
3.10.19. CWE - coded with exceptions
SEQ Length DT Content
1 20 ST Identifier
2 199 ST Text
3 20 ID Name of coding system
4 20 ST Alternate identifier
5 199 ST Alternate text
6 20 ID Name of alternate coding system
7 10 ST Coding system version ID
8 10 ST Alternate coding system version ID
9 199 ST Original text
Only the Identifier and the Text are used in this specifications. Refer to Chapter 3.9.
Segment Component about the use/usage in this specifications.
74
Communication Specifications
75
V1.4.2
3 26 TS End date/time
4 20 IS Point of care
5 20 IS Room
6 20 IS Bed
7 227 HD Facility
8 20 IS Location status
9 20 IS Patient location type
10 20 IS Building
11 20 IS Floor
The explanation is omitted because the NDL type is not used in this specifications.
76
Communication Specifications
77
V1.4.2
13 26 TS Expiration date
14 199 ST Professional suffix
Refer to Chapter 3.9. Segment Component about the use/usage in this specifications.
78
Communication Specifications
79
V1.4.2
4. Message Examples
4.1. Clinical Test Order
The order can be sent from the LIS to the BiOLiS when the order in the LIS was
determined. No example is in the first edition of this specifications.
[VT]
MSH|^~¥&|^BiOLiS30i^||^Laboratory Information
System^||20160210^||OUL^R23^OUL_R23^^|20160210041339||2.5^&&&&&&
&&^&&&&&&&&||||||ASCII|||[CR]
PID|||0000999999^^^&&^^&&^^^&&&&&&&&^&&&&&&&&||&&&&^^^^^^
^^&&&&&&&&^^^&^&^||^||||||||||||||||||||||||||||||||[CR]
SPM||||SER^^^^^^^^|||||||||||||||||||||||||[CR]
SAC|||503050115^^^||||||||1^1^^|||||||||||||||||||||||||||||||||[C
R]
OBR|||||||||||||||||||||||||||||||||||||||||||||||||[CR]
OBX|1|CWE|1^Item001^^^^^^^|1|2.441^^^^^^^^|mg/dL^^^^^^^^|||||F||^
1|20160210040844^|||||[CR]
[FS][CR]
80
Communication Specifications
[VT]
MSH|^~¥&|^Laboratory Information System||^BiOLiS30i||20160212||
ADT^A08^ADT_A01 |20160212||2.5||||||UNICODE UTF-8|||[CR]
EVN||20160212161713||||[CR]
PID|||0000777777||¥MEFBBBF¥¥XE38282E3828A¥^¥MEFBBBF¥¥XE381A8E
38197E3818A¥||19850303|M|||||||||||||||||||||||||||||||[CR]
[FS][CR]
ACK^A08^ACK
[VT]
MSH|^~¥¥&|^BiOLiS30i^||^Laboratory Information
System^||20160212^||ACK^A08^ACK^^|20160212175548||2.5^&&&&&&&&^
&&&&&&&&||||||ASCII|||[CR]
MSA|AA|20160212175548||||[CR]
[FS][CR]
81
V1.4.2
[VT]
MSH|^~¥&|^BiOLiS30i^||^Laboratory Information
System^||20160210^||QBP^WOS^QBP_Q11^^|20160210052921||2.5^&&&&&
&&&^&&&&&&&&||||||ASCII|||[CR]
QPD|^^^^^^^^||^^^&&^^&&^^^&&&&&&&&^&&&&&&&&|160210000101^^
^|1^1^^[CR]
RCP|||||||[CR]
[FS][CR]
RSP^WOS^RSP_K11
[VT]
MSH|^~¥&|^Laboratory Information
System||^BiOLiS30i||20160210||RSP^WOS^RSP_K11|20160210||2.5||||||A
SCII|||[CR]
MSA|AA|20160210052921|||[CR]
QAK||OK|^^^^^^^^|||[CR]
QPD|^^^^^^^^|||160210000101||[CR]
SPM||||SER||||||||||||||||||||||||[CR]
OBR||||||||||||||||||||||[CR]
OBX|1||1^Item001||||||||[CR]
OBX|2||2^Item002||||||||[CR]
OBX|3||3^Item003||||||||[CR]
[FS][CR]
82
Communication Specifications
[VT]
MSH|^~¥&|^BiOLiS30i^||^Laboratory Information
System^||20160212^||QBP^WOS^QBP_Q11^^|20160212111222||2.5^&&&&&&
&&^&&&&&&&&||||||ASCII|||[CR]
QPD|^^^^^^^^||^^^&&^^&&^^^&&&&&&&&^&&&&&&&&|160210000101^^^
|1^3^^[CR]
RCP|||||||[CR]
[FS][CR]
RSP^WOS^RSP_K11
[VT]
MSH|^~¥&|^Laboratory Information
System||^BiOLiS30i||20160212||RSP^WOS^RSP_K11|20160212||2.5||||||U
NICODE UTF-8|||[CR]
MSA|AA|20160212111222|||[CR]
QAK||OK|^^^^^^^^|||[CR]
QPD|^^^^^^^^||0000888888||1^3^^|[CR]
SPM||||SER||||||||||||||||||||||||[CR]
OBR||||||||||||||||||||||[CR]
OBX|1||2^Item002||||||||[CR]
OBX|3||6^Item006||||||||[CR]
[FS][CR]
83
V1.4.2
Communication Specifications
Version 1.4.2
Oct. 15, 2018
Printed in Japan
84