How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EMIS Health Appointments API

The appointments API from EMIS Health — 17 operation(s) for appointments.

EMIS Health Appointments API is one of 12 APIs that EMIS Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Appointments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 17 operations across 17 paths, and defines 90 schemas. It is described by OpenAPI 3.2.0, at version 1.2.

Requests are made against the base URL https://api.platform.emis-x.uk/partner.

17 operations 17 paths 90 schemas 12 GET5 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2
Base URL
https://api.platform.emis-x.uk/partner
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

EMIS Health Appointments API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It supports OAuth 2.0 (OAuth2CodeEMIS-X-GP-PAPI) using the authorizationCode flow, exposing 7 scopes.

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 12 GET, 5 PATCH. Each is listed below with its method, path, parameters, and response codes.

appointments 17
GET
/api/v1/appointments/BookAppointment
This call books a patient into the specified appointment slot
BookAppointment 6 params → 500400401404415200
GET
/api/v1/appointments/CancelAppointment
This call removes a patient from a specified appointment slot
CancelAppointment 3 params → 500400401404415200
GET
/api/v1/appointments/GetAppointmentConfiguration
This call is used to retrieve a site's appointment configuration settings, including slot types, session holders, staff holidays, and practice holidays. The date filter bounds the staff and practice…
GetAppointmentConfiguration 3 params → 500400401404415200
GET
/api/v1/appointments/GetAppointmentSessions
This call returns a list of appointment sessions within a given timeframe. The maximum window to retrieve sessions is 90 days.
GetAppointmentSessions 4 params → 500400401404415200
GET
/api/v1/appointments/GetArrivedPatients
This call returns a list of patients whose current status is 'arrived'. This status is normally set to indicate that the patient has arrived and is in the waiting area, ready to be called by the clin…
GetArrivedPatients 3 params → 500400401404415200
GET
/api/v1/appointments/GetBookedPatients
This call returns a list of patients with appointments booked in the next x minutes. It also indicates the presence of alerts in the record. Note that these should not be displayed to patients. For e…
GetBookedPatients 3 params → 500400401404415200
GET
/api/v1/appointments/GetBookedPatientsV2
This call returns a list of patients with appointments booked in the next x minutes. It also indicates the presence of alerts in the record. Note that these should not be displayed to patients. For e…
GetBookedPatientsV2 3 params → 500400401404415200
GET
/api/v1/appointments/GetPatientAppointments
This call returns a list of patient appointments within a given timeframe. The maximum window to retrieve sessions is 90 days.
GetPatientAppointments 4 params → 500400401404415200
GET
/api/v1/appointments/GetPatientAppointmentsV2
This call returns a list of patient appointments within a given timeframe. The maximum window to retrieve sessions is 90 days.
GetPatientAppointmentsV2 4 params → 500400401404415200
GET
/api/v1/appointments/GetSentInPatients
This call returns a list of patients whose current status is 'sent in'. This status is normally set by the clinician or receptionist when they are ready to see the patient. This status will remain se…
GetSentInPatients 3 params → 500400401404415200
GET
/api/v1/appointments/GetSlotsForSession
This call retrieves a list of slots in a specified session.
GetSlotsForSession 2 params → 500400401404415200
GET
/api/v1/appointments/GetSlotsForSessionV2
This call retrieves a list of slots in a specified session.
GetSlotsForSessionV2 2 params → 500400401404415200
PATCH
/api/v1/appointments/AddSlotComment
Adds a comment to a slot. Comments can be added to any specified slot.
AddSlotComment 3 params → 500400401404415204
PATCH
/api/v1/appointments/SetAppointmentStatus
For a given appointment slot, this call sets the status in the clinical system to show if the patient has arrived, left or needs sending in.
SetAppointmentStatus 3 params → 500400401404415204
PATCH
/api/v1/appointments/SetAppointmentStatusEx
This call replaces and expands the functionality provided by SetAppointmentStatus to check for the correct patient before modifying the status. This is an extension of SetAppointmentStatus. Note: For…
SetAppointmentStatusEx 4 params → 500400401404415200
PATCH
/api/v1/appointments/SetSlotNotes
Updates the existing slot notes for a specified appointment slot.
SetSlotNotes 3 params → 500400401404415200
PATCH
/api/v1/appointments/SetSlotType
This call sets the slot type and booking note of a given slot.
SetSlotType 4 params → 500400401404415204

Schemas 90

The contract defines 90 schemas that model the data the API accepts and returns. The most detailed are PartnerApi.EmisOpen.BookedPatients37V2.RegistrationType (56 properties), PartnerApi.EmisOpen.BookedPatients37.RegistrationType (56 properties), PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2SessionHolder (50 properties), PartnerApi.EmisOpen.BookedPatients37.BookedPatientsSessionHolder (50 properties). Each schema is shown below with its type and property counts.

