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

SIU S12


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

Message Entity Matching Criteria Behaviour (Matched) Behaviour (Not Matched)
S12 [[Appointment]] [[Appointment.External ID]] as derived from SCH-1.1 Replacement. 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).
 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 additional information about the appointment, such as the location
   

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
[ RGS

Resource group
   
{ [ AIP ] }
]

Appointment Information - Personnel
 [[Appointment->External Appointment Participant.Name]]  

{ AIP-3 }
Personnel. If provided, at least the family name must be given.
   


AIP-3.2 Family name Jones
N/A


[ AIP-3.3 ] Given name Stuart
N/A


[ AIP-3.4 ] Middle names James
N/A


[ AIP-3.6 ] Prefix Dr
N/A

[ AIP-4 ]
Role
   


AIP-4.2 Text Doctor
N/A


Active

[[Appointment.Status]]

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
RGS|
AIP|||^Jones^Stuart^James^^Dr|^Doctor

Response

PKB will respond with a standard HL7 acknowledgement.
Comments