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. To allow the appointment to be created the S15 message will need to include the additional mandatory elements as detailed in the S12 specification.
Relevant entities
Appointment information is used to populate[[Appointment]] entities
Please click through to theData Model to explore the presentation of these entities in the web interface.
Definition
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. | ||||||
SCH | Schedule an activity | ||||||
SCH-1 | R | Placer ID | [[Appointment.External Data Point ID]] | ||||
SCH-1.1 | Placer ID. You must provide a unique ID for this appointment. | APPT000001 |
Examples
MSH|^~\&|app|sender|HL7API|PKB|201303080949||SIU^S15|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|
SCH|ID123
Response
PKB will respond with astandard HL7 acknowledgement.
PKB customer sites:deploy |developer |information governance |procurement |manual
©Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.
This API specification and design is licensed under aCreative Commons Attribution 4.0 International License.