...
Expand | ||
---|---|---|
| ||
[[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
1 | Segment | Field | Opt | RP/# | Component | Description | Example | Data Model | Blank Ignored On Update | 2 |
---|---|---|---|---|---|---|---|---|---|---|
MSH | Message header. This conforms to PKB's standard definition. | 3|||||||||
PID | Patient identification. This conforms to PKB's standard definition. | 4|||||||||
SCH | Schedule an activity | 5|||||||||
SCH-1 | R | Placer ID | 6||||||||
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 | 7||||||
SCH-7 | O | Appointment reason. This is optional; if not provided a default value of "Appointment" will be used. | 8||||||||
SCH-7.2 | Reason (free text). We will set this as the subject. | Check up | [[Appointment.Subject]] | Y | ||||||
9 | SCH-8 | O | Appointment type. See our notes on code sets for more information on our handling of coded data. | 10|||||||
SCH-8.1 | Appointment type code | A1 | [[Appointment.Type.Code]] | Y | 11||||||
SCH-8.3 | Appointment type coding system | MyCoding | [[Appointment.Type.Code System]] | Y | 12||||||
SCH-11 | R | The start date/time is required, but the end date/time is optional. | ||||||||
13 | SCH-11.4 | Appointment start date/time. | 201506130100 | [[Appointment.Start Timestamp]] | Y | 14|||||
SCH-11.5 | Appointment end date/time. | 201506130130 | [[Appointment.End Timestamp]] | Y | ||||||
15 | [ NTE ] | This can be used to include a description of the appointment | 16||||||||
NTE-3 | O | Description of the appointment (free text) | 17||||||||
NTE-3.1 | Description | Your regular check up appointment. | [[Appointment.Description]] | Y | 18||||||
PV1 | This is used to include additional information about the appointment, such as the location | 19|||||||||
PV1-3 | R | 20|||||||||
PV1-3.9 | Appointment location (free text) | Your local surgery | [[Appointment.Location]] | Y | 21||||||
PV1-10 | O | Hospital service. See our notes on code sets for more information on our handling of coded data. | 22||||||||
PV1-10.1 | Hospital service code | [[Appointment.Specialty]] | N/A | 23|||||||
[ RGS | Resource group | |||||||||
24 | { [ AIP ] } | Appointment Information - Personnel | [[Appointment->External Appointment Participant.Name]] | 25|||||||
AIP-3 | R | Y | Personnel. | 26|||||||
AIP-3.2 | Family name | Jones | N/A | 27|||||||
AIP-3.3 | Given name | Stuart | N/A | |||||||
28 | AIP-3.4 | Middle names | James | N/A | 29||||||
AIP-3.6 | Prefix | Dr | N/A | |||||||
30 | AIP-4 | O | Role | 31|||||||
AIP-4.2 | Text | Doctor | N/A |
Examples
...