Developer documentation‎ > ‎HL7 API‎ > ‎Messages‎ > ‎

SIU S15


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

Message Entity Matching Criteria Behaviour (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

Response

PKB will respond with a standard HL7 acknowledgement.

Comments