PartnerApi.EmisOpen.AppointmentSessions.SiteStruct
object
2 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeCustomRegistrationEntry
object
2 properties
PartnerApi.EmisOpen.BookedPatients37.IdentType
object
5 properties
PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct
object
10 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.BookedPatients37V2.RegistrationType
object
56 properties
PartnerApi.EmisOpen.BookedPatients37.PersonTypeScripts
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeConsulter
integer
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointment
object
10 properties
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAppointment
object
9 properties
PartnerApi.EmisOpen.BookedPatients37.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeDoctor
integer
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsSessionHolder
object
50 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2
object
3 properties
PartnerApi.EmisOpen.SlotsForSession.SlotStruct
object
9 properties
PartnerApi.EmisOpen.BookedPatients37V2.IdentType
object
5 properties
PartnerApi.EmisOpen.GetPatientAppointments.HolderStruct
object
5 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryType
object
9 properties
PartnerApi.EmisOpen.AppointmentConfiguration.HolidayStruct
object
4 properties
PartnerApi.EmisOpen.GetPatientAppointments.AppointmentStruct
object
11 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeScripts
integer
PartnerApi.EmisOpen.SlotsForSessionV2.SlotListStruct
object
1 property
PartnerApi.EmisOpen.BookedPatients37.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.AppointmentConfiguration.HolidaysStruct
object
2 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeLocum
integer
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2SessionHolder
object
50 properties
PartnerApi.EmisOpen.Appointment.PatientInformationType
object
7 properties
PartnerApi.EmisOpen.SlotsForSessionV2.TypeStruct
object
2 properties
PartnerApi.EmisOpen.AppointmentConfiguration.TypeStruct
object
5 properties
PartnerApi.EmisOpen.BookedPatients37.BookedPatients
object
3 properties
PartnerApi.EmisOpen.AppointmentConfiguration.SiteStruct
object
3 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStructSlotType
object
5 properties
PartnerApi.EmisOpen.SlotsForSessionV2.PatientListStruct
object
1 property
PartnerApi.Service.Constants.AppointmentStatus
integer
PartnerApi.EmisOpen.BookedPatients37.ApplicationType
object
7 properties
PartnerApi.EmisOpen.SlotsForSession.PatientStruct
object
6 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointmentSlotType
object
5 properties
PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeCustomRegistrationEntry
object
2 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeDoctor
integer
PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionList
object
1 property
PartnerApi.EmisOpen.BookedPatients37V2.AddressType
object
11 properties
PartnerApi.EmisOpen.GetPatientAppointmentsV2.HolderStruct
object
5 properties
PartnerApi.EmisOpen.BookedPatients37.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionStruct
object
9 properties
PartnerApi.EmisOpen.AppointmentConfiguration.AppointmentConfiguration
object
5 properties
PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeDead
integer
PartnerApi.EmisOpen.SlotsForSession.SlotListStruct
object
1 property
PartnerApi.EmisOpen.BookedPatients37.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBooked
object
4 properties
PartnerApi.EmisOpen.BookedPatients37.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.Appointment.AppointmentInformationType
object
7 properties
PartnerApi.EmisOpen.AppointmentConfiguration.HolderStruct
object
5 properties
PartnerApi.EmisOpen.BookedPatients37.PersonTypeLocum
integer
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAlert
integer
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAlert
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeRegistrar
integer
PartnerApi.Service.Model.Appointment
object
2 properties
PartnerApi.EmisOpen.BookedPatients37V2.RoleType
object
8 properties
PartnerApi.EmisOpen.SlotsForSession.TypeStruct
object
2 properties
PartnerApi.Service.Model.Details
object
2 properties
PartnerApi.Service.Model.SeverityType
integer
PartnerApi.EmisOpen.BookedPatients37.RoleType
object
8 properties
PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStruct
object
12 properties
PartnerApi.EmisOpen.BookedPatients37.PersonCategoryType
object
9 properties
PartnerApi.EmisOpen.BookedPatients37V2.ApplicationType
object
7 properties
PartnerApi.EmisOpen.AppointmentConfiguration.ScheduleStruct
object
4 properties
PartnerApi.Service.Model.Coding
object
3 properties
PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeDead
integer
PartnerApi.EmisOpen.AppointmentSessions.SlotsStruct
object
7 properties
PartnerApi.Service.Model.ErrorResponse
object
4 properties
PartnerApi.EmisOpen.SlotsForSession.PatientListStruct
object
1 property
PartnerApi.EmisOpen.BookedPatients37.AddressType
object
11 properties
PartnerApi.EmisOpen.GetPatientAppointmentsV2.PatientAppointmentListV2
object
1 property
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2Booked
object
4 properties
PartnerApi.EmisOpen.GetPatientAppointments.PatientAppointmentList
object
1 property
PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.Appointment.BookedAppointmentType
object
2 properties
PartnerApi.EmisOpen.AppointmentSessions.HolderStruct
object
5 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeChildSurveillance
integer
PartnerApi.Service.Model.Issue
object
4 properties
PartnerApi.EmisOpen.SlotsForSessionV2.PatientStruct
object
6 properties
PartnerApi.EmisOpen.BookedPatients37.RegistrationType
object
56 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeConsulter
integer
PartnerApi.Service.Model.Text
object
2 properties
PartnerApi.EmisOpen.AppointmentConfiguration.IndividualStruct
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emis-health-appointments-api-openapi.yml Raw ↑

Other APIs EMIS Health publishes across the network.

EMIS-X App Launch
EMIS-X Analytics
EMIS Health CORS API
EMIS Health Health API
EMIS Health Medical Record API
EMIS Health Organisation API
EMIS Health Patient API
EMIS Health Patient Matching API
EMIS Health Search API
EMIS Health Swagger API
EMIS Health User API
Where this information came from

This is an independent, third-party profile of EMIS Health Appointments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.