Appointment
An appointment record describing both the state of an appointment slot and associated appointment where an appointment is booked in the slot.
Database Field Name | Field Description | Sensitive Field | Identifiable Field | Field Type | Field Length | Optionality |
---|---|---|---|---|---|---|
actual_duration | The actual appointment duration in seconds | Yes | No | Decimal | min an1 max an10 | O |
actual_end_date_time | When the appointment actually ended | Yes | No | Timestamp | min an4 max an23 | O |
actual_start_date_time | When the appointment actually started | Yes | No | Timestamp | min an4 max an23 | O |
appointment_clinician | The lead healthcare professional who delivered the appointment | Yes | No | String | an36 | O |
appointment_id | Unique and persistent identifier for appointment booked in slot - will change for each different appointment booked into slot | Yes | No | String | min an4 max an23 | O |
appointment_type_count | Total count of appointments with that 'type' recorded. Derived field used for disclosure control during reporting | Yes | No | Long | O | |
arrival_time | When the patient arrived for the appointment | Yes | No | Timestamp | min an4 max an23 | O |
bookable | Whether the slot is available for booking to deliver a patient appointment - distinct from embargo/release process i.e. should not be used to indicate slot is embargoed | Yes | No | Boolean | min an4 max an5 | M |
booked_date_time | When the appointment was booked | Yes | No | Timestamp | min an4 max an23 | O |
booking_id | External booking reference for appointment made in slot - will change for each different appointment booked into slot | Yes | No | String | min an1 max an32 | O |
booking_method | How the appointment was booked e.g. telephone, on line service etc. | Yes | No | String | min an1 max an255 | O |
booking_source | The booking source e.g. 111, in practice, community teams etc. | Yes | No | String | min an1 max an32 | O |
booking_source_organisation | The source organisation for the booking if known | Yes | No | String | min an3 max an12 | O |
cancelled_date_time | When the appointment was cancelled | Yes | No | Timestamp | min an4 max an23 | O |
encounter_id | The associated encounter within a GP Data Patient Extract | Yes | No | String | an36 | O |
external_patient | Patient external to practice or service provider | Yes | No | Boolean | min an4 max an5 | O |
hcp_type | The type of Health Care Professional (HCP) associated with the appointment slot i.e. has responsibility for performing the appointment. Coded as per the GPES HCP-TYPE value set | Yes | No | String | min an1 max an3 | O |
id | Unique and persistent identifier for appointment slot | Yes | No | String | an36 | M |
mode | How the appointment was delivered e.g. face to face, telephone, Telemedicine | Yes | No | String | min an1 max an20 | O |
most_recent_flag | Flag for latest status of appointment | Yes | No | Integer | O | |
offered_method | The method by which the appointment was offered for booking i.e. the supplier's own description of the method | Yes | No | String | min an1 max an255 | O |
offered_on_line | Whether the appointment slot was offered for on-line booking | Yes | No | Boolean | min an4 max an5 | O |
patient_external_org | Reference to the organisation record for the organisation where the external patient is registered | Yes | No | String | an36 | O |
patient_external_org_ods_code | Organisation ODS code where the external patient is registered | Yes | No | String | O | |
patient_external_org_type | Organisation type where the external patient is registered | Yes | No | String | O | |
patient_id_deid | NHS number DE-IDENTIFIED | Yes | No | String | an200 | O |
provider | Reference to the organisation record for the provider | Yes | No | String | an36 | M |
provider_ods_code | Provider Organisation Data Service (ODS) code | Yes | No | String | O | |
provider_type | Provider type | Yes | No | String | O | |
recorded_date | The timestamp of when the appointment slot record was created, modified or deleted | Yes | No | Timestamp | min an4 max an23 | M |
release_date_time | When the appointment slot was released for booking | Yes | No | Timestamp | min an4 max an23 | O |
schedule_creation_date_time | When the underlying schedule (session/rota) was created on source system | Yes | No | Timestamp | min an4 max an23 | M |
scheduled_duration | The scheduled duration for the appointment slot in seconds | Yes | No | Decimal | min an4 max an23 | O |
scheduled_end_time | The scheduled end time for the appointment slot | Yes | No | Timestamp | min an4 max an23 | O |
scheduled_start_time | The scheduled start date and time for appointment slot | Yes | No | Timestamp | min an4 max an23 | M |
session_id | The underlying clinic/session/rota this slot was created for (Schedule in FHIR) | Yes | No | String | min an1 max an50 | M |
slot_clinician | The lead healthcare professional (HCP) associated with the scheduled appointment slot | Yes | No | String | an36 | O |
slot_creation_date_time | When the appointment slot was created | Yes | No | Timestamp | min an4 max an23 | M |
slot_deletion_date_time | When the slot was deleted | Yes | No | Timestamp | min an4 max an23 | O |
slot_local_role | Local job role text description for the appointment slot | Yes | No | String | O | |
slot_national_category | The national slot type category code corresponding to the locally defined slot type, mapped to the national category by locally defined metadata | Yes | No | String | min an1 max an150 | O |
slot_national_context | The nationally defined context for the slot | Yes | No | String | min an1 max an100 | O |
slot_national_setting | The nationally defined setting for the slot | Yes | No | String | min an1 max an100 | O |
slot_sds_display | Spine Directory Service (SDS) role text description for the appointment slot | Yes | No | String | O | |
slot_sds_role | Spine Directory Service (SDS) role code for the appointment slot | Yes | No | String | O | |
status | The status of the appointment/appointment slot | Yes | No | String | min an3 max an9 | M |
type | The appointment type as defined on the source system | Yes | No | String | min an1 max an300 | M |