Applies to:V 2.11.0
Introduction
This document specifies the electronic data exchange for EnvisionNEXT products from Miracle Advance Technologies using the HL7 v2.3 standard.
Important Note: Specifications declared in this document are subject to change without notice. For notifications, please contact us in advance for the latest updates.
Terms, Descriptions, and Abbreviations
The terms, descriptions, and abbreviations used in this document are given below with their formal names.
- PACS: Picture Archiving and Communication System
- HL7: Health Level Seven
- TCP/IP: Transmission Control Protocol / Internet Protocol
- MLLP: Minimal Lower Layer Protocol
Supported Message List
| Message Definition | Message Type | Event Code | Remark |
|---|---|---|---|
| Acknowledgment message | ACK | – | |
| Update patient information | ADT | A08 | |
| Merge patient information | ADT | A18 | |
| Order message | ORM | 001 | |
| Bi-directional | ORM | 001 | Synapse Standard |
| Unsolicited transmission of an observation message | ORU | R01 |
Transportation Profile
MLLP
As it is recommended in HL7 v.2.3, Minimal Lower Layer Protocol (MLLP) is supported for Envision.Net as a transportation protocol. MLLP is a protocol that is based on TCP/IP with OSI7 layering. Due to their recommendations to provide background among layers, HL7 messages.
- Starts with 0x0B.
- Ends with 0x1C and 0x0D.
- Each segment ends with 0x0D
HL7 Messages
Introduction
Up to HL7 v3.0, all previous versions were formed of segments. Each message has been described withmessage formulas while it has been formalized
- The segments written without any prefix are mandatory
- The segments stated in [ ] are optional
- { } represents segment blocks
HL7 Message Grammars
The message grammars of the HL7 messages supported in Envision.Net PACS & RIS are below;
ACK: Acknowledgment message
| Segment | Description |
|---|---|
| MSH | Message Header |
| MSA | Message Acknowledgment |
ADT^A08 : Update patient information
| Segment | Description |
|---|---|
| MSH | Message Header |
| PID | Patient Identification |
| [PV1] | Patient Visit |
ADT^A18: Merge patient information
| Segment | Description |
|---|---|
| MSH | Message Header |
| PID | Patient Identification |
| MRG | Merge Information |
ORM^O01: Order message
| Segment | Description |
|---|---|
| MSH | Message Header |
| PID | Patient Identification |
| [PV1] | Patient Visit |
| ORC | Common Order |
| OBR | Observation Request |
ORM^O01 : Bi-directional
| Segment | Description |
|---|---|
| MSH | Message Header |
| PID | Patient Identification |
| [PV1] | Patient Visit |
| ORC | Common Order |
| OBR | Observation Request |
| ZDS | Additional Identification Information |
ORU^R01: Unsolicited transmission of an observation message
| Segment | Description |
|---|---|
| MSH | Message Header |
| PID | Patient Identification |
| [PV1] | Patient Visit |
| ORC | Common Order |
| OBR | Observation Request |
| OBX | Observation/Results |
HL7 Message Segments
Notes on table structure
The segments used in Envision.Net PACS & RIS HL7 messaging are listed below in the form fora m of a table. If we describe the columns in order
- SEQ: Sequence of field
- NAME: Name of field
- TYPE: Data type of HL7 standard
- LEN: Maximum number of characters
- REMARK: …
USE:
- O = Optional
- R = Required
- U = Unused
Segments
MSH|^~\&|||||||ORM^O01|20130101_1|P|2.3
| SEQ | NAME | TYPE | LEN | USE | REMARK |
|---|---|---|---|---|---|
| 1 | FIELD SEPARATOR | ST | 1 | R | Fix – | |
| 2 | ENCODING CHARACTERS | ST | 4 | R | Fix – ^~& |
| 3 | SENDING APPLICATION | HD | 180 | U | |
| 4 | SENDING FACILITY | HD | 180 | U | |
| 5 | RECEIVING APPLICATION | HD | 180 | U | |
| 6 | RECEIVING FACILITY | HD | 180 | U | |
| 7 | DATE/TIME OF MESSAGE | TS | 26 | U | |
| 8 | SECURITY | ST | 40 | U | |
| 9 | MESSAGE TYPE | CM | 7 | R | |
| 10 | MESSAGE CONTROL ID | ST | 20 | O | Unique ID that uniquely identifies the message |
| 11 | PROCESSING ID | PT | 3 | R | Fix – P |
| 12 | VERSION ID | ID | 8 | R | Fix – 2.3 |
PID|||1|PATIENT_ID_EXT|12345678^Patient^Name^^^Mrs.||19900101|F|Patient^Name^Local^^^Ms.||Country||||||||123456789
| SEQ | NAME | TYPE | LEN | USE | REMARK |
|---|---|---|---|---|---|
| 1 | SET ID – PATIENT ID | SI | 4 | U | |
| 2 | PATIENT ID (EXTERNAL ID) | CK | 16 | U | |
| 3 | PATIENT ID (INTERNAL ID) | CK | 20 | R | HN |
| 4 | ALTERNATE PATIENT ID | ST | 12 | O | |
| 5 | PATIENT NAME | PN | 48 | O | |
| 6 | MOTHER’S MAIDEN NAME | ST | 30 | U | |
| 7 | DATE OF BIRTH | TS | 26 | O | Format: YYYYMMDD |
| 8 | SEX | IS | 1 | O | F = Female, M = Male, O = Other, U = Unknown |
| 9 | PATIENT ALIAS | XPN | 48 | R | |
| 10 | RACE | IS | 1 | U | |
| 11 | PATIENT ADDRESS | XAD | 106 | O | |
| 12 | COUNTY CODE | IS | 4 | U | |
| 13 | PHONE NUMBER – HOME | XTN | 40 | O | |
| 14 | PHONE NUMBER – BUSINESS | XTN | 40 | O | |
| 15 | LANGUAGE – PATIENT | CE | 25 | U | |
| 16 | MARITAL STATUS | IS | 1 | O | A = Separated, D = Divorced, M = Married, S = Single, W = Widowed |
| 17 | RELIGION | IS | 3 | U | |
| 18 | PATIENT ACCOUNT NUMBER | CX | 20 | U | |
| 19 | SSN NUMBER – PATIENT | ST | 16 | R | Patient social security number |
PV1|||||||||RAD001^Dr.^Attending Physician~RAD001^นพ.^แพทย์ผู้ทำการรักษา||OPD001^ห้องตรวจ 1||||||||12345
| SEQ | NAME | TYPE | LEN | USE | REMARK |
|---|---|---|---|---|---|
| 1 | SET ID – PATIENT VISIT | SI | 4 | U | |
| 2 | PATIENT CLASS | IS | 1 | O | I=IPD, O=OPD, U=Unknown |
| 3 | ASSIGNED PATIENT LOCATION | PL | 12 | U | |
| 4 | ADMISSION TYPE | IS | 2 | U | |
| 5 | PREADMIT NUMBER | CX | 20 | O | AN |
| 6 | PRIOR PATIENT LOCATION | PL | 12 | U | |
| 7 | ATTENDING DOCTOR | XCN | 60 | U | |
| 8 | REFERRING DOCTOR | XCN | 60 | U | |
| 9 | CONSULTING DOCTOR | XCN | 60 | O | Assign Doctor. Example: RAD001^Dr.^Attending Physician~RAD001^นพ.^แพทย์ผู้ทำการรักษา |
| 10 | HOSPITAL SERVICE | IS | 3 | U | |
| 11 | TEMPORARY LOCATION | PL | 12 | O | Reference Unit. Example: OPD001^ห้องตรวจ 1 |
| 12 | PREADMIT TEST INDICATOR | IS | 2 | U | |
| 13 | READMISSION INDICATOR | IS | 2 | U | |
| 14 | ADMIT SOURCE | IS | 3 | U | |
| 15 | AMBULATORY STATUS | IS | 2 | U | |
| 16 | VIP INDICATOR | IS | 2 | U | |
| 17 | ADMITTING DOCTOR | XCN | 60 | U | |
| 18 | PATIENT TYPE | IS | 2 | U | |
| 19 | VISIT NUMBER | CX | 15 | O |
ORC|NW|20130101CR
| SEQ | NAME | TYPE | LEN | USE | REMARK |
|---|---|---|---|---|---|
| 1 | ORDER CONTROL ID | ID | 2 | R | NW=New order, CA=Cancel order, XO=Change order, SC=Status changed |
| 2 | PLACER ORDER NUMBER | EI | 75 | R | Request No.; Can use same accession number |
OBR||20130101CR001||EXAM001^CHEST PA|||||||||Checkup<br>Yearly 2556|||DOC001^Dr.^Referring Doctor~DOC001^นพ.^แพทย์สง่ ตรวจ||||||||CR|||^^^^^R
| SEQ | NAME | TYPE | LEN | USE | REMARK |
|---|---|---|---|---|---|
| 1 | SET ID – OBSERVATION REQ | SI | 4 | U | |
| 2 | PLACER ORDER NUMBER | EI | 75 | R | Accession Number |
| 3 | FILLER ORDER NUMBER | EI | 75 | U | |
| 4 | UNIVERSAL SERVICE ID | CE | 200 | R | Example: EXAM001^CHEST PA |
| 5 | PRIORITY | ID | 2 | U | |
| 6 | REQUESTED DATE/TIME | TS | 26 | U | |
| 7 | OBSERVATION DATE/TIME | TS | 26 | U | |
| 8 | OBSERVATION END DATE/TIME | TS | 26 | U | |
| 9 | COLLECTION VOLUME | CQ | 20 | U | |
| 10 | COLLECTOR IDENTIFIER | XCN | 60 | U | |
| 11 | SPECIMEN ACTION CODE | ID | 1 | U | |
| 12 | DANGER CODE | CE | 60 | U | |
| 13 | RELEVANT CLINICAL INFO. | ST | 300 | O | Use for new line |
| 14 | SPECIMEN RECEIVED DT/TM | TS | 26 | U | |
| 15 | SPECIMEN SOURCE | CM | 300 | U | |
| 16 | ORDERING PROVIDER | XCN | 80 | O | Referring Doctor; Example: DOC001^Dr.^Referring Doctor~DOC001^นพ.^แพทย์สง่ ตรวจ |
| 17 | ORDER CALLBACK PH. NO. | XTN | 40 | U | |
| 18 | PLACER FIELD 1 | ST | 60 | U | |
| 19 | PLACER FIELD 2 | ST | 60 | U | |
| 20 | FILLER FIELD 1 | ST | 60 | U | |
| 21 | FILLER FIELD 2 | ST | 60 | U | |
| 22 | RESULT RPT/STATUS CHNG DT | TS | 26 | U | |
| 23 | CHARGE TO PRACTICE | CM | 40 | U | |
| 24 | DIAGNOSTIC SERV SECT ID | ID | 10 | O | |
| 25 | RESULT STATUS | ID | 1 | O | |
| 26 | PARENT RESULT | CM | 200 | U | |
| 27 | QUANTITY/TIMING | TQ | 200 | O |
OBX|1|TX|||Text Result<br>Attending Physician M.D.||||||F|||201302271336||RAD001^Dr.^Attending Physician
| SEQ | NAME | TYPE | LEN | USE | REMARK |
|---|---|---|---|---|---|
| 1 | SET ID – OBSERVATIONAL SIMPLE | SI | 10 | O | Fix – 1 |
| 2 | VALUE TYPE | ID | 2 | O | Fix – TX |
| 3 | OBSERVATION IDENTIFIER | CE | 590 | U | |
| 4 | OBSERVATION SUB-ID | ST | 20 | U | |
| 5 | OBSERVATION VALUE | * | * | R | Result Text; Text/Rtf/Html supported |
| 6 | UNITS | CE | 60 | U | |
| 7 | REFERENCE RANGE | ST | 10 | U | |
| 8 | ABNORMAL FLAGS | ID | 5 | U | |
| 9 | PROBABILITY | NM | 5 | U | |
| 10 | NATURE OF ABNORMAL TEST | ID | 2 | U | |
| 11 | OBSERV RESULT STATUS | ID | 1 | R | Fix – F |
| 12 | DATE LAST OBS NORMAL VALUES | TS | 26 | U | |
| 13 | USER DEFINED ACCESS CHECKS | ST | 20 | U | |
| 14 | DATE/TIME OF THE OBSERVATION | TS | 26 | R | Format – YYYYMMDDHHMMSS |
| 15 | PRODUCER’S ID | CE | 60 | U | |
| 16 | RESPONSIBLE OBSERVER | XCN | 80 | R | Radiologist; Example: RAD001^Dr.^Attending Physician |
Example
ACK
MSH|^~\&|||||||ACK|20130101_1|P|2.3
MSA|AA|20130101_1|Message Accept
MSH|^~\&|||||||ACK|20130101_1|P|2.3
MSA|AR|20130101_1|Message Reject
MSH|^~\&|||||||ACK|20130101_1|P|2.3
MSA|AE|20130101_1|Message Error
ADT^A08
MSH|^~\&|||||||ADT^A08|20130101_1|P|2.3
MSH|^~\&|||||||ADT^A08|20130101_1|P|2.3
PID|||1|0000001|Patient^Name^^^Mrs.||19901231|F|อดทน^ชื่อ^^^นาง||ประเทศไทย||||||||1234567890123PV1|||||||||RAD001^Dr.^Attending Physician~RAD001^นพ.^แพทย์ตรวจ||OPD001^ห้องตรวจ 1||||||||12345
ORM^O01
MSH|^~\&|||||||ORM^O01|20130101_1|P|2.3
PID|||1|0000001|Patient^Name^^^Mrs.||19901231|F|อดทน^ชื่อ^^^นาง||ประเทศไทย||||||||1234567
890123
PV1|||||||||RAD001^Dr.^Attending Physician~RAD001^นพ.^แพทย์ตรวจ||OPD001^ห้องตรวจ 1||||||||12345
ORC|NW|20130101CR
OBR||20130101CR001||EXAM001^CHEST PA|||||||||Checkup<br>Yearly 2556|||DOC001^Dr.^Referring Doctor Name~DOC001^นพ.^แพทย์สง่ ตรวจ||||||||CR|||^^^^^R
ORU^R01
MSH|^~\&|||||||ORU^R01|20130101_1|P|2.3
PID|||1|0000001|Patient^Name^^^Mrs.||19901231|F|อดทน^ชื่อ^^^นาง||ประเทศไทย||||||||1234567
890123
PV1|||||||||RAD001^Dr.^Attending Physician~RAD001^นพ.^แพทย์ตรวจ||OPD001^ห้องตรวจ 1||||||||12345
ORC|NW|20130101CR
OBR||20130101CR001||EXAM001^CHEST PA|||||||||Checkup<br>Yearly 2556|||DOC001^Dr.^Referring Doctor Name~DOC001^นพ.^แพทย์สง่ ตรวจ||||||||CR|||^^^^^R
OBX|1|TX|||Text Result<br>Attending Physician M.D.||||||F|||201302271336||RAD001^Dr.^Attending Physician
Was this page helpful?
