Page Comparison

MSH

Message header. This conforms to PKB's standard definition.

PID

Patient identification. This conforms to PKB's standard definition.

{ [
AL1

Allergy information. When creating or updating a medical record you can specify allergy information for the patient. The AL1 segment has no fields to indicate source; to include the provider who entered the allergy, use a NTE segment following it.

When updating - the specified information replaces any existing allergy information from the sender.

Duplicate allergies within the AL1 set will result in the entire message being rejected. An allergy is identified as being duplicate if AL1-3 (allergen) and AL1-6 (identification date) match that of another AL1 segment within the message. The duplicate check within AL1-3 (allergen) gives precedence to the uniqueness of either AL1-3.1 (code) or AL1-3.5 (alternate coding). When coding values are not supplied in ALAL1-3 then the check references AL1-3.2 (text) or AL1-3.5 (alternate text) instead. The duplicate check is conducted versus the other AL1 segments in the message.

AL1-3

R

Allergen.

Read V2 codes can be mapped to privacy labels if sent in AL1-3. See the coded data page for more information.

Although each component is optional individually, at least one of AL1-3.1 or AL1-3.2 must be provided.

[[Allergy.Allergen]]

AL1-3.1

Allergen code

A_01

AL1-3.2

Allergen text

Paracetamol

AL1-3.3

Allergen coding system

AL1-3.4

Allergen alternate code

A.1

AL1-3.5

Allergen alternate text

Paracetamol

AL1-3.6

Allergen alternate coding system

INT

AL1-4

O

Allergen severity

[[Allergy.Severity]]

AL1-4.1

Allergen severity code

S_01

AL1-4.2

Allergen severity text

Mild

AL1-4.3

Allergen severity coding system

HOSP

AL1-4.4

Allergen severity alternate code

RS.M

AL1-4.5

Allergen severity alternate text

Mild

AL1-4.6

Allergen severity alternate coding system

AL1-5

O

Y

Allergy reaction

AL1-5.1

Allergy reaction code

Coughing, Sneezing

[[Allergy.Reactions]]

AL1-6

O

Identification date

AL1-6.1

Identification date

201408310408

[[Allergy.Onset Timestamp]]

[ NTE ]
] }

An NTE can be optionally included after an AL1 to specify source information.

NTE-5

O

Source information.
If provided, at least the family name must be given.

[[Allergy->Source.Source Text]]

NTE-5.2

Family name

Foster

NTE-5.3

Given name

John

NTE-5.4

Middle names

Harry

NTE-5.6

Prefix

Dr

{ [ DG1 ] }

Diagnosis information. When creating or updating a medical record you can specify diagnosis information for the patient.

When updating - the specified information replaces any existing diagnosis information from the sender.

Duplicate diagnosis within the DG1 set will result in the entire message being rejected. A diagnosis is identified as being duplicate if DG1-3 (diagnosis) and DG1-5 (diagnosis timestamp) match that of another DG1 segment within the message. The duplicate check within DG1-3 (diagnosis) gives precedence to the uniqueness of either DG1-3.1 (code) or DG1-3.5 (alternate coding). When coding values are not supplied in DG1-3 then the check references DG1-3.2 (text) or DG1-3.5 (alternate text) instead. The duplicate check is conducted versus the other DG1 segments in the message.

DG1-3

R

Diagnosis.

Read V2 codes can be mapped to privacy labels if sent in DG1-3. See the coded data page for more information.

Although each component is optional individually, at least one of DG1-3.1 or DG1-3.2 must be provided.

[[Diagnosis.Diagnosis]]

DG1-3.1

Diagnosis code

D01

DG1-3.2

Diagnosis text

Asthma

DG1-3.3

Diagnosis coding system

HOSP

DG1-3.4

Diagnosis alternate code

D.100

DG1-3.5

Diagnosis alternate text

Asthma

DG1-3.6

Diagnosis alternate coding system

DG1-5

O

Diagnosis timestamp

DG1-5.1

Diagnosis timestamp

201408310408

[[Diagnosis.Start Timestamp]]

DG1-16

O

Diagnosing clinician.
If provided, at least the family name must be given.

[[Diagnosis->Source.Source Text]]

DG1-16.2

Family name

Foster

DG1-16.3

Given name

John

DG1-16.4

Middle names

Harry

DG1-16.6

Prefix

Dr

{ [ ZRX ] }

Medication information. When creating or updating a medical record you can specify the medication information for the patient.

When updating - the specified information replaces any existing medication information from the sender.

Duplicate medications within the ZRX set will result in the entire message being rejected. A medication is identified as being duplicate if ZRX-2 (give code) and ZRX-1.4 (start timestamp) match that of another ZRX segment within the message. The duplicate check within ZRX-2 (give code) gives precedence to the uniqueness of either ZRX-2.1 (code) or ZRX-2.4 (alternate coding). When coding values are not supplied in ZRX-2 then the check references ZRX-2.2 (text) or ZRX-2.5 (alternate text) instead. The duplicate check is conducted versus the other ZRX segments in the message.

This custom segment is based on an RXE v2.4 segment.

ZRX-1

O

Quantity/timing.

ZRX-1.2

Repeat pattern

Once A Day

[[Medication.Frequency Text]]

ZRX-1.4

Start timestamp

201409020909

[[Medication.Start Timestamp]]

ZRX-1.5

End timestamp. If null (or in the future), this is considered a current medication; otherwise, it's medication history.

201409160909

[[Medication.End Timestamp]]

ZRX-2

R

Give code.
The medication text is the only required component.

[[Medication.Substance]]

ZRX-2.1

Medication code

13968911000001194

ZRX-2.2

Medication text

Paracetamol

ZRX-2.3

Medication coding system

Dm+d

ZRX-2.4

Medication alternate code

13968911000001194

ZRX-2.5

Medication alternate text

Paracetamol

ZRX-2.6

Medication alternate coding system

Dm+d

ZRX-3

O

Dose quantity
This must be a numeric value.

ZRX-3.1

Dose quantity

1

[[Medication.Dose Value]]

ZRX-5

O

Give units

[[Medication.Dose Units]]

ZRX-5.1

Unit code

U01

ZRX-5.2

Unit text

Tablet

ZRX-5.3

Unit coding system

HOSP_1

ZRX-5.4

Unit alternate code

U02

ZRX-5.5

Unit alternate text

Tablets

ZRX-5.6

Unit alternate coding system

HOSP_2

ZRX-7

O

Y

Instructions. For multiple lines of instructions -- separate lines with the HL7 repeat character (~), or include HL7-escaped linebreaks directly (using \.br\)

ZRX-7.2

Instruction text

Instructions

[[Medication.Instructions]]

ZRX-13

O

Source information.
If provided, at least the family name must be given.

[[Medication->Source.Source Text]]

ZRX-13.2

Family name

Foster

ZRX-13.3

Given name

John

ZRX-13.4

Middle names

Harry

ZRX-13.6

Prefix

Dr

[ ZTM ]

This is a custom PKB team segment. If you have agreed some source aliases with PKB then you can specify 1 or more of those aliases in this ZTM segment. When creating or updating a medical record this segment will contribute to determining which teams the patient should be linked to.

Note: You cannot use the ZTM segment to exclude the Team which would have otherwise been used.

See our guidance on Team membership for more information.

ZTM-1

O

Y

Alias

ZTM-1.1

Alias

first_alias