ADT A05

ADT A05: Pre-Admit a patient

Overview

Records an expected future admission of a patient. Additionally, an appointment will be created in the patient's calendar.

Relevant entities

Please click through to the Data Model to explore the presentation of these entities in the web interface.

[[Encounter]]

Matched on: [[Encounter.External Encounter ID]] as derived from PV1-19.1

When matched: The [[Encounter Event]] will be handled as indicated below.

When not matched: A new [[Encounter]] will be created with this message.

[[Encounter Event]]

Matched on: An Encounter can contain zero or one pre-admit [[Encounter Event]]s. If the [[Encounter]] has been matched, then there will be at most one pre-admit [[Encounter Event]], so no other IDs are required for matching.

When matched: The pre-admit [[Encounter Event]] is replaced with the information in this message.

When not matched: The pre-admit [[Encounter Event]] will be added to the [[Encounter]].

[[Appointment]]

Matched on: PKB maintains an internal link joining the [[Encounter]] to the [[Appointment]]. No additional external IDs required.

When matched: The [[Appointment]] information is replaced with the information in this message.

When not matched: A new [[Appointment]] is created and associated with this [[Encounter]].

Definition

This is identical in format to the ADT A01, except that an [[Appointment]] entity will also be populated. In addition, since this message is typically used for future events, PV2-8 and EVN-3 will also be considered when determining both the event timestamp and the appointment start time. This is shown below.

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model
(Encounters)

Data Model
(Appointments)

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model
(Encounters)

Data Model
(Appointments)

MSH

 

 

 

 

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

 

 

 

PID

 

 

 

 

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

 

 

 

[ EVN ]

 

 

 

 

 

 

 

 

 

EVN-3

O

 

 

Timestamp of planned event

 

 

 

 

 

 

 

EVN-3.1

Timestamp

201508011200

[[Encounter Event.Timestamp]]
if PV2-8 was not provided.

[[Appointment.Start Timestamp]]
if PV2-8 was not provided.

PV1

 

 

 

 

Patient visit information.

 

 

 

 

PV1-2

R

 

 

Patient class

 

 

 

 

 

 

 

PV1-2.1

Patient class. Allowed values are defined in Code Set PKBCS04.

I

[[Encounter Event.Class]]

[[Appointment.Subject]]

 

PV1-3

O

 

 

 

 

 

 

 

 

 

 

PV1-3.9

Free text description of the location.

My Ward

[[Encounter Event->Location.Description]]

[[Appointment.Location]]

 

PV1-7

O

 

 

Attending doctor.
If provided, at least the family name must be given.

 

[[Encounter Event->External Participant.Name]]

[[Encounter Event->External Participant.Role]] will be set to ATTENDER.

 

 

 

 

 

PV1-7.2

Family name

Jones

 

 

 

 

 

 

PV1-7.3

Given name

Stuart

 

 

 

 

 

 

PV1-7.4

Middle names

James

 

 

 

 

 

 

PV1-7.6

Prefix

Dr

 

 

 

PV1-8

O

 

 

Referring doctor.
If provided, at least the family name must be given.

 

[[Encounter Event->External Participant.Name]]

[[Encounter Event->External Participant.Role]] will be set to REFERRER.

 

 

 

 

 

PV1-8.2

Family name

Smith

 

 

 

 

 

 

PV1-8.3

Given name

William

 

 

 

 

 

 

PV1-8.4

Middle names

 

 

 

 

 

 

 

PV1-8.6

Prefix

Dr

 

 

 

PV1-9

O

 

 

Consulting doctor.
If provided, at least the family name must be given.

 

[[Encounter Event->External Participant.Name]]

[[Encounter Event->External Participant.Role]] will be set to CONSULTANT.

 

 

 

 

 

PV1-9.2

Family name

Foster

 

 

 

 

 

 

PV1-9.3

Given name

Terry

 

 

 

 

 

 

PV1-9.4

Middle names

 

 

 

 

 

 

 

PV1-9.6

Prefix

Mr

 

 

 

PV1-10

O

 

 

Hospital service. See our information on code sets for more details.

 

[[Encounter Event.Specialty]]

 

 

 

 

 

PV1-10.1

Hospital service code

 

 

 

 

PV1-19

R

 

 

Visit ID. This is used by PKB to uniquely identify an Encounter.

 

[[Encounter.External Encounter ID]]

 

 

 

 

 

PV1-19.1

Visit ID

V00001

 

 

 

PV1-44

O

 

 

Admit datetime. Timestamp of admission for the entire Encounter.

 

 

 

 

 

 

 

PV1-44.1

Admit timestamp

201508011200

[[Encounter Event.Timestamp]]
if neither PV2-8 nor EVN-3 were provided.

If PV1-44 also not provided, MSH-7 will be used.

[[Appointment.Start Timestamp]]
if neither PV2-8 nor EVN-3 were provided.

If PV1-44 also not provided, MSH-7 will be used.

 

PV1-45

 

 

 

Discharge datetime. Timestamp of discharge for the entire Encounter.

 

Ignored by an A05

 

[ PV2 ]

 

 

 

 

 

 

 

 

 

PV2-8

O

 

 

Expected admit date/time

 

 

 

 

 

 

 

PV2-8.1

Timestamp

201508011200

[[Encounter Event.Timestamp]]

[[Appointment.Start Timestamp]]

[ ZSC ]

 

 

 

 

The purpose of this custom segment is to allow you to specify attributes of the auto-generated [[Appointment]] which would otherwise be set from the SCH segment for SIU messages.

 

 

 

 

ZSC-8

O

 

 

Appointment type. See our notes on code sets for more information on our handling of coded data.

 

 

 

 

 

 

 

ZSC-8.1

Appointment type code

T01

 

[[Appointment.Type.Code]]

 

 

 

 

ZSC-8.3

Appointment type coding system

INT

 

[[Appointment.Type.Coding System]]

The appointment will not have an end time recorded.

[[Appointment.End Timestamp]]

Examples

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A05|ABC0000000001|P|2.4

PID|||9999999999^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||Flat name^1, The Road^London^London^SW1A 1AA^GBR||01234567890^PRN~07123456789^PRS|^NET^^john.smith@company.com~01234098765^WPN||||||||||||||||N|

PV1|1|I|^^^^^^^^My Ward||||^Jones^Stuart^James^^Dr^|^Smith^William^^^Dr^|^Foster^Terry^^^Mr^||||||||||V00001|||||||||||||||||||||||||201508011000|201508011200

Response

PKB will respond with a standard HL7 acknowledgement.