Patient Registration [RAD-1]
AdvaPACS implements the Patient Registration [RAD-1] transaction. The source documentation from IHE can be found here.
Supported Versions
AdvaPACS supports HL7 version 2.3.1 and 2.5.1.
Supported Trigger Events
- ADT^A01
- ADT^A04
- ADT^A05
- ADT^A08
- ADT^A11
- ADT^A38
Expected Actions
A01, A04, A05 - will create a new Patient record if a Patient matching the provided Patient ID(s) can not be located. Ignored if there is an existing record.
A11, A38 - will attempt to delete a Patient record if found. The Patient will only be deleted if there are no resources associated with it.
A08 - will update an existing Patient. If no Patient is found by the provided Patient ID(s) then the message will be ignored.
Message Semantics
Required segments for ADT^* messages.
ADT | Description |
---|---|
MSH | Message Header |
EVN | Event Type |
PID | Patient Identification |
PV1 | Patient Visit |
MSH
SEQ | LEN | DT | OPT | TBL# | ITEM # | ELEMENT NAME | Used by AdvaPACS |
---|---|---|---|---|---|---|---|
1 | 1 | ST | R | 00001 | Field Separator | ✅ | |
2 | 4 | ST | R | 00002 | Encoding Characters | ✅ | |
3 | 180 | HD | R+ | 00003 | Sending Application | ✅ | |
4 | 180 | HD | R+ | 00004 | Sending Facility | ✅ | |
5 | 180 | HD | R+ | 00005 | Receiving Application | ✅ | |
6 | 180 | HD | R+1 | 00006 | Receiving Facility | ✅ | |
7 | 26 | TS | R | 00007 | Date/Time Of Message | ✅ | |
8 | 40 | ST | O | 00008 | Security | ||
9 | 13 | CM | R | 0076/0003 | 00009 | Message Type | ✅ |
10 | 20 | ST | R | 00010 | Message Control ID | ✅ | |
11 | 3 | PT | R | 00011 | Processing ID | ✅ | |
12 | 60 | VID | R | 00012 | Version ID | ||
13 | 15 | NM | O | 00013 | Sequence Number | ||
14 | 180 | ST | O | 00014 | Continuation Pointer | ||
15 | 2 | ID | O | 00015 | Accept Acknowledgment Type | ✅ | |
16 | 2 | ID | O | 00016 | Application Acknowledgment Type | ✅ | |
17 | 3 | ID | O | 00017 | Country Code | ||
18 | 16 | ID | O | 00692 | Character Set | ||
19 | 250 | CE | O | 00693 | Principal Language Of Message | ||
20 | 20 | ID | O | 01317 | Alternate Character Set Handling Scheme |
EVN
SEQ | LEN | DT | OPT | TBL# | ITEM # | ELEMENT NAME | Used by AdvaPACS |
---|---|---|---|---|---|---|---|
1 | 3 | ID | O | 0003 | 00099 | Event Type Code | ✅ |
2 | 26 | TS | R | 00100 | Recorded Date/Time | ✅ | |
3 | 26 | TS | O | 00101 | Date/Time Planned Event | ||
4 | 3 | IS | O | 0062 | 00102 | Event Reason Code | |
5 | 60 | XCN | O | 0188 | 00103 | Operator ID | |
6 | 26 | TS | R2 | 01278 | Event Occurred |
Field EVN-1 Event Type Code is optional; however, if present, its value shall be equal to the second component of the field MSH-9 Message Type.
PID
All the fields are optional, except those listed below.
SEQ | LEN | DT | OPT | TBL# | ITEM # | ELEMENT NAME | Used by AdvaPACS |
---|---|---|---|---|---|---|---|
1 | 4 | SI | O | 00104 | Set ID - Patient ID | ✅ | |
3 | 20 | CX | R | 00106 | Patient Identifier List | ✅ | |
5 | 48 | XPN | R | 00108 | Patient Name | ✅ | |
7 | 26 | TS | R2 | 00110 | Date/Time of Birth | ✅ | |
8 | 1 | IS | R | 0001 | 00111 | Sex | ✅ |
13 | 40 | XTN | O | Phone Number - Home | ✅ | ||
29 | 26 | TS | O | 00740 | Patient Death Date and Time | ✅ | |
30 | 1 | ID | O | 0136 | 00741 | Patient Death Indicator | ✅ |
If the Assigning Authorities feature of AdvaPACS is enabled, Patient IDs must include Assigning Authority. The first subcomponent (namespace ID) of Assigning Authority shall be populated. If the second and third subcomponents (universal ID and universal ID type) are also populated, they shall reference the same entity as is referenced in the first subcomponent.
PV1
All the fields are optional, except those listed below.
SEQ | LEN | DT | OPT | TBL# | ITEM # | ELEMENT NAME | Used by AdvaPACS |
---|---|---|---|---|---|---|---|
1 | 4 | SI | O | 00131 | Set ID - PV1 | ✅ | |
2 | 1 | IS | R | 0004 | 00132 | Patient Class | ✅ |
8 | 60 | XCN | C | 0010 | 00138 | Referring Doctor | ✅ |
19 | 20 | CX | C | 00149 | Visit Number | ✅ |