{ "openapi": "3.0.4", "info": { "title": "Partner API", "version": "1.2" }, "paths": { "/api/v1/appointments/BookAppointment": { "get": { "tags": [ "appointments" ], "description": "This call books a patient into the specified appointment slot", "operationId": "BookAppointment", "parameters": [ { "name": "reason", "in": "query", "description": "The reason for making the appointment", "required": true, "schema": { "type": "string" } }, { "name": "bookedBy", "in": "query", "description": "DBID of staff making the appointment", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "bookingNote", "in": "query", "description": "Optional booking note for the appointment", "schema": { "type": "string" } }, { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of appointment booked", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Appointment.BookedAppointmentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Appointment.BookedAppointmentType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/CancelAppointment": { "get": { "tags": [ "appointments" ], "description": "This call removes a patient from a specified appointment slot", "operationId": "CancelAppointment", "parameters": [ { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of appointment cancelled", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Appointment.BookedAppointmentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Appointment.BookedAppointmentType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetAppointmentConfiguration": { "get": { "tags": [ "appointments" ], "description": "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 holidays to avoid returning large amounts of historical data.", "operationId": "GetAppointmentConfiguration", "parameters": [ { "name": "startDate", "in": "query", "description": "Lower date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Upper date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves the appointment configuration within a given time frame", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.AppointmentConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.AppointmentConfiguration" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetAppointmentSessions": { "get": { "tags": [ "appointments" ], "description": "This call returns a list of appointment sessions within a given timeframe. The maximum window to retrieve sessions is 90 days.", "operationId": "GetAppointmentSessions", "parameters": [ { "name": "slotType", "in": "query", "description": "Slot type as returned from GetAppointmentConfiguration - if empty, returns all", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Lower date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Upper date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of appointment sessions retrieved", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionList" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetArrivedPatients": { "get": { "tags": [ "appointments" ], "description": "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 clinician.", "operationId": "GetArrivedPatients", "parameters": [ { "name": "minutesBefore", "in": "query", "description": "How many minutes before the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "minutesWithin", "in": "query", "description": "How many minutes within the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves a list of arrived appointments within a given time frame", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatients" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatients" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetAttachments": { "get": { "tags": [ "medicalRecord" ], "description": "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 for file names, and call the GetBase64AttachmentData method for each attachment you wish to retrieve.", "operationId": "GetAttachments", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's attachments", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetAttachmentsV2": { "get": { "tags": [ "medicalRecord" ], "description": "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 for file names, and call the GetBase64AttachmentData method for each attachment you wish to retrieve.", "operationId": "GetAttachmentsV2", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's attachments", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetBase64AttachmentData": { "get": { "tags": [ "medicalRecord" ], "description": "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 file in the body of the XML, encoded in Base-64 to allow it to be returned in XML format. The client application must decode the attachment from Base-64 in order to use it. The specification for base-64 encoding is readily available from usual reference sources. After decoding, the client application should handle the attachment appropriately, including ensuring proper disposal of the file when it is no longer needed", "operationId": "GetBase64AttachmentData", "parameters": [ { "name": "documentId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves base 64 attachment details", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Base64AttachmentData.root" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Base64AttachmentData.root" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetBase64AttachmentDataV2": { "get": { "tags": [ "medicalRecord" ], "description": "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 attached file in the body of the XML, encoded in Base-64 to allow it to be returned in XML format. The client application must decode the attachment from Base-64 in order to use it. The specification for base-64 encoding is readily available from usual reference sources. After decoding, the client application should handle the attachment appropriately, including ensuring proper disposal of the file when it is no longer needed. V2 includes additional fields: PatientNHS and OrganisationNACS", "operationId": "GetBase64AttachmentDataV2", "parameters": [ { "name": "documentId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves base 64 attachment details (V2)", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Base64AttachmentDataV2.root" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Base64AttachmentDataV2.root" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetBookedPatients": { "get": { "tags": [ "appointments" ], "description": "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 each session holder it indicates the estimated waiting time (how far behind the doctor is running).\n\n**Important:** To manage loads on the server the call is restricted to searching 60 minutes in the past but can search up to 30 days in the future. Care should be taken to minimise the search window, to manage the amount of data being returned, as this call is capable of placing significant loads on the clinical system if abused.", "operationId": "GetBookedPatients", "parameters": [ { "name": "minutesBefore", "in": "query", "description": "How many minutes before the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "minutesWithin", "in": "query", "description": "How many minutes within the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves a list of booked appointments within a given time frame", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatients" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatients" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetBookedPatientsV2": { "get": { "tags": [ "appointments" ], "description": "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 each session holder it indicates the estimated waiting time (how far behind the doctor is running).\n\n**Important:** To manage loads on the server the call is restricted to searching 60 minutes in the past but can search up to 30 days in the future. Care should be taken to minimise the search window to manage the amount of data being returned as this call is capable of placing significant loads on the clinical system if abused.\n\nGetBookedPatientsV2 returns slotType and its description, versus GetBookedPatients.", "operationId": "GetBookedPatientsV2", "parameters": [ { "name": "minutesBefore", "in": "query", "description": "How many minutes before the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "minutesWithin", "in": "query", "description": "How many minutes within the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves a list of booked appointments within a given time frame containing slotType and description", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/patientMatching/GetChangedPatients": { "get": { "tags": [ "patientMatching" ], "description": "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.", "operationId": "GetChangedPatients", "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves the patients whose registration record has changed", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-subjects.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/patientMatching/GetChangedPatientsMR": { "get": { "tags": [ "patientMatching" ], "description": "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 returns an empty list.", "operationId": "GetChangedPatientsMR", "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves the patients whose medical record has changed", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-subjects.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetCodedRecord": { "get": { "tags": [ "medicalRecord" ], "description": "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.", "operationId": "GetCodedRecord", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's coded record", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetConsultation": { "get": { "tags": [ "medicalRecord" ], "description": "This call returns a specific consultation record and any associated information. For instance, the location and users relating to the consultation content.", "operationId": "GetConsultation", "parameters": [ { "name": "consultationGuid", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's consultation", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetEvents": { "get": { "tags": [ "medicalRecord" ], "description": "This call returns a subset of the medical record which comprises only the **coded clinical events** for the patient.\n\nInformation is returned for the specified time period counting back from the current day, in **whole days**.\n\nThis function executes significantly faster than `getMedicalRecord`, particularly for patients with large records.\n\nThe returned XML will contain the following elements:\n\n- `EventList`\n- `PeopleList`\n\nNote: It does **not** contain **Medication** information.\n\nThe call effectively *looks back* the number of days specified from today.", "operationId": "GetEvents", "parameters": [ { "name": "noOfDays", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's events", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/": { "get": { "tags": [ "health" ], "operationId": "GetHealth", "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/patientMatching/GetMatchedPatients": { "get": { "tags": [ "patientMatching" ], "description": "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.\n\nExample: \"DOB firstName lastName\"\n\nDo not include parentheses, special characters, country codes, or non-standard formats in the search term.\n\nA standard demographic message is returned", "operationId": "GetMatchedPatients", "parameters": [ { "name": "matchedTerms", "in": "query", "schema": { "type": "string" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves the patients who match search criteria", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-subjects.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetMedicalRecord": { "get": { "tags": [ "medicalRecord" ], "description": "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 calls can give you the same information. This call can take a while to execute and will return a lot of information (>1Mb) in some cases. If you are only concerned with clinically coded information we would recommend using GetCodedRecord as an alternative.", "operationId": "GetMedicalRecord", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's medical record", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/GetMedicationIssues": { "get": { "tags": [ "medicalRecord" ], "description": "This call returns a list of issued medication. This call will execute significantly faster than getMedicalRecord, particularly for patients with large medical records.", "operationId": "GetMedicationIssues", "parameters": [ { "name": "noOfDays", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "The patient's medication issues", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/organisation/GetOrganisation": { "get": { "tags": [ "organisation" ], "description": "This call returns details about the practice administration including users, locations and location types.", "operationId": "GetOrganisation", "parameters": [ { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves organisation details", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-config.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/organisation/GetOrganisationV2": { "get": { "tags": [ "organisation" ], "description": "This call returns details about the practice administration including users, locations and location types.", "operationId": "GetOrganisationV2", "parameters": [ { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves organisation details", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-config.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetPatientAppointments": { "get": { "tags": [ "appointments" ], "description": "This call returns a list of patient appointments within a given timeframe. The maximum window to retrieve sessions is 90 days.", "operationId": "GetPatientAppointments", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Lower date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Upper date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of patient appointments retrieved", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointments.PatientAppointmentList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointments.PatientAppointmentList" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetPatientAppointmentsV2": { "get": { "tags": [ "appointments" ], "description": "This call returns a list of patient appointments within a given timeframe. The maximum window to retrieve sessions is 90 days.", "operationId": "GetPatientAppointmentsV2", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Lower date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Upper date filter in the format dd/mm/yyyy", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of patient appointments retrieved", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointmentsV2.PatientAppointmentListV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointmentsV2.PatientAppointmentListV2" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/patient/GetPatientDemographics": { "get": { "tags": [ "patient" ], "description": "This call returns a demographic subset of the medical record for a specific patient number.", "operationId": "GetPatientDemographics", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves a patients demographics", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-subjects.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/search/GetPatientSearches": { "get": { "tags": [ "search" ], "description": "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.\n\nHAID (How Am I Driving) runs on the following intervals:\n1. How Am I Driving – Weekly (Wednesday and Weekend)\n2. End of Financial Year – Weekends only\n3. Look Ahead 1 and 3 Months – Runs based on available bandwidth\n\nReport Types:\n0 = 3 Month Look-Ahead\n1 = How Am I Driving\n2 = Financial Year End\n3 = 1 Month Look-Ahead", "operationId": "GetPatientSearches", "parameters": [ { "name": "searchGuid", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "site", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "reportType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Contracts.Search.ReportType" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves search details", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientSearchesMatches.PatientMatches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientSearchesMatches.PatientMatches" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-searches.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/patientMatching/GetPatientSequence": { "get": { "tags": [ "patientMatching" ], "description": "This API retrieves the next batch of patients from the Age-Sex Register, based on the specified batch size and starting patient ID (`StartID`).\n\nNote: This endpoint is provided for legacy use only and is not part of the standard, publicly available API set. Access may be restricted or unsupported in newer implementations.", "operationId": "GetPatientSequence", "parameters": [ { "name": "startId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "batchSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves the next set of patients from the age sex register", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatches" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-subjects.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetSentInPatients": { "get": { "tags": [ "appointments" ], "description": "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 set until they leave the surgery.\n\n**Note:** The patient will be returned each time the function is called whilst they are in the consultation.", "operationId": "GetSentInPatients", "parameters": [ { "name": "minutesBefore", "in": "query", "description": "How many minutes before the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "minutesWithin", "in": "query", "description": "How many minutes within the query time to search", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves a list of sent-in appointments within a given time frame", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatients" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatients" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetSlotsForSession": { "get": { "tags": [ "appointments" ], "description": "This call retrieves a list of slots in a specified session.", "operationId": "GetSlotsForSession", "parameters": [ { "name": "appointmentSessionId", "in": "query", "description": "Appointment session id as returned from GetAppointmentSessions", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of slots for the specified session", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSession.SlotListStruct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSession.SlotListStruct" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/GetSlotsForSessionV2": { "get": { "tags": [ "appointments" ], "description": "This call retrieves a list of slots in a specified session.", "operationId": "GetSlotsForSessionV2", "parameters": [ { "name": "appointmentSessionId", "in": "query", "description": "Appointment session id as returned from GetAppointmentSessions", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Details of slots for the specified session", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotListStruct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotListStruct" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/user/GetUserById": { "get": { "tags": [ "user" ], "description": "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 details of a member of staff based on their DBID using this function. The XML returned is the same as the node information in GetOrganisation.", "operationId": "GetUserById", "parameters": [ { "name": "userInRoleId", "in": "query", "description": "User DBID as returned from GetOrganisation", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Retrieves user details", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.UserDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.UserDetails" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-config.read" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/AddSlotComment": { "patch": { "tags": [ "appointments" ], "description": "Adds a comment to a slot. Comments can be added to any specified slot.", "operationId": "AddSlotComment", "parameters": [ { "name": "slotComment", "in": "query", "description": "Slot Comment to add to specified SlotId", "required": true, "schema": { "type": "string" } }, { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "204": { "description": "Add a slot comment to the specified slotId", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/SetAppointmentStatus": { "patch": { "tags": [ "appointments" ], "description": "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.", "operationId": "SetAppointmentStatus", "parameters": [ { "name": "statusId", "in": "query", "description": "The new status for the appointment (2 = Arrive, 3 = SentIn, 4 = Left, 12 = QuietSentIn)", "required": true, "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Constants.AppointmentStatus" } }, { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "204": { "description": "Set an appointment to the specified status", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Appointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Appointment" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/SetAppointmentStatusEx": { "patch": { "tags": [ "appointments" ], "description": "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.\n\n**Note:** For compatibility, the return codes are not entirely consistent with the methods used in the rest of these calls.", "operationId": "SetAppointmentStatusEx", "parameters": [ { "name": "statusId", "in": "query", "description": "The new status of the selected appointment slot", "required": true, "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Constants.AppointmentStatus" } }, { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Set an appointment to the specified status", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Appointment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Appointment" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/SetSlotNotes": { "patch": { "tags": [ "appointments" ], "description": "Updates the existing slot notes for a specified appointment slot.", "operationId": "SetSlotNotes", "parameters": [ { "name": "slotNotes", "in": "query", "description": "Slot Notes", "schema": { "type": "string" } }, { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Sets the slot notes for a specified appointment slot", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/appointments/SetSlotType": { "patch": { "tags": [ "appointments" ], "description": "This call sets the slot type and booking note of a given slot.", "operationId": "SetSlotType", "parameters": [ { "name": "slotType", "in": "query", "description": "New SlotTypeId for the selected Slot", "schema": { "type": "string" } }, { "name": "bookingNote", "in": "query", "description": "Optional booking note for the appointment", "schema": { "type": "string" } }, { "name": "slotId", "in": "query", "description": "The ID of the appointment slot", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "204": { "description": "Sets the slot type of a given slot", "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-appt.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/UpdateAttachment": { "patch": { "tags": [ "medicalRecord" ], "description": "This function updates the pfs visible and provisional status of a specified attachment", "operationId": "UpdateAttachment", "parameters": [ { "name": "attachmentGuid", "in": "query", "description": "The Attachment Guid (aka Document Guid) Identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pfsVisibility", "in": "query", "description": "The Pfs visible status of the specified attachment. -1 = No Change, 0 = Not Visible, 1 = Visible", "required": true, "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Contracts.Attachment.PfsVisibilityType" } }, { "name": "provisional", "in": "query", "description": "The Provisional status of the specified attachment. -1 = No Change, 0 = Not Provisional, 1 = Provisional", "required": true, "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Contracts.Attachment.ProvisionalType" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "204": { "description": "Updates the pfs visible status and provisional status of a specified attachment", "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/UpdateConsultationVisibility": { "patch": { "tags": [ "medicalRecord" ], "description": "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.", "operationId": "UpdateConsultationVisibility", "parameters": [ { "name": "consultationGuid", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pfsVisibility", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Contracts.UpdateConsultationVisibility.PfsVisibilityType" } }, { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "200": { "description": "Updates visibility of a given consultation", "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/api/v1/medicalRecord/FileRecord": { "post": { "tags": [ "medicalRecord" ], "description": "This call files a new consultation from an XML message, into a patient's medical record. \n\nPatient ID\nThis is the DBID number of the patient.\n\nAttachments are referenced by the Attachment/Address element. The 'attachment' parameter should indicate the local path preceding the file name that resides in the address element. The filer uses the path and the address element to transfer the attachment from the client to the server. Note: the trailing backslash on the path argument is required.\n\nFiling Records – The following filing operations are only permitted to the EMIS system.• File an attachment as a new consultation.• File a coded value as a new consultation.• File a text comment as a new consultation.\n\nOnline Visibility functionality in EMIS Web enables authorised users to make a consultation and its contents not visible to patients in their online care record. This is typically used for safeguarding purposes; a clinician may set a consultation to ‘not visible’ if a patient allows their partner to access their online account but doesn’t want them to see a particular issue.The ‘PfsVisible’ flag can be set for a new consultation filed into EMIS Web using the Partner API. The status of this flag must be determined by the clinician (end user). These flags can subsequently be managed using ‘GetConsultation’ and ‘UpdateConsultationVisibility’", "operationId": "FileRecord", "parameters": [ { "name": "patientNumber", "in": "query", "description": "The numeric patient identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "applicationId", "in": "header", "description": "The applicationId (aka party key) will be provided by your assurance lead", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType" } } }, "required": true }, "responses": { "500": { "description": "Internal error", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "400": { "description": "Bad request - adjust URL or parameters", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "401": { "description": "Authentication token not valid", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "415": { "description": "Media type not valid for URL", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartnerApi.Service.Model.ErrorResponse" } } } }, "204": { "description": "Files to a patients record", "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearer": [ ] }, { "OAuth2CodeEMIS-X-GP-PAPI": [ "papi-cr.write" ] } ] }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } }, "/swagger/*": { "get": { "tags": [ "swagger" ], "summary": "Swagger UI endpoint", "description": "Serves the Swagger UI and OpenAPI JSON.", "operationId": "swagger", "responses": { "200": { "description": "Swagger UI or OpenAPI JSON" } } }, "options": { "tags": [ "CORS" ], "summary": "CORS pre-flight request", "description": "Handles CORS pre-flight requests", "responses": { "204": { "description": "No Content" } } } } }, "components": { "schemas": { "PartnerApi.EmisOpen.Appointment.AppointmentInformationType": { "type": "object", "properties": { "sessionId": { "type": "integer", "format": "int64" }, "slotId": { "type": "integer", "format": "int64" }, "slotDateTime": { "type": "string", "nullable": true }, "endDateTime": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "bookingNotes": { "type": "string", "nullable": true }, "slotTypeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.Appointment.BookedAppointmentType": { "type": "object", "properties": { "appointmentInformation": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Appointment.AppointmentInformationType" }, "patientInforamtion": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.Appointment.PatientInformationType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.Appointment.PatientInformationType": { "type": "object", "properties": { "patientId": { "type": "integer", "format": "int32", "nullable": true }, "led": { "type": "string", "nullable": true }, "patientNumber": { "type": "integer", "format": "int32", "nullable": true }, "dob": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "hasPatientWarnings": { "type": "string", "nullable": true }, "actionPerformedOn": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.AppointmentConfiguration": { "type": "object", "properties": { "siteList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.SiteStruct" }, "nullable": true }, "holderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.HolderStruct" }, "nullable": true }, "scheduleList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.ScheduleStruct" }, "nullable": true }, "holidayList": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.HolidaysStruct" }, "slotTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.TypeStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.HolderStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.HolidayStruct": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "day": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "endTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.HolidaysStruct": { "type": "object", "properties": { "practice": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.HolidayStruct" }, "nullable": true }, "staff": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.IndividualStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.IndividualStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "dates": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentConfiguration.HolidayStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.ScheduleStruct": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "endTime": { "type": "string", "nullable": true }, "slotLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.SiteStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentConfiguration.TypeStruct": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "display": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bookable": { "type": "string", "nullable": true }, "emisAccess": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionList": { "type": "object", "properties": { "appointmentSession": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentSessions.AppointmentSessionStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "endTime": { "type": "string", "nullable": true }, "slotLength": { "type": "string", "nullable": true }, "slotTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentSessions.SlotsStruct" }, "nullable": true }, "site": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentSessions.SiteStruct" }, "holderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.AppointmentSessions.HolderStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentSessions.HolderStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentSessions.SiteStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.AppointmentSessions.SlotsStruct": { "type": "object", "properties": { "typeID": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" }, "booked": { "type": "integer", "format": "int32" }, "blocked": { "type": "integer", "format": "int32" }, "embargoed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.Base64AttachmentData.root": { "type": "object", "properties": { "filedata": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.Base64AttachmentDataV2.root": { "type": "object", "properties": { "filedata": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true }, "patientNHS": { "type": "string", "nullable": true }, "organisationNACS": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.BookedPatients": { "type": "object", "properties": { "bookedList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBooked" }, "nullable": true }, "sessionHolderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatientsSessionHolder" }, "nullable": true }, "time": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBooked": { "type": "object", "properties": { "patient": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.RegistrationType" }, "appointment": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAppointment" }, "alert": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAlert" }, "alertSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAlert": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.BookedPatientsBookedAppointment": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "appointmentSite": { "type": "string", "nullable": true }, "appointmentName": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "sessionHolder": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "sessionUsersList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "nullable": true }, "sessionLocationsList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "nullable": true }, "sessionId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.BookedPatientsSessionHolder": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.RoleType" }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true }, "waitingTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeConsulter": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.RegistrationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "sex": { "type": "string", "nullable": true }, "previousNames": { "type": "string", "nullable": true }, "familyName": { "type": "string", "nullable": true }, "callingName": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "nhsNumber": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.AddressType" }, "homeTelephone": { "type": "string", "nullable": true }, "registeredGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "usualGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "tradingHaID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "walkingQuarters": { "type": "string", "nullable": true }, "dispensing": { "type": "string", "nullable": true }, "ruralMileage": { "type": "string", "nullable": true }, "difficultQuarters": { "type": "string", "nullable": true }, "residentialInstitute": { "type": "string", "nullable": true }, "blockedSpecial": { "type": "string", "nullable": true }, "recordsAt": { "type": "string", "nullable": true }, "hospitalNumbers": { "type": "string", "nullable": true }, "deductedDate": { "type": "string", "nullable": true }, "dateOfDeath": { "type": "string", "nullable": true }, "dead": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeDead" }, "deadSpecified": { "type": "boolean" }, "dateAdded": { "type": "string", "nullable": true }, "oldNhsNumber": { "type": "string", "nullable": true }, "workTelephone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "homeAddress": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.AddressType" }, "homeGP": { "type": "string", "nullable": true }, "homeGPCode": { "type": "string", "nullable": true }, "chiNumber": { "type": "string", "nullable": true }, "footpathMiles": { "type": "string", "nullable": true }, "waterMiles": { "type": "string", "nullable": true }, "serviceType": { "type": "string", "nullable": true }, "serviceNumber": { "type": "string", "nullable": true }, "customRegistrationFields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeCustomRegistrationEntry" }, "nullable": true }, "groNumber": { "type": "string", "nullable": true }, "upciNumber": { "type": "string", "nullable": true }, "maritalStatus": { "type": "string", "nullable": true }, "medicationReviewDate": { "type": "string", "nullable": true }, "exemptionExpiry": { "type": "string", "nullable": true }, "screenMessage": { "type": "string", "nullable": true }, "reminderSent": { "type": "string", "nullable": true }, "ethnicCode": { "type": "string", "nullable": true }, "prisonNumber": { "type": "string", "nullable": true }, "previousPrisonNumbers": { "type": "string", "nullable": true }, "prisonDoctorGP": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "socialSecurityNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeCustomRegistrationEntry": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37.RegistrationTypeDead": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2": { "type": "object", "properties": { "bookedList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2Booked" }, "nullable": true }, "sessionHolderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2SessionHolder" }, "nullable": true }, "time": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2Booked": { "type": "object", "properties": { "patient": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.RegistrationType" }, "appointment": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointment" }, "alert": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAlert" }, "alertSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAlert": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointment": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "appointmentSite": { "type": "string", "nullable": true }, "appointmentName": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "sessionHolder": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "sessionUsersList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "nullable": true }, "sessionLocationsList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "nullable": true }, "sessionId": { "type": "integer", "format": "int64" }, "slotType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointmentSlotType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2BookedAppointmentSlotType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "display": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bookable": { "type": "boolean" }, "emisAccess": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.BookedPatientsV2SessionHolder": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.RoleType" }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true }, "waitingTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeConsulter": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.RegistrationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "sex": { "type": "string", "nullable": true }, "previousNames": { "type": "string", "nullable": true }, "familyName": { "type": "string", "nullable": true }, "callingName": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "nhsNumber": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.AddressType" }, "homeTelephone": { "type": "string", "nullable": true }, "registeredGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "usualGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "tradingHaID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "walkingQuarters": { "type": "string", "nullable": true }, "dispensing": { "type": "string", "nullable": true }, "ruralMileage": { "type": "string", "nullable": true }, "difficultQuarters": { "type": "string", "nullable": true }, "residentialInstitute": { "type": "string", "nullable": true }, "blockedSpecial": { "type": "string", "nullable": true }, "recordsAt": { "type": "string", "nullable": true }, "hospitalNumbers": { "type": "string", "nullable": true }, "deductedDate": { "type": "string", "nullable": true }, "dateOfDeath": { "type": "string", "nullable": true }, "dead": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeDead" }, "deadSpecified": { "type": "boolean" }, "dateAdded": { "type": "string", "nullable": true }, "oldNhsNumber": { "type": "string", "nullable": true }, "workTelephone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "homeAddress": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.AddressType" }, "homeGP": { "type": "string", "nullable": true }, "homeGPCode": { "type": "string", "nullable": true }, "chiNumber": { "type": "string", "nullable": true }, "footpathMiles": { "type": "string", "nullable": true }, "waterMiles": { "type": "string", "nullable": true }, "serviceType": { "type": "string", "nullable": true }, "serviceNumber": { "type": "string", "nullable": true }, "customRegistrationFields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeCustomRegistrationEntry" }, "nullable": true }, "groNumber": { "type": "string", "nullable": true }, "upciNumber": { "type": "string", "nullable": true }, "maritalStatus": { "type": "string", "nullable": true }, "medicationReviewDate": { "type": "string", "nullable": true }, "exemptionExpiry": { "type": "string", "nullable": true }, "screenMessage": { "type": "string", "nullable": true }, "reminderSent": { "type": "string", "nullable": true }, "ethnicCode": { "type": "string", "nullable": true }, "prisonNumber": { "type": "string", "nullable": true }, "previousPrisonNumbers": { "type": "string", "nullable": true }, "prisonDoctorGP": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "socialSecurityNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeCustomRegistrationEntry": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.BookedPatients37V2.RegistrationTypeDead": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.BookedPatients37V2.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.BookedPatients37V2.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointments.AppointmentStruct": { "type": "object", "properties": { "slotID": { "type": "integer", "format": "int32" }, "siteID": { "type": "integer", "format": "int32" }, "date": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "sessionName": { "type": "string", "nullable": true }, "sessionDBID": { "type": "integer", "format": "int32" }, "holderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointments.HolderStruct" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointments.HolderStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointments.PatientAppointmentList": { "type": "object", "properties": { "appointment": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointments.AppointmentStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStruct": { "type": "object", "properties": { "slotID": { "type": "integer", "format": "int32" }, "siteID": { "type": "integer", "format": "int32" }, "date": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "sessionName": { "type": "string", "nullable": true }, "sessionDBID": { "type": "integer", "format": "int32" }, "holderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointmentsV2.HolderStruct" }, "nullable": true }, "status": { "type": "string", "nullable": true }, "slotType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStructSlotType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStructSlotType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "display": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "bookable": { "type": "boolean" }, "emisAccess": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointmentsV2.HolderStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.GetPatientAppointmentsV2.PatientAppointmentListV2": { "type": "object", "properties": { "appointment": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.GetPatientAppointmentsV2.AppointmentStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.RoleType" }, "activeUser": { "type": "string", "nullable": true }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeConsulter": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord35.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord35.UserDetails": { "type": "object", "properties": { "person": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord35.PersonType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AlertType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "book": { "type": "string", "nullable": true }, "ariveSwap": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AllergyType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "episodicity": { "type": "integer", "format": "int32" }, "episodicitySpecified": { "type": "boolean" }, "allergyType1": { "type": "integer", "format": "int32" }, "allergyType1Specified": { "type": "boolean" }, "codes": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "exclude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AppointmentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "sessionHolder": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "locationID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "assignedDate": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "site": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AppointmentTypeSite" }, "sessionID": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "duration": { "type": "number", "format": "float" }, "durationSpecified": { "type": "boolean" }, "rub": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AppointmentTypeSite": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AttachmentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "title": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "ddsIdentifier": { "type": "string", "nullable": true }, "attachmentData": { "type": "string", "nullable": true }, "provisional": { "type": "boolean" }, "provisionalSpecified": { "type": "boolean" }, "pfsVisible": { "type": "boolean" }, "pfsVisibleSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.AuthorType": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "systemDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.CareAimType": { "type": "object", "properties": { "pkId": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "goal": { "type": "string", "nullable": true }, "targetDate": { "type": "string", "format": "date-time" }, "targetDateSpecified": { "type": "boolean" }, "expectedValue": { "type": "string", "nullable": true }, "actualValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.CarePlanType": { "type": "object", "properties": { "pkId": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "displayTerm": { "type": "string", "nullable": true }, "termId": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "notes": { "type": "string", "nullable": true }, "templateId": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "interventionCategoryId": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "interventionTargetTermId": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ConsultationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "userID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "externalConsultant": { "type": "string", "nullable": true }, "locationID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "locationTypeID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "accompanyingHCPID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "consultationType1": { "type": "integer", "format": "int32" }, "consultationType1Specified": { "type": "boolean" }, "duration": { "type": "string", "nullable": true }, "travelTime": { "type": "string", "nullable": true }, "appointmentSlotID": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "elementList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ElementListTypeConsultationElement" }, "nullable": true }, "pfsVisible": { "type": "boolean" }, "pfsVisibleSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType": { "type": "object", "properties": { "dduBatch": { "type": "string", "nullable": true }, "dduPrinted": { "type": "string", "nullable": true }, "dduCollect": { "type": "string", "nullable": true }, "dduNextDate": { "type": "string", "nullable": true }, "dduReduceBy": { "type": "string", "nullable": true }, "dduAfter": { "type": "string", "nullable": true }, "dduUntil": { "type": "string", "nullable": true }, "dduNextDose": { "type": "string", "nullable": true }, "dduOffset": { "type": "string", "nullable": true }, "dduClWorker": { "type": "string", "nullable": true }, "dduPickUp": { "type": "string", "nullable": true }, "dduDoseAbbrev": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.DiaryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "templateID": { "type": "string", "nullable": true }, "templateInstanceID": { "type": "string", "nullable": true }, "templateComponentName": { "type": "string", "nullable": true }, "durationTerm": { "type": "string", "nullable": true }, "reminder": { "type": "string", "nullable": true }, "reminderType": { "type": "string", "nullable": true }, "locationTypeID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType": { "type": "object", "properties": { "doseQuantity": { "type": "number", "format": "float" }, "doseQuantitySpecified": { "type": "boolean" }, "doseUnits": { "type": "string", "nullable": true }, "frequency": { "type": "string", "nullable": true }, "frequencyUnits": { "type": "string", "nullable": true }, "dailyDose": { "type": "number", "format": "float" }, "dailyDoseSpecified": { "type": "boolean" }, "dailyDoseUnits": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.EDIComment": { "type": "object", "properties": { "ftx": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.EDIOrderType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "headerID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "provider": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "formDestination": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeFormDestination" }, "orderCategory": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeOrderCategory" }, "status": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeStatus" }, "statusSpecified": { "type": "boolean" }, "lastStatusDate": { "type": "string", "nullable": true }, "testRequestList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeFormDestination": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeOrderCategory": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.ElementListTypeConsultationElement": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "displayOrder": { "type": "integer", "format": "int32" }, "displayOrderSpecified": { "type": "boolean" }, "problemSection": { "type": "integer", "format": "int32" }, "problemSectionSpecified": { "type": "boolean" }, "header": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" }, "item": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.EventType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "groupID": { "type": "string", "nullable": true }, "episodicity": { "type": "integer", "format": "int32" }, "episodicitySpecified": { "type": "boolean" }, "numericValue": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.NumericValueType" }, "textValue": { "nullable": true }, "abnormal": { "type": "string", "nullable": true }, "gms": { "type": "string", "nullable": true }, "eventType1": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EventTypeEventType" }, "eventType1Specified": { "type": "boolean" }, "templateID": { "type": "string", "nullable": true }, "templateInstanceID": { "type": "string", "nullable": true }, "templateComponentName": { "type": "string", "nullable": true }, "qualifiedTerm": { "type": "string", "nullable": true }, "qualifiedCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.EventTypeEventType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "term": { "type": "string", "nullable": true }, "oldCode": { "type": "string", "nullable": true }, "mapCode": { "type": "string", "nullable": true }, "mapScheme": { "type": "string", "nullable": true }, "interventionTarget": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.InvestigationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "abnormal": { "type": "string", "nullable": true }, "dataType": { "nullable": true }, "reportID": { "type": "string", "nullable": true }, "specimenID": { "type": "string", "nullable": true }, "specimenType": { "type": "string", "nullable": true }, "numberOfTests": { "type": "string", "nullable": true }, "repInvNumber": { "type": "string", "nullable": true }, "userComment": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "policyID": { "type": "string", "nullable": true }, "eventList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EventType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.IssueType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "authorisedUserID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "assignedDate": { "type": "string", "nullable": true }, "dateLastIssue": { "type": "string", "nullable": true }, "issueMethod": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod" }, "issueMethodSpecified": { "type": "boolean" }, "dateRxExpire": { "type": "string", "nullable": true }, "doseAbbreviation": { "type": "string", "nullable": true }, "dosage": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "float" }, "quantitySpecified": { "type": "boolean" }, "quantityUnits": { "type": "string", "nullable": true }, "quantityRepresentation": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "mixtureIndicator": { "type": "string", "nullable": true }, "drug": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeDrug" }, "prescriptionType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType" }, "prescriptionTypeSpecified": { "type": "boolean" }, "drugSource": { "type": "string", "nullable": true }, "rxReviewDate": { "type": "string", "nullable": true }, "pharmacyText": { "type": "string", "nullable": true }, "rxText": { "type": "string", "nullable": true }, "authorisedIssue": { "type": "string", "nullable": true }, "issueCount": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus" }, "statusSpecified": { "type": "boolean" }, "advice": { "type": "string", "nullable": true }, "template": { "type": "string", "nullable": true }, "templateComponent": { "type": "string", "nullable": true }, "templateInstance": { "type": "string", "nullable": true }, "drugDelivery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType" }, "controlledDrug": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "serviceType": { "type": "string", "nullable": true }, "dispensingInterval": { "type": "string", "nullable": true }, "repeatIssueCount": { "type": "string", "nullable": true }, "repeatInterval": { "type": "string", "nullable": true }, "etpIssue": { "type": "string", "nullable": true }, "contraceptiveIssue": { "type": "string", "nullable": true }, "policyId": { "type": "string", "nullable": true }, "estimatedCost": { "type": "number", "format": "double" }, "estimatedCostSpecified": { "type": "boolean" }, "comment": { "type": "string", "nullable": true }, "issuerID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "dateTimePrint": { "type": "string", "nullable": true }, "dateTimeDispense": { "type": "string", "nullable": true }, "dispenserID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "batchNumber": { "type": "string", "nullable": true }, "medicationLink": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationLinkType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType1": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.LinkType": { "type": "object", "properties": { "target": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "linkType1": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkTypeLinkType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.LinkTypeLinkType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.LocationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "locationName": { "type": "string", "nullable": true }, "nationalCode": { "type": "string", "nullable": true }, "locationTypeID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "cypher": { "type": "string", "nullable": true }, "interchange": { "type": "string", "nullable": true }, "linkCode": { "type": "string", "nullable": true }, "seniorPartner": { "type": "string", "nullable": true }, "pcgCode": { "type": "string", "nullable": true }, "pctCode": { "type": "string", "nullable": true }, "gpLinkCodeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LocationTypeGPLinkCode" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.LocationTypeGPLinkCode": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "linkCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType": { "type": "object", "properties": { "registration": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationType" }, "registrationChangeHistory": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeRegistrationEntry" }, "nullable": true }, "miscellaneousData": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMiscellaneousData" }, "eventList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EventType" }, "nullable": true }, "consultationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ConsultationType" }, "nullable": true }, "investigationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.InvestigationType" }, "nullable": true }, "referralList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralType" }, "nullable": true }, "allergyList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AllergyType" }, "nullable": true }, "medicationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationType" }, "nullable": true }, "issueList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IssueType" }, "nullable": true }, "attachmentList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AttachmentType" }, "nullable": true }, "diaryList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.DiaryType" }, "nullable": true }, "alertList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AlertType" }, "nullable": true }, "registrationStatus": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusType" }, "ediPathologyReportList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportType" }, "nullable": true }, "testRequestHeaderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderType" }, "nullable": true }, "noteList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.NoteType" }, "nullable": true }, "appointmentList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AppointmentType" }, "nullable": true }, "peopleList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonType" }, "nullable": true }, "locationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LocationType" }, "nullable": true }, "locationTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TypeOfLocationType" }, "nullable": true }, "originator": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.OriginatorType" }, "recipientID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "messageInformation": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformation" }, "policyList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PolicyListTypePolicyType" }, "nullable": true }, "patientID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformation": { "type": "object", "properties": { "dateCreated": { "type": "string", "nullable": true }, "timeCreated": { "type": "string", "nullable": true }, "messagePurpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagePurpose" }, "messagingError": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagingError" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagePurpose": { "type": "object", "properties": { "item": { "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagingError": { "type": "object", "properties": { "errorString": { "type": "string", "nullable": true }, "errornumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMiscellaneousData": { "type": "object", "properties": { "medicationMessage": { "type": "string", "nullable": true }, "automaticWeekNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeRegistrationEntry": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "dateChanged": { "type": "string", "nullable": true }, "userID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicationLinkType": { "type": "object", "properties": { "guid": { "type": "string", "nullable": true }, "preparationID": { "type": "string", "nullable": true }, "systemDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "authorisedUserID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "assignedDate": { "type": "string", "nullable": true }, "dateLastIssue": { "type": "string", "nullable": true }, "issueMethod": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod" }, "issueMethodSpecified": { "type": "boolean" }, "dateRxExpire": { "type": "string", "nullable": true }, "doseAbbreviation": { "type": "string", "nullable": true }, "dosage": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "float" }, "quantitySpecified": { "type": "boolean" }, "quantityUnits": { "type": "string", "nullable": true }, "quantityRepresentation": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "mixtureIndicator": { "type": "string", "nullable": true }, "drug": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeDrug" }, "prescriptionType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType" }, "prescriptionTypeSpecified": { "type": "boolean" }, "drugSource": { "type": "string", "nullable": true }, "rxReviewDate": { "type": "string", "nullable": true }, "pharmacyText": { "type": "string", "nullable": true }, "rxText": { "type": "string", "nullable": true }, "authorisedIssue": { "type": "string", "nullable": true }, "issueCount": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus" }, "statusSpecified": { "type": "boolean" }, "advice": { "type": "string", "nullable": true }, "template": { "type": "string", "nullable": true }, "templateComponent": { "type": "string", "nullable": true }, "templateInstance": { "type": "string", "nullable": true }, "drugDelivery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType" }, "controlledDrug": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "serviceType": { "type": "string", "nullable": true }, "dispensingInterval": { "type": "string", "nullable": true }, "repeatIssueCount": { "type": "string", "nullable": true }, "repeatInterval": { "type": "string", "nullable": true }, "etpIssue": { "type": "string", "nullable": true }, "contraceptiveIssue": { "type": "string", "nullable": true }, "policyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeDrug": { "type": "object", "properties": { "item": { "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.NoteType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "urgency": { "type": "string", "nullable": true }, "ownerID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "actionBefore": { "type": "string", "nullable": true }, "noteCode": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "noteText": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "reportID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.NumericValueType": { "type": "object", "properties": { "operator": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" }, "valueSpecified": { "type": "boolean" }, "units": { "type": "string", "nullable": true }, "minRangeOperator": { "type": "string", "nullable": true }, "maximumRangeOperator": { "type": "string", "nullable": true }, "numericMinimum": { "type": "number", "format": "double" }, "numericMinimumSpecified": { "type": "boolean" }, "numericMaximum": { "type": "number", "format": "double" }, "numericMaximumSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.OriginatorType": { "type": "object", "properties": { "system": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.OriginatorTypeSystem" }, "organisationType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "organisation": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.OriginatorTypeSystem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyInvestigationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "abnormal": { "type": "string", "nullable": true }, "dataType": { "nullable": true }, "reportID": { "type": "string", "nullable": true }, "specimenID": { "type": "string", "nullable": true }, "specimenType": { "type": "string", "nullable": true }, "numberOfTests": { "type": "string", "nullable": true }, "repInvNumber": { "type": "string", "nullable": true }, "userComment": { "type": "string", "nullable": true }, "userCommentAppliedBy": { "type": "string", "nullable": true }, "labSpecifiedCommentList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment" }, "nullable": true }, "ediResultStatus": { "type": "string", "nullable": true }, "investigationPerformedDateTime": { "type": "string", "nullable": true }, "filedCode": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "invContainsStandAloneTest": { "type": "string", "nullable": true }, "pathologyEventList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyTestType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "reportDataType": { "type": "string", "nullable": true }, "reportID": { "type": "string", "nullable": true }, "reportReceivedDateTime": { "type": "string", "nullable": true }, "reportIssueDateTime": { "type": "string", "nullable": true }, "reportTextList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment" }, "nullable": true }, "abnormal": { "type": "string", "nullable": true }, "recordFileStatus": { "type": "string", "nullable": true }, "consultationRef": { "type": "string", "nullable": true }, "box": { "type": "string", "nullable": true }, "requestID": { "type": "string", "nullable": true }, "requestDateTime": { "type": "string", "nullable": true }, "currentOwner": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType" }, "identifiers": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiers" }, "originalRequestor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalRequestor" }, "messageRecepient": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType" }, "serviceProvider": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeServiceProvider" }, "originalMessageDetails": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetails" }, "clinicalInformationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment" }, "nullable": true }, "viewedBy": { "nullable": true }, "trueReportID": { "nullable": true }, "specimenList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologySpecimenType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiers": { "type": "object", "properties": { "originalDetails": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersOriginalDetails" }, "matchedDetails": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersMatchedDetails" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersMatchedDetails": { "type": "object", "properties": { "forename": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nhs": { "type": "string", "nullable": true }, "patientID": { "type": "string", "nullable": true }, "sex": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersOriginalDetails": { "type": "object", "properties": { "forename": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "nhs": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "sex": { "type": "string", "nullable": true }, "labSubjectID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetails": { "type": "object", "properties": { "senderEDICode": { "type": "string", "nullable": true }, "receiverEDICode": { "type": "string", "nullable": true }, "interChange": { "type": "string", "nullable": true }, "messageID": { "type": "string", "nullable": true }, "messageType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetailsMessageType" }, "messageTypeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetailsMessageType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalRequestor": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType" }, "itemElementName": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType1" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeServiceProvider": { "type": "object", "properties": { "department": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType" }, "organisation": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType" }, "person": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologySpecimenType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "reportID": { "type": "string", "nullable": true }, "specimenID": { "type": "string", "nullable": true }, "specimenType": { "type": "string", "nullable": true }, "fastingStatus": { "type": "string", "nullable": true }, "specimenVolume": { "type": "number", "format": "float" }, "specimenVolumeSpecified": { "type": "boolean" }, "specimenUnits": { "type": "string", "nullable": true }, "collectionProcedure": { "type": "string", "nullable": true }, "anotomicalOrigin": { "type": "string", "nullable": true }, "specimenTextList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment" }, "nullable": true }, "sampleDateTime": { "type": "string", "nullable": true }, "collectionStartDate": { "type": "string", "nullable": true }, "collectionEndDate": { "type": "string", "nullable": true }, "receivedByLabDateTime": { "type": "string", "nullable": true }, "ediInvestigationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyInvestigationType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyTestType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "reportID": { "type": "string", "nullable": true }, "specimenID": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "numericValue": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.NumericValueType" }, "textValue": { "type": "string", "nullable": true }, "abnormalIndicator": { "type": "string", "nullable": true }, "ediResultStatus": { "type": "string", "nullable": true }, "labSpecifiedCommentList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment" }, "nullable": true }, "rangeInformationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyTestTypeRangeInformation" }, "nullable": true }, "filedCode": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "testNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PathologyTestTypeRangeInformation": { "type": "object", "properties": { "minRange": { "type": "string", "nullable": true }, "maxRange": { "type": "string", "nullable": true }, "rangeFTXList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment" }, "nullable": true }, "rangeQualifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RoleType" }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeConsulter": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.PolicyListTypePolicyType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "term": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "userList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ProblemType": { "type": "object", "properties": { "problemStatus": { "type": "integer", "format": "int32" }, "problemStatusSpecified": { "type": "boolean" }, "groupingStatus": { "type": "integer", "format": "int32" }, "groupingStatusSpecified": { "type": "boolean" }, "endDate": { "type": "string", "nullable": true }, "endDatePart": { "type": "integer", "format": "int32" }, "endDatePartSpecified": { "type": "boolean" }, "problemType1": { "type": "integer", "format": "int32" }, "problemType1Specified": { "type": "boolean" }, "significance": { "type": "integer", "format": "int32" }, "significanceSpecified": { "type": "boolean" }, "expectedDuration": { "type": "string", "nullable": true }, "parentProblem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "owner": { "type": "integer", "format": "int32" }, "ownerSpecified": { "type": "boolean" }, "careAimList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.CareAimType" }, "nullable": true }, "carePlanList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.CarePlanType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.QualifierType": { "type": "object", "properties": { "qualifierItemID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" }, "group": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ReferralType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "consultant": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "provider": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "speciality": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "requestType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeRequestType" }, "requestTypeSpecified": { "type": "boolean" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "referralReason": { "type": "string", "nullable": true }, "community": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeCommunity" }, "communitySpecified": { "type": "boolean" }, "urgency": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeUrgency" }, "urgencySpecified": { "type": "boolean" }, "nhs": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeNHS" }, "nhsSpecified": { "type": "boolean" }, "transport": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeTransport" }, "transportSpecified": { "type": "boolean" }, "referralRef": { "type": "string", "nullable": true }, "sourceType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "direction": { "type": "string", "nullable": true }, "sourceLocation": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "datedReferral": { "type": "string", "format": "date-time" }, "datedReferralSpecified": { "type": "boolean" }, "rejected": { "type": "integer", "format": "int32" }, "rejectedSpecified": { "type": "boolean" }, "rejectionReason": { "type": "string", "nullable": true }, "accepted": { "type": "integer", "format": "int32" }, "acceptedSpecified": { "type": "boolean" }, "assessed": { "type": "integer", "format": "int32" }, "assessedSpecified": { "type": "boolean" }, "reasonTerm": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "sourceDescription": { "type": "string", "nullable": true }, "sourceSpeciality": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "referralMode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeCommunity": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeNHS": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeRequestType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeTransport": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeUrgency": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.RegistrationHistoryType": { "type": "object", "properties": { "dateRegistered": { "type": "string", "nullable": true }, "dateDeregistered": { "type": "string", "nullable": true }, "patientType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusType": { "type": "object", "properties": { "currentStatus": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusTypeCurrentStatus" }, "statusHistoryList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StatusType" }, "nullable": true }, "registrationHistoryList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationHistoryType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusTypeCurrentStatus": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" }, "statusDate": { "type": "string", "nullable": true }, "patientType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" }, "practiceRegistered": { "type": "string", "nullable": true }, "haRegistered": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.RegistrationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "sex": { "type": "string", "nullable": true }, "previousNames": { "type": "string", "nullable": true }, "familyName": { "type": "string", "nullable": true }, "callingName": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "nhsNumber": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType" }, "homeTelephone": { "type": "string", "nullable": true }, "organisationNACS": { "type": "string", "nullable": true }, "registeredGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "usualGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "tradingHaID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "walkingQuarters": { "type": "string", "nullable": true }, "dispensing": { "type": "string", "nullable": true }, "ruralMileage": { "type": "string", "nullable": true }, "difficultQuarters": { "type": "string", "nullable": true }, "residentialInstitute": { "type": "string", "nullable": true }, "blockedSpecial": { "type": "string", "nullable": true }, "recordsAt": { "type": "string", "nullable": true }, "hospitalNumbers": { "type": "string", "nullable": true }, "deductedDate": { "type": "string", "nullable": true }, "dateOfDeath": { "type": "string", "nullable": true }, "dead": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeDead" }, "deadSpecified": { "type": "boolean" }, "dateAdded": { "type": "string", "nullable": true }, "oldNhsNumber": { "type": "string", "nullable": true }, "workTelephone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "homeAddress": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType" }, "homeGP": { "type": "string", "nullable": true }, "homeGPCode": { "type": "string", "nullable": true }, "chiNumber": { "type": "string", "nullable": true }, "footpathMiles": { "type": "string", "nullable": true }, "waterMiles": { "type": "string", "nullable": true }, "serviceType": { "type": "string", "nullable": true }, "serviceNumber": { "type": "string", "nullable": true }, "customRegistrationFields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeCustomRegistrationEntry" }, "nullable": true }, "groNumber": { "type": "string", "nullable": true }, "upciNumber": { "type": "string", "nullable": true }, "maritalStatus": { "type": "string", "nullable": true }, "medicationReviewDate": { "type": "string", "nullable": true }, "exemptionExpiry": { "type": "string", "nullable": true }, "screenMessage": { "type": "string", "nullable": true }, "reminderSent": { "type": "string", "nullable": true }, "ethnicCode": { "type": "string", "nullable": true }, "prisonNumber": { "type": "string", "nullable": true }, "previousPrisonNumbers": { "type": "string", "nullable": true }, "prisonDoctorGP": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "socialSecurityNumber": { "type": "string", "nullable": true }, "policyId": { "type": "string", "nullable": true }, "archived": { "type": "string", "nullable": true }, "scn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeCustomRegistrationEntry": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeDead": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.StatusType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" }, "statusDate": { "type": "string", "nullable": true }, "patientType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.StringCodeType": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "scheme": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeTypeScheme" }, "schemeSpecified": { "type": "boolean" }, "term": { "type": "string", "nullable": true }, "oldCode": { "type": "string", "nullable": true }, "mapCode": { "type": "string", "nullable": true }, "mapScheme": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.StringCodeTypeScheme": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "item": { "nullable": true }, "itemElementName": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "requestor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "consultationID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "dateCreated": { "type": "string", "nullable": true }, "dateForTest": { "type": "string", "nullable": true }, "dateLastXRay": { "type": "string", "nullable": true }, "status": { "nullable": true }, "lastStatusDate": { "type": "string", "nullable": true }, "copyTo": { "type": "string", "nullable": true }, "nhs": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeNHS" }, "nhsSpecified": { "type": "boolean" }, "priority": { "type": "string", "nullable": true }, "innoculationRisk": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeInnoculationRisk" }, "innoculationRiskSpecified": { "type": "boolean" }, "fasted": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeFasted" }, "fastedSpecified": { "type": "boolean" }, "lastMenstualPeriod": { "type": "string", "nullable": true }, "clinicalInformation": { "type": "string", "nullable": true }, "pregnant": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypePregnant" }, "pregnantSpecified": { "type": "boolean" }, "ediOrderList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIOrderType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeFasted": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeInnoculationRisk": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeNHS": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypePregnant": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "assignedDate": { "type": "string", "nullable": true }, "datePart": { "type": "integer", "format": "int32" }, "datePartSpecified": { "type": "boolean" }, "assignedTime": { "type": "string", "nullable": true }, "sequence": { "type": "string", "nullable": true }, "authorID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "originalAuthor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType" }, "externalConsultant": { "type": "string", "nullable": true }, "displayTerm": { "type": "string", "nullable": true }, "descriptiveText": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "policyID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "termID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "qualifierList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType" }, "nullable": true }, "problem": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType" }, "problemLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "referralLinkList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType" }, "nullable": true }, "reference": { "type": "string", "nullable": true }, "requestHeaderID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "specimenType": { "type": "string", "nullable": true }, "specimenTypeCode": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType" }, "collectionDate": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestTypeStatus" }, "statusSpecified": { "type": "boolean" }, "lastStatusDate": { "type": "string", "nullable": true }, "resultsRef": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "investigationRef": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType" }, "nullable": true }, "resultsDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.MedicalRecord38.TestRequestTypeStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.MedicalRecord38.TypeOfLocationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.LocationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "locationName": { "type": "string", "nullable": true }, "nationalCode": { "type": "string", "nullable": true }, "locationTypeID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "cypher": { "type": "string", "nullable": true }, "interchange": { "type": "string", "nullable": true }, "linkCode": { "type": "string", "nullable": true }, "seniorPartner": { "type": "string", "nullable": true }, "pcgCode": { "type": "string", "nullable": true }, "pctCode": { "type": "string", "nullable": true }, "gpLinkCodeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.LocationTypeGPLinkCode" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.LocationTypeGPLinkCode": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "linkCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation": { "type": "object", "properties": { "organisationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.LocationType" }, "nullable": true }, "userList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonType" }, "nullable": true }, "externalOrganisationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.LocationType" }, "nullable": true }, "externalPersonList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonType" }, "nullable": true }, "locationTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.TypeOfLocationType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.RoleType" }, "activeUser": { "type": "string", "nullable": true }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeConsulter": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37.TypeOfLocationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "locationName": { "type": "string", "nullable": true }, "nationalCode": { "type": "string", "nullable": true }, "locationTypeID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "cypher": { "type": "string", "nullable": true }, "interchange": { "type": "string", "nullable": true }, "linkCode": { "type": "string", "nullable": true }, "seniorPartner": { "type": "string", "nullable": true }, "pcgCode": { "type": "string", "nullable": true }, "pctCode": { "type": "string", "nullable": true }, "gpLinkCodeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationTypeGPLinkCode" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.LocationTypeGPLinkCode": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "linkCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2": { "type": "object", "properties": { "organisationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType" }, "nullable": true }, "userList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType" }, "nullable": true }, "externalOrganisationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType" }, "nullable": true }, "externalPersonList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType" }, "nullable": true }, "locationTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.TypeOfLocationType" }, "nullable": true }, "locationList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.RoleType" }, "activeUser": { "type": "string", "nullable": true }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeConsulter": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.OrganisationInformation37V2.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.OrganisationInformation37V2.TypeOfLocationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.AddressType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "houseNameFlat": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "village": { "type": "string", "nullable": true }, "town": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "postCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.ApplicationType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "applicationMnemonic": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.IdentType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.IntegerCodeType": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "term": { "type": "string", "nullable": true }, "oldCode": { "type": "string", "nullable": true }, "mapCode": { "type": "string", "nullable": true }, "mapScheme": { "type": "string", "nullable": true }, "interventionTarget": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.StringCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.PatientMatches": { "type": "object", "properties": { "patientList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PatientMatchesPatient" }, "nullable": true }, "peopleList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.PatientMatchesPatient": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "nullable": true }, "sex": { "type": "string", "nullable": true }, "previousNames": { "type": "string", "nullable": true }, "familyName": { "type": "string", "nullable": true }, "callingName": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "nhsNumber": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.AddressType" }, "homeTelephone": { "type": "string", "nullable": true }, "registeredGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "usualGpID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "tradingHaID": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "walkingQuarters": { "type": "string", "nullable": true }, "dispensing": { "type": "string", "nullable": true }, "ruralMileage": { "type": "string", "nullable": true }, "difficultQuarters": { "type": "string", "nullable": true }, "residentialInstitute": { "type": "string", "nullable": true }, "blockedSpecial": { "type": "string", "nullable": true }, "recordsAt": { "type": "string", "nullable": true }, "hospitalNumbers": { "type": "string", "nullable": true }, "deductedDate": { "type": "string", "nullable": true }, "dateOfDeath": { "type": "string", "nullable": true }, "dead": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.RegistrationTypeDead" }, "deadSpecified": { "type": "boolean" }, "dateAdded": { "type": "string", "nullable": true }, "oldNhsNumber": { "type": "string", "nullable": true }, "workTelephone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "homeAddress": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.AddressType" }, "homeGP": { "type": "string", "nullable": true }, "homeGPCode": { "type": "string", "nullable": true }, "chiNumber": { "type": "string", "nullable": true }, "footpathMiles": { "type": "string", "nullable": true }, "waterMiles": { "type": "string", "nullable": true }, "serviceType": { "type": "string", "nullable": true }, "serviceNumber": { "type": "string", "nullable": true }, "customRegistrationFields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.RegistrationTypeCustomRegistrationEntry" }, "nullable": true }, "groNumber": { "type": "string", "nullable": true }, "upciNumber": { "type": "string", "nullable": true }, "maritalStatus": { "type": "string", "nullable": true }, "medicationReviewDate": { "type": "string", "nullable": true }, "exemptionExpiry": { "type": "string", "nullable": true }, "screenMessage": { "type": "string", "nullable": true }, "reminderSent": { "type": "string", "nullable": true }, "ethnicCode": { "type": "string", "nullable": true }, "prisonNumber": { "type": "string", "nullable": true }, "previousPrisonNumbers": { "type": "string", "nullable": true }, "prisonDoctorGP": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "socialSecurityNumber": { "type": "string", "nullable": true }, "currentStatus": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.StatusType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.PersonCategoryType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonCategoryTypePurpose" }, "purposeSpecified": { "type": "boolean" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.PersonCategoryTypePurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "mnemonic": { "type": "string", "nullable": true }, "pcsUser": { "type": "string", "nullable": true }, "activeEMISUser": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonCategoryType" }, "nationalCode": { "type": "string", "nullable": true }, "prescriptionCode": { "type": "string", "nullable": true }, "gmcCode": { "type": "string", "nullable": true }, "ukccCode": { "type": "string", "nullable": true }, "scripts": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeScripts" }, "scriptsSpecified": { "type": "boolean" }, "consulter": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeConsulter" }, "consulterSpecified": { "type": "boolean" }, "contractStart": { "type": "string", "nullable": true }, "contractEnd": { "type": "string", "nullable": true }, "doctor": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeDoctor" }, "doctorSpecified": { "type": "boolean" }, "locum": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeLocum" }, "locumSpecified": { "type": "boolean" }, "registrar": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeRegistrar" }, "registrarSpecified": { "type": "boolean" }, "maternity": { "type": "string", "nullable": true }, "childSurveillance": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeChildSurveillance" }, "childSurveillanceSpecified": { "type": "boolean" }, "contraceptive": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeContraceptive" }, "contraceptiveSpecified": { "type": "boolean" }, "twentyFourHour": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeTwentyFourHour" }, "twentyFourHourSpecified": { "type": "boolean" }, "minorSurgery": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeMinorSurgery" }, "minorSurgerySpecified": { "type": "boolean" }, "resonsibleHA": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "trainer": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "contractualRelationship": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.PersonTypeContractualRelationship" }, "contractualRelationshipSpecified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.AddressType" }, "telephone1": { "type": "string", "nullable": true }, "telephone2": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.RoleType" }, "security1": { "type": "string", "nullable": true }, "security2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeChildSurveillance": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeConsulter": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeContraceptive": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeContractualRelationship": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeDoctor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeLocum": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeMinorSurgery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeRegistrar": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeScripts": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.PersonTypeTwentyFourHour": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.RegistrationTypeCustomRegistrationEntry": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.RegistrationTypeDead": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientMatches37.RoleType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "application": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.ApplicationType" }, "team": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" }, "location": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IdentType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.StatusType": { "type": "object", "properties": { "dbid": { "type": "string", "nullable": true }, "refID": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "fileStatus": { "type": "string", "nullable": true }, "oldGUID": { "type": "string", "nullable": true }, "code": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IntegerCodeType" }, "statusDate": { "type": "string", "nullable": true }, "patientType": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.IntegerCodeType" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.StringCodeType": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "scheme": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientMatches37.StringCodeTypeScheme" }, "schemeSpecified": { "type": "boolean" }, "term": { "type": "string", "nullable": true }, "oldCode": { "type": "string", "nullable": true }, "mapCode": { "type": "string", "nullable": true }, "mapScheme": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientMatches37.StringCodeTypeScheme": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "PartnerApi.EmisOpen.PatientSearchesMatches.PatientMatches": { "type": "object", "properties": { "patientList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.PatientSearchesMatches.PatientType" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.PatientSearchesMatches.PatientType": { "type": "object", "properties": { "refID": { "type": "integer", "format": "int32" }, "currentStatus": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSession.PatientListStruct": { "type": "object", "properties": { "patient": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSession.PatientStruct" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSession.PatientStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSession.SlotListStruct": { "type": "object", "properties": { "slot": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSession.SlotStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSession.SlotStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "nullable": true }, "slotLength": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSession.TypeStruct" }, "status": { "type": "string", "nullable": true }, "patientList": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSession.PatientListStruct" }, "notes": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSession.TypeStruct": { "type": "object", "properties": { "typeID": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSessionV2.PatientListStruct": { "type": "object", "properties": { "patient": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.PatientStruct" } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSessionV2.PatientStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "firstNames": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSessionV2.SlotListStruct": { "type": "object", "properties": { "slot": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSessionV2.SlotStruct": { "type": "object", "properties": { "dbid": { "type": "integer", "format": "int32" }, "refID": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "nullable": true }, "slotLength": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.TypeStruct" }, "status": { "type": "string", "nullable": true }, "patientList": { "$ref": "#/components/schemas/PartnerApi.EmisOpen.SlotsForSessionV2.PatientListStruct" }, "notes": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "commentList": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PartnerApi.EmisOpen.SlotsForSessionV2.TypeStruct": { "type": "object", "properties": { "typeID": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.Service.Constants.AppointmentStatus": { "enum": [ 2, 3, 4, 12 ], "type": "integer", "format": "int32" }, "PartnerApi.Service.Contracts.Attachment.PfsVisibilityType": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32" }, "PartnerApi.Service.Contracts.Attachment.ProvisionalType": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32" }, "PartnerApi.Service.Contracts.Search.ReportType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PartnerApi.Service.Contracts.UpdateConsultationVisibility.PfsVisibilityType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.Service.Model.Appointment": { "type": "object", "properties": { "sessionId": { "type": "integer", "format": "int64" }, "actionPerformedOn": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PartnerApi.Service.Model.Coding": { "type": "object", "properties": { "system": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "display": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.Service.Model.Details": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "coding": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Coding" } }, "additionalProperties": false }, "PartnerApi.Service.Model.ErrorResponse": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "text": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Text" }, "issue": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Issue" }, "legacyOutcome": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PartnerApi.Service.Model.Issue": { "type": "object", "properties": { "severity": { "$ref": "#/components/schemas/PartnerApi.Service.Model.SeverityType" }, "code": { "type": "string", "nullable": true }, "details": { "$ref": "#/components/schemas/PartnerApi.Service.Model.Details" }, "diagnostics": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartnerApi.Service.Model.SeverityType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PartnerApi.Service.Model.Text": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "div": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "OAuth2CodeEMIS-X-GP-PAPI": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": { "papi-appt.read": "Read Appointments", "papi-appt.write": "Write Appointments", "papi-cr.read": "Read Clinical Record", "papi-cr.write": "Write Clinical Record", "papi-subjects.read": "Read Subjects", "papi-config.read": "Read Config", "papi-searches.read": "Read Searches" } } } } } } }