Manage scheduled appointments


SIU^S12: Create a new appointment for a patient

Overview

Currently, this message can only be used to invite a single patient to a non-recurring appointment.

Relevant Entities

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

Update Behaviour

MessageEntityMatching CriteriaBehaviour (Matched)Behaviour (Not Matched)
S12[[Appointment]][[Appointment.External ID]] as derived from SCH-1.1Replacement. The existing appointment is replaced in its entirety with the values provided in this message. A partial update is not performed.New [[Appointment]] created.

Definition

Segment Field Component Description Example Data Model Blank Ignored On Update
MSH

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

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

Schedule an activity
   

SCH-1
Placer ID
   


SCH-1.1 Placer ID. You must provide a unique ID for this appointment. This will also be required if you wish to subsequently modify or cancel this appointment. APPT000001 [[Appointment.External Data Point ID]] N/A

[ SCH-7 ]
Appointment reason. This is optional; if not provided a default value of "Appointment" will be used.
   


SCH-7.2 Reason (free text). We will set this as the subject. Check up [[Appointment.Subject]] Y

[ SCH-8 ]
Appointment type. See here for more information on code sets.
   


[ SCH-8.1 ] Appointment type code A1 [[Appointment.Type.Code]] Y


[ SCH-8.3 ] Appointment type coding system MyCoding [[Appointment.Type.Code System]] Y

SCH-11


   


SCH-11.4 Appointment start time (HL7 datetime format). 201506130100 [[Appointment.Start Timestamp]] Y


[ SCH-11.5 ] Appointment end time (HL7 datetime format).
If no end timestamp is provided, then the API will behave as if a time of 0000 was provided for the day after the start date. In addition, if a time zone was provided with the start timestamp then that will be used for the default end timestamp too.
201506130130 [[Appointment.End Timestamp]] Y
[ NTE ]

This can be used to include a description of the appointment
   

NTE-3
Description of the appointment (free text)
   


NTE-3.1 Description Your regular check up appointment. [[Appointment.Description]] Y
PV1

This is used to include the location of the appointment
   

PV1-3


   


PV1-3.9 Appointment location (free text) Your local surgery [[Appointment.Location]] Y

[ PV1-10 ]
Hospital service. See here for more information on code sets.
   


PV1-10.1 Hospital service code
[[Appointment.Specialty]] N/A


Examples

SIU^S12 HL7 messages: institute sends information about a new appointment to which the patient will be invited
An institute can invite a patient to a new appointment using an SIU^S12 message.
MSH|^~\&|app|sender|HL7API|PKB|201303080949||SIU^S12|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
SCH|ID123||||||^checkup^||||^^^201411201231^201411201232|||||||||||||||
NTE|||My comment|
PV1|||^^^^^^^^health centre

Response

PKB will respond with a standard HL7 acknowledgement.

SIU^S13/S14: Update an existing appointment for a patient

Overview

The Placer ID (SCH-1.1) is used to identify the appointment.

If the appointment to be updated is not known to PKB, then a new appointment will be created with the provided information.

Relevant Entities

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

Update Behaviour

MessageEntityMatching CriteriaBehaviour (Matched)Behaviour (Not Matched)
S13/S14[[Appointment]][[Appointment.External ID]] as derived from SCH-1.1Partial update. See specification for which fields will be left unmodified if a blank is provided.New [[Appointment]] created.

Definition

The message structure is the same as an S12.

Examples


MSH|^~\&|app|sender|HL7API|PKB|201303080949||SIU^S13|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
SCH|ID123||||||^checkup^||||^^^201411201231^201411201232|||||||||||||||
NTE|||My comment|
PV1|||^^^^^^^^new health centre

SIU^S15: Cancel an appointment for a patient

Overview

The Placer ID (SCH-1.1) is used to identify the appointment.

If the appointment to be cancelled is not known to PKB, then a new appointment will first be created with the provided information, before then being cancelled.

Relevant Entities

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

Update Behaviour

MessageEntityMatching CriteriaBehaviour (Matched)Behaviour (Not Matched)
S15[[Appointment]][[Appointment.External ID]] as derived from SCH-1.1[[Appointment.Status]] set to Cancelled. The other details of the appointment are not updated.New [[Appointment]] created (and immediately cancelled).

Definition

Segment Field 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.
 
SCH

Schedule an activity
 

SCH-1
Placer ID
 


SCH-1.1 Placer ID. You must provide a unique ID for this appointment. APPT000001 [[Appointment.External Data Point ID]]

Examples

MSH|^~\&|app|sender|HL7API|PKB|201303080949||SIU^S13|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
SCH|ID123

SIU^S26: Set DNA for an appointment

Overview


The Placer ID (SCH-1.1) is used to identify the appointment.

Relevant Entities

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

Update Behaviour

MessageEntityMatching CriteriaBehaviour (Matched)Behaviour (Not Matched)
S26[[Appointment]][[Appointment.External ID]] as derived from SCH-1.1[[Appointment.Status]] set to DNA. The other details of the appointment are not updated.New [[Appointment]] created (and immediately set to DNA).

Definition

The message structure is the same as S15; we only need the Placer ID to set the DNA flag.

If the appointment to be flagged as DNA is not known to PKB, then a new appointment will first be created with the provided information, before then being flagged as DNA.

Examples

MSH|^~\&|app|sender|HL7API|PKB|201303080949||SIU^S26|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
SCH|ID123

This message can be used to schedule a new appointment for a patient. This will appear in the "Calendar" tab in the PKB web interface.

S13 and S14 are functionally equivalent in PKB. They can both be used to update the details of an existing appointment.

S15 can be used to cancel an existing appointment.

The message structure to similar to S12, except that we only need the Placer ID to cancel the appointment.

S26 is used to set the Did Not Attend (DNA) flag for this appointment.

Comments