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

SIU S14

Contents

  1. 1 SIU S13/S14: Update an existing appointment for a patient
    1. 1.1 Overview
    2. 1.2 Relevant entities
    3. 1.3 Definition
    4. 1.4 Examples
    5. 1.5 Response

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.  An update to a cancelled or DNA appointment will set the appointment status back to active.

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)
S13/S14 [[Appointment]] [[Appointment.External ID]] as derived from SCH-1.1 Partial update. See S12 specification for which fields will be left unmodified if a blank is provided.

If the matched appointment has an [[Appointment.Status]] of ‘CANCELLED’ or ‘DNA’ then status will revert to ‘ACTIVE’.

Note: the list of external participants is purged and replaced.		 New [[Appointment]] created.

Definition

The message structure is the same as an SIU S12.

Examples

MSH|^~\&|app|sender|HL7API|PKB|201303080949||SIU^S13|ABC0000000001|P|2.4
PID|||9999999999^^^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

Response

PKB will respond with a standard HL7 acknowledgement.
Comments