HL7 - Patient information (CPR)

HL7 segmenter i henhold til CPR data i Region Syddanmark

Standards

The region support the follovwing HL7 events:

ADT

  • ADT^28 - Add and update person information (=CPR opdateringer)
  • ADT^34 - Change CPR number, for example a replacement of a substitute CPR number to a "real" CPR number. (=Skift af CPR nummer fra et erstatnings-CPR nummer til et "rigtigt" CPR nummer)

QRY/ADR - patient query

  • QRY^A19 - Query person information
  • ADR^A19 - ADT response to the above query

HL7 messages (INBOUND)

QRD - query patient definition segment

The QRD segment contains information to identify the person upon which the query is defined. 

Name                        
Segment
Field
Fixed value
Description
Query Format Code QRD 2
R
Response is in record-oriented format
Query Priority QRD 3
I
Immediate
Query ID QRD 4

Returned with the response
Who Subject Filter QRD
8.1

Cpr number to idetify the person
Who Subject Filter QRD
8.2

 
Who Subject Filter QRD
8.3

 
Who Subject Filter QRD
8.4
0
Subscription (future changes of the information to the cpr number will not be routed automatically to the querying system

Examples:

Example 1:

QRD||R|I|ID1234||||2605620BA2^^^0

Example 2:

MSH|^~\&|SendApp|SendFac|CPR_Component|RSD_Odense|20120201124259||QRY^A19|MsgControlID|P|2.3.1||||||8859/1
QRD||R|I|ID1234||||2605620BA2^^^0

Ud fra SendApp i MSH segmentet findes userid/password til brug ved opslag af cprnummeret 

HL7 messages (OUTBOUND)

MSH - Message Header Segment

Name                        
Segment
Field
Fixed value
Description
Field Separator MSH
1
|
This field contains the separator between the segment ID and the first real field. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. Recommended value is |, (ASCII 124).
Encoding characters
MSH 2 ^~\& This field contains the four characters in the following order: the component separator, repetition separator, escape character, and subcomponent separator. Recommended values are ^~\&
Sending application
MSH
3   This field uniquely identifies the sending application among all other applications within the network enterprise.
Sending Facility MSG
4
  This field contains the address of one of several occurrences of the same application within the sending system
Receiving application
MSH
5
  This field uniquely identifies the receiving application among all other applications within the network enterprise. 
Receiving Facility MSH
6
  This field identifies the receiving application among multiple identical instances of the application running on behalf of different organizations
Date/time of message
MSH
7
  This field contains the date/time that the sending system created the message.
Event
MSH
9
  This field contains the message type and trigger event for the message
Message Control ID MSH
10
  This field contains a number or other identifier that uniquely identifies the message. The receiving system echoes this ID back to the sending system in the Message acknowledgment segment (MSA).
Processing ID MSH
11
  This field is used to decide whether the message is part of a production (P), training (T), or debugging system (D)
Version ID MSH
12
2.3.1
This field is matched by the receiving system to its own version to be sure the message will be interpreted correctly.
Character Set MSH
18
  This field contains the character set for the entire message

Examples

MSH|^~\&|CPR_Component|RSD_Odense|RIS_Carestream|SLB_Carestream|20110317153517||ADT^A28|0000068597|P|2.3.1||||||8859/1

EVN - event type segment

The EVN segment is used to communicate necessary trigger event information to receiving applications

Name                        
Segment
Field
Fixed value
Description
Event Type Code EVN
1


Recorded Date/time EVN
2
  Message creation time. Most systems will default to the system date/time when the transaction was entered

Examples:

EVN|A28|201103171534550

PID - Patient Identifikation Segment

Name                        
Segment
Field
Fixed value
Description
Patient ID (Internal ID) PID
3

This field contains the primary identifier (=CPR number)
Patient Name
  • Familiy Name
  • Given Name
  • Middle initial or name
PID
5

5.1
5.2
5.3
 
Date/Time of Birth PID
7
  This field contains the patient’s date and time of birth.
Sex
PID
8
  This field contains the patient’s sex.
F = Female
M = Male
Patient Address
  • Street adress
  • City
  • State or province
  • Postal code
  • MunicipalityCode (Kommunekode)
PID
11

11.1
11.3
11.4
11.5
11.8
   
Marital Status PID
16
  S=Single
M=Married
D=Divorced
L=Separated
W=Widowed
Patient Death Data and Time
PID
29
  This field contains the date and time at which the patient death occurred.
Patient Death Indicator
PID
30
  This field indicates whether or not the patient is deceased.

Examples

PID|||2605620BA2||Testesen^Testwoman||19620526|F|||J.B. Winsløws Vej 12A^Odense C5000^^461|||||S|||||||||||||20110131|Y

PD1 - patient additional demographic segment

The patient additional demographic segment contains demographic information that is likely to change about the patient.

Name                        
Segment
Field
Fixed value
Description
Patient primary care provider name & ID no
  • ID number (=ydernummer)
  • family name
PD1
4

4.1
4.2
  This field contains the patients private doctor  (name and ID). Ydernummer og navn på privatpraktiserende læge.

Examples

Example 1:

PD1||||041149^Karsten Givskud

Example 2:

MSH|^~\&|CPR_Component|RSD_Odense|RIS_Carestream|SLB_Carestream|20110317153517||ADT^A28|0000068597|P|2.3.1||||||8859/1
EVN|A28|201103171534550
PID|||2605620BA2||Testesen^Testwoman||19620526|F|||J.B. Winsløws Vej 12A^Odense C5000^^461|||||S|||||||||||||20110131|Y
PD1||||041149^Karsten Givskud

MRG - merge patient information segment

The MRG segment provides receiving applications with information necessary to initiate the merging of patient data as well as groups of records. This segment is used to change substitution CPR number to real CPR number. 

Name                        
Segment
Field
Fixed value
Description
Prior Patient ID - Internal MRG 1
  This field contains the internal prior patient identifier

Examples:

Example 1:

MRG|2605620BA4

Example 2:

MSH|^~\&|CPR_Component|RSD_Odense|RIS_Carestream|SLB_Carestream|20110329124259||ADT^A34|0000000995|P|2.3.1||||||8859/1
EVN|A34|201103291242305
PID|||2605620EA8
MRG|2605620AE8

QRD - query patient definition segment

The QRD segment contains information to identify the query. 

Name                        
Segment
Field
Fixed value
Description
Query ID QRD 4

QueryId from the request

Examples:

Example 1:

QRD||||ID1234

Example 2:

MSH|^~\&|CPR_Component|RSD_Odense|RecvApp|RecvFac|20120201113548||ADR^A19|20120201113548|P|2.3.1||||||8859/1
MSA|AA
QRD||||ID1234
PID|||2605620BA2||Testesen^Testwoman||19620526|F|||J.B. Winsløws Vej 12A^Odense C5000^^461|||||S|||||||||||||20110131|Y
PD1||||041149
PV1

MSA - Message Acknowlegment segment

Name                        
Segment
Field
Fixed value
Description
Acknowlegment Code MSA 1


Message Control ID MSA 2


Message Text MSA 3


Error condition MSA 6


Examples:

Example 1:

MSA|AE||CPR-nr not found.|||2
Example 2:

MSH|^~\&|CPR_Component|RSD_Odense|RecvApp|RecvFac|20120201113548||ADR^A19|20120201113548|P|2.3.1||||||8859/1
MSA|AE|MsgControlID|CPR-nr not found.|||2
QRD||||ID1234

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.