Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EMIS Partner API (PAPI)

The EMIS Partner API (PAPI) is a RESTful JSON API for EMIS-X / EMIS Web integration, exposing appointments, the clinical/medical record, patient demographics, patient matching, organisation lookup, and clinical searches. Documented as OpenAPI 3.0.4 (Partner API v1.2) with 40 operations across the appointments, medicalRecord, patient, patientMatching, organisation, search, and user domains. Access is OAuth2 authorization-code with scoped bearer (JWT) tokens.

EMIS Partner API (PAPI) is one of 3 APIs that EMIS Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 80 operations across 40 paths, organized into 10 resource areas, and defines 284 schemas. It is described by OpenAPI 3.0.4, at version 1.2.

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

80 operations 40 paths 284 schemas 32 GET40 OPTIONS7 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

EMIS Partner API (PAPI) 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 80

Across 40 paths, the API surfaces 80 operations — 32 GET, 40 OPTIONS, 7 PATCH, 1 POST. They span 10 resource areas: appointments, CORS, medicalRecord, patientMatching, health, organisation, patient, search, user, swagger. 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
CORS 40
OPTIONS
/api/v1/appointments/BookAppointment
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/CancelAppointment
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetAppointmentConfiguration
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetAppointmentSessions
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetArrivedPatients
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetAttachments
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetAttachmentsV2
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetBase64AttachmentData
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetBase64AttachmentDataV2
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetBookedPatients
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetBookedPatientsV2
CORS pre-flight request
→ 204
OPTIONS
/api/v1/patientMatching/GetChangedPatients
CORS pre-flight request
→ 204
OPTIONS
/api/v1/patientMatching/GetChangedPatientsMR
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetCodedRecord
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetConsultation
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetEvents
CORS pre-flight request
→ 204
OPTIONS
/
CORS pre-flight request
→ 204
OPTIONS
/api/v1/patientMatching/GetMatchedPatients
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetMedicalRecord
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/GetMedicationIssues
CORS pre-flight request
→ 204
OPTIONS
/api/v1/organisation/GetOrganisation
CORS pre-flight request
→ 204
OPTIONS
/api/v1/organisation/GetOrganisationV2
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetPatientAppointments
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetPatientAppointmentsV2
CORS pre-flight request
→ 204
OPTIONS
/api/v1/patient/GetPatientDemographics
CORS pre-flight request
→ 204
OPTIONS
/api/v1/search/GetPatientSearches
CORS pre-flight request
→ 204
OPTIONS
/api/v1/patientMatching/GetPatientSequence
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetSentInPatients
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetSlotsForSession
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/GetSlotsForSessionV2
CORS pre-flight request
→ 204
OPTIONS
/api/v1/user/GetUserById
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/AddSlotComment
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/SetAppointmentStatus
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/SetAppointmentStatusEx
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/SetSlotNotes
CORS pre-flight request
→ 204
OPTIONS
/api/v1/appointments/SetSlotType
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/UpdateAttachment
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/UpdateConsultationVisibility
CORS pre-flight request
→ 204
OPTIONS
/api/v1/medicalRecord/FileRecord
CORS pre-flight request
→ 204
OPTIONS
/swagger/*
CORS pre-flight request
→ 204
medicalRecord 12
GET
/api/v1/medicalRecord/GetAttachments
This call returns an EMIS Open medical record message containing a list of attachments to that patient’s record. To retrieve the attachment data, call GetAttachments, parse the list of attachments fo…
GetAttachments 2 params → 500400401404415200
GET
/api/v1/medicalRecord/GetAttachmentsV2
This call returns an EMIS Open medical record message containing a list of attachments to that patient’s record. To retrieve the attachment data, call GetAttachments, parse the list of attachments fo…
GetAttachmentsV2 2 params → 500400401404415200
GET
/api/v1/medicalRecord/GetBase64AttachmentData
This function accepts a DDSIdentifier argument which uniquely identifies a specific attachment, even where attachments with duplicated names occur in the database. It returns the complete attached fi…
GetBase64AttachmentData 3 params → 500400401404415200
GET
/api/v1/medicalRecord/GetBase64AttachmentDataV2
V2: This function accepts a DDSIdentifier argument which uniquely identifies a specific attachment, even where attachments with duplicated names occur in the database. It returns the complete attache…
GetBase64AttachmentDataV2 3 params → 500400401404415200
GET
/api/v1/medicalRecord/GetCodedRecord
This call returns a subset of the medical record which comprises only of the clinically coded items. It does not return Medication or registration information.
GetCodedRecord 2 params → 500400401404415200
GET
/api/v1/medicalRecord/GetConsultation
This call returns a specific consultation record and any associated information. For instance, the location and users relating to the consultation content.
GetConsultation 3 params → 500400401404415200
GET
/api/v1/medicalRecord/GetEvents
This call returns a subset of the medical record which comprises only the coded clinical events for the patient. Information is returned for the specified time period counting back from the current d…
GetEvents 3 params → 500400401404415200
GET
/api/v1/medicalRecord/GetMedicalRecord
This call returns a medical record for a specific patient number. Before using this call please consider what information you require from the patient record and see if any of the other available cal…
GetMedicalRecord 2 params → 500400401404415200
GET
/api/v1/medicalRecord/GetMedicationIssues
This call returns a list of issued medication. This call will execute significantly faster than getMedicalRecord, particularly for patients with large medical records.
GetMedicationIssues 3 params → 500400401404415200
PATCH
/api/v1/medicalRecord/UpdateAttachment
This function updates the pfs visible and provisional status of a specified attachment
UpdateAttachment 5 params → 500400401404415204
PATCH
/api/v1/medicalRecord/UpdateConsultationVisibility
Updates the PFS Visibility value for a consultation previously filed into EMIS Web and all associated content (clinical code, associated text and attachments), including any linked observations.
UpdateConsultationVisibility 4 params → 500400401404415200
POST
/api/v1/medicalRecord/FileRecord
This call files a new consultation from an XML message, into a patient's medical record. Patient ID This is the DBID number of the patient. Attachments are referenced by the Attachment/Address elemen…
FileRecord 2 params body → 500400401404415204
patientMatching 4
GET
/api/v1/patientMatching/GetChangedPatients
When called this method returns a list of patients whose registration details have changed since the date specified. If no patient meets these criteria the method returns an empty list.
GetChangedPatients 2 params → 500400401404415200
GET
/api/v1/patientMatching/GetChangedPatientsMR
When called this method returns a list of patients whose medical record has changed (as defined by looking at the audit trail) since the date specified. If no patients meet this criterion the method…
GetChangedPatientsMR 2 params → 500400401404415200
GET
/api/v1/patientMatching/GetMatchedPatients
This call is used to find patients that match a specific search criterion. Only one field can be used at a time, such as last name, first name, date of birth, NHS number, etc. Example: "DOB firstName…
GetMatchedPatients 2 params → 500400401404415200
GET
/api/v1/patientMatching/GetPatientSequence
This API retrieves the next batch of patients from the Age-Sex Register, based on the specified batch size and starting patient ID (StartID). Note: This endpoint is provided for legacy use only and i…
GetPatientSequence 3 params → 500400401404415200
health 1
GET
/
GetHealth → 200
organisation 2
GET
/api/v1/organisation/GetOrganisation
This call returns details about the practice administration including users, locations and location types.
GetOrganisation 1 param → 500400401404415200
GET
/api/v1/organisation/GetOrganisationV2
This call returns details about the practice administration including users, locations and location types.
GetOrganisationV2 1 param → 500400401404415200
patient 1
GET
/api/v1/patient/GetPatientDemographics
This call returns a demographic subset of the medical record for a specific patient number.
GetPatientDemographics 2 params → 500400401404415200
search 1
GET
/api/v1/search/GetPatientSearches
This call accepts the ID of a QOF (Quality Outcomes Framework) report and a report type. It returns a list of patients from the most recently run result set for that search. HAID (How Am I Driving) r…
GetPatientSearches 4 params → 500400401404415200
user 1
GET
/api/v1/user/GetUserById
For speed and brevity, the extended appointments API does not return full user details for session holders, just name and system IDs. If the developer requires more information, they can retrieve det…
GetUserById 2 params → 500400401404415200
swagger 1
GET
/swagger/*
Swagger UI endpoint
swagger → 200

Schemas 284

The contract defines 284 schemas that model the data the API accepts and returns. The most detailed are PartnerApi.EmisOpen.MedicalRecord38.RegistrationType (60 properties), PartnerApi.EmisOpen.PatientMatches37.PatientMatchesPatient (57 properties), PartnerApi.EmisOpen.BookedPatients37V2.RegistrationType (56 properties), PartnerApi.EmisOpen.BookedPatients37.RegistrationType (56 properties). Each schema is shown below with its type and property counts.

PartnerApi.EmisOpen.Appointment.AppointmentInformationType
object
7 properties
PartnerApi.EmisOpen.Appointment.BookedAppointmentType
object
2 properties
PartnerApi.EmisOpen.Appointment.PatientInformationType
object
7 properties
PartnerApi.EmisOpen.AppointmentConfiguration.AppointmentConfiguration
object
5 properties
PartnerApi.EmisOpen.AppointmentConfiguration.HolderStruct
object
5 properties
PartnerApi.EmisOpen.AppointmentConfiguration.HolidayStruct
object
4 properties
PartnerApi.EmisOpen.AppointmentConfiguration.HolidaysStruct
object
2 properties
PartnerApi.EmisOpen.AppointmentConfiguration.IndividualStruct
object
6 properties
PartnerApi.EmisOpen.AppointmentConfiguration.ScheduleStruct
object
4 properties
PartnerApi.EmisOpen.AppointmentConfiguration.SiteStruct
object
3 properties
PartnerApi.EmisOpen.AppointmentConfiguration.TypeStruct
object
5 properties
PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionList
object
1 property
PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionStruct
object
9 properties
PartnerApi.EmisOpen.AppointmentSessions.HolderStruct
object
5 properties
PartnerApi.EmisOpen.AppointmentSessions.SiteStruct
object
2 properties
PartnerApi.EmisOpen.AppointmentSessions.SlotsStruct
object
7 properties
PartnerApi.EmisOpen.Base64AttachmentData.root
object
2 properties
PartnerApi.EmisOpen.Base64AttachmentDataV2.root
object
4 properties
PartnerApi.EmisOpen.BookedPatients37.AddressType
object
11 properties
PartnerApi.EmisOpen.BookedPatients37.ApplicationType
object
7 properties
PartnerApi.EmisOpen.BookedPatients37.BookedPatients
object
3 properties
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBooked
object
4 properties
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAlert
integer
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAppointment
object
9 properties
PartnerApi.EmisOpen.BookedPatients37.BookedPatientsSessionHolder
object
50 properties
PartnerApi.EmisOpen.BookedPatients37.IdentType
object
5 properties
PartnerApi.EmisOpen.BookedPatients37.PersonCategoryType
object
9 properties
PartnerApi.EmisOpen.BookedPatients37.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeConsulter
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeDoctor
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeLocum
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeScripts
integer
PartnerApi.EmisOpen.BookedPatients37.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.BookedPatients37.RegistrationType
object
56 properties
PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeCustomRegistrationEntry
object
2 properties
PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeDead
integer
PartnerApi.EmisOpen.BookedPatients37.RoleType
object
8 properties
PartnerApi.EmisOpen.BookedPatients37V2.AddressType
object
11 properties
PartnerApi.EmisOpen.BookedPatients37V2.ApplicationType
object
7 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2
object
3 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2Booked
object
4 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAlert
integer
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointment
object
10 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointmentSlotType
object
5 properties
PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2SessionHolder
object
50 properties
PartnerApi.EmisOpen.BookedPatients37V2.IdentType
object
5 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryType
object
9 properties
PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeConsulter
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeDoctor
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeLocum
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeScripts
integer
PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.BookedPatients37V2.RegistrationType
object
56 properties
PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeCustomRegistrationEntry
object
2 properties
PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeDead
integer
PartnerApi.EmisOpen.BookedPatients37V2.RoleType
object
8 properties
PartnerApi.EmisOpen.GetPatientAppointments.AppointmentStruct
object
11 properties
PartnerApi.EmisOpen.GetPatientAppointments.HolderStruct
object
5 properties
PartnerApi.EmisOpen.GetPatientAppointments.PatientAppointmentList
object
1 property
PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStruct
object
12 properties
PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStructSlotType
object
5 properties
PartnerApi.EmisOpen.GetPatientAppointmentsV2.HolderStruct
object
5 properties
PartnerApi.EmisOpen.GetPatientAppointmentsV2.PatientAppointmentListV2
object
1 property
PartnerApi.EmisOpen.MedicalRecord35.AddressType
object
10 properties
PartnerApi.EmisOpen.MedicalRecord35.ApplicationType
object
6 properties
PartnerApi.EmisOpen.MedicalRecord35.IdentType
object
4 properties
PartnerApi.EmisOpen.MedicalRecord35.PersonCategoryType
object
8 properties
PartnerApi.EmisOpen.MedicalRecord35.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonType
object
49 properties
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeConsulter
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeDoctor
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeLocum
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeScripts
integer
PartnerApi.EmisOpen.MedicalRecord35.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.MedicalRecord35.RoleType
object
7 properties
PartnerApi.EmisOpen.MedicalRecord35.UserDetails
object
1 property
PartnerApi.EmisOpen.MedicalRecord38.AddressType
object
11 properties
PartnerApi.EmisOpen.MedicalRecord38.AlertType
object
25 properties
PartnerApi.EmisOpen.MedicalRecord38.AllergyType
object
29 properties
PartnerApi.EmisOpen.MedicalRecord38.ApplicationType
object
7 properties
PartnerApi.EmisOpen.MedicalRecord38.AppointmentType
object
15 properties
PartnerApi.EmisOpen.MedicalRecord38.AppointmentTypeSite
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.AttachmentType
object
32 properties
PartnerApi.EmisOpen.MedicalRecord38.AuthorType
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.CareAimType
object
6 properties
PartnerApi.EmisOpen.MedicalRecord38.CarePlanType
object
7 properties
PartnerApi.EmisOpen.MedicalRecord38.ConsultationType
object
24 properties
PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType
object
12 properties
PartnerApi.EmisOpen.MedicalRecord38.DiaryType
object
30 properties
PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType
object
8 properties
PartnerApi.EmisOpen.MedicalRecord38.EDIComment
object
1 property
PartnerApi.EmisOpen.MedicalRecord38.EDIOrderType
object
13 properties
PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeFormDestination
object
6 properties
PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeOrderCategory
integer
PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeStatus
integer
PartnerApi.EmisOpen.MedicalRecord38.ElementListTypeConsultationElement
object
11 properties
PartnerApi.EmisOpen.MedicalRecord38.EventType
object
37 properties
PartnerApi.EmisOpen.MedicalRecord38.EventTypeEventType
integer
PartnerApi.EmisOpen.MedicalRecord38.IdentType
object
5 properties
PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType
object
7 properties
PartnerApi.EmisOpen.MedicalRecord38.InvestigationType
object
26 properties
PartnerApi.EmisOpen.MedicalRecord38.IssueType
object
54 properties
PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType
integer
PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType1
integer
PartnerApi.EmisOpen.MedicalRecord38.LinkType
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.LinkTypeLinkType
integer
PartnerApi.EmisOpen.MedicalRecord38.LocationType
object
21 properties
PartnerApi.EmisOpen.MedicalRecord38.LocationTypeGPLinkCode
object
6 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType
object
26 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformation
object
4 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagePurpose
object
1 property
PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagingError
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMiscellaneousData
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeRegistrationEntry
object
4 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicationLinkType
object
3 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicationType
object
45 properties
PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeDrug
object
1 property
PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod
integer
PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType
integer
PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus
integer
PartnerApi.EmisOpen.MedicalRecord38.NoteType
object
16 properties
PartnerApi.EmisOpen.MedicalRecord38.NumericValueType
object
10 properties
PartnerApi.EmisOpen.MedicalRecord38.OriginatorType
object
3 properties
PartnerApi.EmisOpen.MedicalRecord38.OriginatorTypeSystem
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyInvestigationType
object
24 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportType
object
26 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiers
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersMatchedDetails
object
6 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersOriginalDetails
object
7 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetails
object
6 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetailsMessageType
integer
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalRequestor
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeServiceProvider
object
3 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologySpecimenType
object
20 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyTestType
object
18 properties
PartnerApi.EmisOpen.MedicalRecord38.PathologyTestTypeRangeInformation
object
4 properties
PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryType
object
9 properties
PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonType
object
49 properties
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeConsulter
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeDoctor
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeLocum
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeScripts
integer
PartnerApi.EmisOpen.MedicalRecord38.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.MedicalRecord38.PolicyListTypePolicyType
object
6 properties
PartnerApi.EmisOpen.MedicalRecord38.ProblemType
object
17 properties
PartnerApi.EmisOpen.MedicalRecord38.QualifierType
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.ReferralType
object
55 properties
PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeCommunity
integer
PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeNHS
integer
PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeRequestType
integer
PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeTransport
integer
PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeUrgency
integer
PartnerApi.EmisOpen.MedicalRecord38.RegistrationHistoryType
object
3 properties
PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusType
object
3 properties
PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusTypeCurrentStatus
object
10 properties
PartnerApi.EmisOpen.MedicalRecord38.RegistrationType
object
60 properties
PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeCustomRegistrationEntry
object
2 properties
PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeDead
integer
PartnerApi.EmisOpen.MedicalRecord38.RoleType
object
8 properties
PartnerApi.EmisOpen.MedicalRecord38.StatusType
object
8 properties
PartnerApi.EmisOpen.MedicalRecord38.StringCodeType
object
7 properties
PartnerApi.EmisOpen.MedicalRecord38.StringCodeTypeScheme
integer
PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType
object
7 properties
PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderType
object
25 properties
PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeFasted
integer
PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeInnoculationRisk
integer
PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeNHS
integer
PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypePregnant
integer
PartnerApi.EmisOpen.MedicalRecord38.TestRequestType
object
34 properties
PartnerApi.EmisOpen.MedicalRecord38.TestRequestTypeStatus
integer
PartnerApi.EmisOpen.MedicalRecord38.TypeOfLocationType
object
6 properties
PartnerApi.EmisOpen.OrganisationInformation37.AddressType
object
10 properties
PartnerApi.EmisOpen.OrganisationInformation37.ApplicationType
object
6 properties
PartnerApi.EmisOpen.OrganisationInformation37.IdentType
object
4 properties
PartnerApi.EmisOpen.OrganisationInformation37.LocationType
object
20 properties
PartnerApi.EmisOpen.OrganisationInformation37.LocationTypeGPLinkCode
object
5 properties
PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation
object
5 properties
PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryType
object
8 properties
PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonType
object
49 properties
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeConsulter
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeDoctor
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeLocum
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeScripts
integer
PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.OrganisationInformation37.RoleType
object
7 properties
PartnerApi.EmisOpen.OrganisationInformation37.TypeOfLocationType
object
5 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType
object
10 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.ApplicationType
object
6 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType
object
4 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType
object
20 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.LocationTypeGPLinkCode
object
5 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2
object
6 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryType
object
8 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType
object
49 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeConsulter
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeDoctor
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeLocum
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeScripts
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.OrganisationInformation37V2.RoleType
object
7 properties
PartnerApi.EmisOpen.OrganisationInformation37V2.TypeOfLocationType
object
5 properties
PartnerApi.EmisOpen.PatientMatches37.AddressType
object
11 properties
PartnerApi.EmisOpen.PatientMatches37.ApplicationType
object
7 properties
PartnerApi.EmisOpen.PatientMatches37.IdentType
object
5 properties
PartnerApi.EmisOpen.PatientMatches37.IntegerCodeType
object
7 properties
PartnerApi.EmisOpen.PatientMatches37.PatientMatches
object
2 properties
PartnerApi.EmisOpen.PatientMatches37.PatientMatchesPatient
object
57 properties
PartnerApi.EmisOpen.PatientMatches37.PersonCategoryType
object
9 properties
PartnerApi.EmisOpen.PatientMatches37.PersonCategoryTypePurpose
integer
PartnerApi.EmisOpen.PatientMatches37.PersonType
object
49 properties
PartnerApi.EmisOpen.PatientMatches37.PersonTypeChildSurveillance
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeConsulter
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeContraceptive
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeContractualRelationship
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeDoctor
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeLocum
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeMinorSurgery
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeRegistrar
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeScripts
integer
PartnerApi.EmisOpen.PatientMatches37.PersonTypeTwentyFourHour
integer
PartnerApi.EmisOpen.PatientMatches37.RegistrationTypeCustomRegistrationEntry
object
2 properties
PartnerApi.EmisOpen.PatientMatches37.RegistrationTypeDead
integer
PartnerApi.EmisOpen.PatientMatches37.RoleType
object
8 properties
PartnerApi.EmisOpen.PatientMatches37.StatusType
object
8 properties
PartnerApi.EmisOpen.PatientMatches37.StringCodeType
object
7 properties
PartnerApi.EmisOpen.PatientMatches37.StringCodeTypeScheme
integer
PartnerApi.EmisOpen.PatientSearchesMatches.PatientMatches
object
1 property
PartnerApi.EmisOpen.PatientSearchesMatches.PatientType
object
2 properties
PartnerApi.EmisOpen.SlotsForSession.PatientListStruct
object
1 property
PartnerApi.EmisOpen.SlotsForSession.PatientStruct
object
6 properties
PartnerApi.EmisOpen.SlotsForSession.SlotListStruct
object
1 property
PartnerApi.EmisOpen.SlotsForSession.SlotStruct
object
9 properties
PartnerApi.EmisOpen.SlotsForSession.TypeStruct
object
2 properties
PartnerApi.EmisOpen.SlotsForSessionV2.PatientListStruct
object
1 property
PartnerApi.EmisOpen.SlotsForSessionV2.PatientStruct
object
6 properties
PartnerApi.EmisOpen.SlotsForSessionV2.SlotListStruct
object
1 property
PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct
object
10 properties
PartnerApi.EmisOpen.SlotsForSessionV2.TypeStruct
object
2 properties
PartnerApi.Service.Constants.AppointmentStatus
integer
PartnerApi.Service.Contracts.Attachment.PfsVisibilityType
integer
PartnerApi.Service.Contracts.Attachment.ProvisionalType
integer
PartnerApi.Service.Contracts.Search.ReportType
integer
PartnerApi.Service.Contracts.UpdateConsultationVisibility.PfsVisibilityType
integer
PartnerApi.Service.Model.Appointment
object
2 properties
PartnerApi.Service.Model.Coding
object
3 properties
PartnerApi.Service.Model.Details
object
2 properties
PartnerApi.Service.Model.ErrorResponse
object
4 properties
PartnerApi.Service.Model.Issue
object
4 properties
PartnerApi.Service.Model.SeverityType
integer
PartnerApi.Service.Model.Text
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emis-health-partner-api-openapi.json Raw ↑

Other APIs EMIS Health publishes across the network.

EMIS-X App Launch
EMIS-X Analytics