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

SIU S26


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

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

Response

PKB will respond with a standard HL7 acknowledgement.

Comments