--- title: "SIU S12 (Create Appointment)" canonical: "https://wiki.patientsknowbest.com/space/api/3364947182/SIU%20S12%20(Create%20Appointment)" format: markdown --- > Macro (toc) # 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 - Appointment information is used to populate[ ](http://www.google.com/url?q=http%3A%2F%2Fdev.patientsknowbest.com%2Fhome%2Fdata-model%23TOC-Appointment&sa=D&sntz=1&usg=AOvVaw2b4AZDXyHgNVkc4xPV7Kdv)[[[Appointment]]](https://wiki.patientsknowbest.com/space/api/3729195048/Entity%3A+Appointment) entities Please click through to the[ ](http://www.google.com/url?q=http%3A%2F%2Fdev.patientsknowbest.com%2Fhome%2Fdata-model&sa=D&sntz=1&usg=AOvVaw3H4dk1Ql5ZGfvclmnuHM_Y)[Data Model](https://wiki.patientsknowbest.com/space/api/3363700789/Data+Model) to explore the presentation of these entities in the web interface.
Update behaviour **[[Appointment]]** Matched on: [[Appointment.External Data Point ID]] as derived from SCH-1.1 When matched: Replacement. The existing appointment is replaced in its entirety with the values provided in this message. A partial update is not performed. When not matched: New [[Appointment]] created.
## Definition | **Segment** | **Field** | **Opt** | **RP/#** | **Component** | **Description** | **Example** | **Data Model** | **Blank Ignored On Update** | | --- | --- | --- | --- | --- | --- | --- | --- | --- | | **MSH** | | | | | Message header. This conforms to PKB's [standard definition](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012972). | | | | | **PID** | | | | | Patient identification. This conforms to PKB's [standard definition](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364849216). | | | | | **SCH** | | | | | Schedule an activity | | | | | | SCH-1 | **R** | | | 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 | O | | | 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 | O | | | Appointment type. See our [notes on code sets](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012136) for more information on our handling of coded data. This field identifies the specific type of service being performed (e.g., "Physiotherapy" or "Cardiology"). Ideally use [standard codes:](http://terminology.hl7.org/CodeSystem/service-type) | | | | | | | | | 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 | **R** | | | The start date/time is required, but the end date/time is optional. | | | | | | | | | SCH-11.4 | Appointment start date/time. | 201506130100 | [[Appointment.Start Timestamp]] | Y | | | | | | SCH-11.5 | Appointment end date/time. | 201506130130 | [[Appointment.End Timestamp]] | Y | | | SCH-13 | O | | | Single Point Of Contact | | | | | | | | | SCH-13.4 | Email address for appointment booking team | example@gmail.com | | Y | | | | | | SCH-13.7 | Phone number for appointment booking team | 01234 567 891 | | Y | | | | | | SCH-13.8 | Phone extension for appointment booking team | 2 | | Y | | | | | | SCH-13.9 | Free text note for appointment booking team | Lines open 10am till 4pm | | Y | | **[ NTE ]** | | | | | This can be used to populate the description field of an appointment with additional instructions and information | | | | | | NTE-3 | O | | | 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-2 | O | | | Patient class | | | | | | | | | PV1-2.1 | Patient class. Allowed values are defined in [Code Set PKBCS04](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3365012136/Code+sets#PKBCS04).
If a blank or unknown value is provided the class will default to OTHER. | O | [[Encounter Event.Class]] | Y | | | PV1-3 | **R** | | | | | | | | | | | | PV1-3.9 | Appointment location (free text) | Your local surgery | [[Appointment.Location]] | Y | | | PV1-10 | O | | | Hospital service. See our [notes on code sets](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012136) for more information on our handling of coded data. | | | | | | | | | PV1-10.1 | Hospital service code | | [[Appointment.Specialty]] | N/A | | **[ RGS** | | | | | Resource group | | | | | **{ [ AIP ] } ** **]** | | | | | Appointment Information - Personnel | | [[Appointment->External Appointment [Participant.Name](http://Participant.Name)]] | | | | AIP-3 | **R** | Y | | Personnel. If provided, at least the family name must be given. Otherwise this participant will be ignored. | | | | | | | | | 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 | O | | | Role | | | | | | | | | AIP-4.2 | Text | Doctor | | N/A | | **[ ZAP ]** | | | | | Allows an external appointment partner to provide a management URL. See our [documentation on Appointment Partners](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012889) and also [the Manual for more information](https://manual.patientsknowbest.com/patient/appointments#h.j00ln0d5ysr4). | | | | | | ZAP-1 | O | | | This must be a valid URL. Query parameters are permitted. | | | | | | | | | ZAP-1.1 | External management URL | https://appointments-r-us.co.uk/manage/123 | [[Appointment.External Management URL]] | N/A | ## 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|||9999999999^^^NHS^NH{status:01}||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||||||^checkup^||||^^^201411201231^201411201232||^^^^^^0300300300^3^Lines are open 8am-8:30pm > > NTE|||My comment| > > PV1||O|^^^^^^^^health centre > > RGS| > > AIP|||^Jones^Stuart^James^^Dr|^Doctor > > ZAP|https://appointments-r-us.co.uk/manage/123 ## Response PKB will respond with a[ ](http://www.google.com/url?q=http%3A%2F%2Fdev.patientsknowbest.com%2Fhome%2Fhl7-api%2Fmessages%2Fack&sa=D&sntz=1&usg=AOvVaw19jl6l0RTsr4epvg_3z1Se)[standard HL7 acknowledgement](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848470).