ADT A08

ADT A08: Update an encounter

Overview

Records an update to Encounter information.

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: No action.

[[Encounter Event]]: Admission Event

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

When matched: The timestamp of the existing admission [[Encounter Event]] will be updated to the admit timestamp provided on this update [[Encounter Event]], if one was provided and which differs.

When not matched: No action.

[[Encounter Event]]: Discharge Event

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

When matched: The timestamp of the existing discharge [[Encounter Event]] will be updated to the discharge timestamp provided on this update [[Encounter Event]], if one was provided and which differs.

When not matched: No action.

[[Encounter Event]]: Update Event

Matched on: Update [[Encounter Event]]s are not uniquely identifiable.

When matched: N/A

When not matched: The update event [[Encounter Event]] will be added to the [[Encounter]].

Definition

This is identical in format to the ADT A01, except that timestamp of the update [[Encounter Event]] will be taken from EVN-6, and PV1-44 and PV1-45 will be checked only for updates to the timestamp of admission and/or discharge [[Encounter Event]]s, where they exist. This is shown below:

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model

MSH

 

 

 

 

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

 

 

PID

 

 

 

 

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

 

 

[ EVN ]

 

 

 

 

Event Type

 

 

 

EVN-6

O

 

 

Event Occurred

 

 

 

 

 

 

EVN-6.1

Event Occurred

201508011200

[[Encounter Event.Timestamp]] : Update Event

If not provided, MSH-7 will be used.

PV1

 

 

 

 

Patient visit information.

 

 

 

PV1-2

O

 

 

Patient class

 

 

 

 

 

 

PV1-2.1

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

If a blank or unknown value is provided the class will default to OTHER.

I

[[Encounter Event.Class]]

 

PV1-3

O

 

 

 

 

 

 

 

 

 

PV1-3.9

Free text description of the location.

My Ward

[[Encounter Event->Location.Description]]

 

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.

May be empty but must not be null.

 

 

 

 

 

 

PV1-44.1

Admit timestamp

201508011200

[[Encounter Event.Timestamp]] : Admission Event

If not provided, no update is performed.

 

PV1-45

O

 

 

Discharge datetime. Timestamp of discharge for the entire Encounter.

May be empty but must not be null.

 

 

 

 

 

 

PV1-45.1

 

201508011200

[[Encounter Event.Timestamp]] : Discharge Event

If not provided, no update is performed.

Examples

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A08|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.