Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

RO

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]]

[[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]]

...