openapi: 3.2.0 info: title: Partner Medical Record API version: '1.2' tags: - name: medicalRecord paths: /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 /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 /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 /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 /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 /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 /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. Information is returned for the specified time period counting back from the current day, in **whole days**. This function executes significantly faster than `getMedicalRecord`, particularly for patients with large records. The returned XML will contain the following elements: - `EventList` - `PeopleList` Note: It does **not** contain **Medication** information. The 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 /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 /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 /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 /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 /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 components: schemas: PartnerApi.EmisOpen.MedicalRecord38.PersonTypeScripts: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeDead: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagingError: type: object properties: errorString: type: - string - 'null' errornumber: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypePregnant: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.StringCodeType: type: object properties: value: type: - string - 'null' scheme: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeTypeScheme' schemeSpecified: type: boolean term: type: - string - 'null' oldCode: type: - string - 'null' mapCode: type: - string - 'null' mapScheme: type: - string - 'null' 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.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.OriginatorTypeSystem: type: object properties: name: type: - string - 'null' version: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PathologyTestType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' reportID: type: - string - 'null' specimenID: type: - string - 'null' displayTerm: type: - string - 'null' 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 - 'null' abnormalIndicator: type: - string - 'null' ediResultStatus: type: - string - 'null' labSpecifiedCommentList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment' rangeInformationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyTestTypeRangeInformation' filedCode: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' testNumber: type: - string - 'null' additionalProperties: false 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.PolicyListTypePolicyType: type: object properties: dbid: type: - string - 'null' refId: type: - string - 'null' guid: type: - string - 'null' term: type: - string - 'null' fileStatus: type: - string - 'null' userList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeRequestType: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType: type: object properties: value: type: - string - 'null' scheme: type: - string - 'null' term: type: - string - 'null' oldCode: type: - string - 'null' mapCode: type: - string - 'null' mapScheme: type: - string - 'null' interventionTarget: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.AppointmentTypeSite: type: object properties: id: type: - string - 'null' name: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusType: type: object properties: currentStatus: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusTypeCurrentStatus' statusHistoryList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StatusType' registrationHistoryList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationHistoryType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.RoleType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' 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.EDIOrderTypeOrderCategory: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.NumericValueType: type: object properties: operator: type: - string - 'null' value: type: number format: double valueSpecified: type: boolean units: type: - string - 'null' minRangeOperator: type: - string - 'null' maximumRangeOperator: type: - string - 'null' numericMinimum: type: number format: double numericMinimumSpecified: type: boolean numericMaximum: type: number format: double numericMaximumSpecified: type: boolean additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.ReferralType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' 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 - 'null' 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 - 'null' sourceType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' direction: type: - string - 'null' 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 - 'null' 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 - 'null' sourceSpeciality: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' referralMode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' mnemonic: type: - string - 'null' description: type: - string - 'null' purpose: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryTypePurpose' purposeSpecified: type: boolean additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.EDIOrderType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' 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 - 'null' testRequestList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' authorisedUserID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' assignedDate: type: - string - 'null' dateLastIssue: type: - string - 'null' issueMethod: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod' issueMethodSpecified: type: boolean dateRxExpire: type: - string - 'null' doseAbbreviation: type: - string - 'null' dosage: type: - string - 'null' quantity: type: number format: float quantitySpecified: type: boolean quantityUnits: type: - string - 'null' quantityRepresentation: type: - string - 'null' duration: type: - string - 'null' mixtureIndicator: type: - string - 'null' drug: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeDrug' prescriptionType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType' prescriptionTypeSpecified: type: boolean drugSource: type: - string - 'null' rxReviewDate: type: - string - 'null' pharmacyText: type: - string - 'null' rxText: type: - string - 'null' authorisedIssue: type: - string - 'null' issueCount: type: - string - 'null' status: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus' statusSpecified: type: boolean advice: type: - string - 'null' template: type: - string - 'null' templateComponent: type: - string - 'null' templateInstance: type: - string - 'null' drugDelivery: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType' controlledDrug: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' serviceType: type: - string - 'null' dispensingInterval: type: - string - 'null' repeatIssueCount: type: - string - 'null' repeatInterval: type: - string - 'null' etpIssue: type: - string - 'null' contraceptiveIssue: type: - string - 'null' policyId: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeInnoculationRisk: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.EDIComment: type: object properties: ftx: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeNHS: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.IdentType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' 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 - 'null' 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 - 'null' parentProblem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' owner: type: integer format: int32 ownerSpecified: type: boolean careAimList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.CareAimType' carePlanList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.CarePlanType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeTransport: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.AllergyType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' 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 - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.IssueType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' authorisedUserID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' assignedDate: type: - string - 'null' dateLastIssue: type: - string - 'null' issueMethod: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod' issueMethodSpecified: type: boolean dateRxExpire: type: - string - 'null' doseAbbreviation: type: - string - 'null' dosage: type: - string - 'null' quantity: type: number format: float quantitySpecified: type: boolean quantityUnits: type: - string - 'null' quantityRepresentation: type: - string - 'null' duration: type: - string - 'null' mixtureIndicator: type: - string - 'null' drug: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeDrug' prescriptionType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType' prescriptionTypeSpecified: type: boolean drugSource: type: - string - 'null' rxReviewDate: type: - string - 'null' pharmacyText: type: - string - 'null' rxText: type: - string - 'null' authorisedIssue: type: - string - 'null' issueCount: type: - string - 'null' status: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus' statusSpecified: type: boolean advice: type: - string - 'null' template: type: - string - 'null' templateComponent: type: - string - 'null' templateInstance: type: - string - 'null' drugDelivery: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType' controlledDrug: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' serviceType: type: - string - 'null' dispensingInterval: type: - string - 'null' repeatIssueCount: type: - string - 'null' repeatInterval: type: - string - 'null' etpIssue: type: - string - 'null' contraceptiveIssue: type: - string - 'null' policyId: type: - string - 'null' estimatedCost: type: number format: double estimatedCostSpecified: type: boolean comment: type: - string - 'null' issuerID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' dateTimePrint: type: - string - 'null' dateTimeDispense: type: - string - 'null' dispenserID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' batchNumber: type: - string - 'null' medicationLink: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationLinkType' additionalProperties: false PartnerApi.Service.Contracts.UpdateConsultationVisibility.PfsVisibilityType: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.NoteType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' time: type: - string - 'null' urgency: type: - string - 'null' ownerID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' actionBefore: type: - string - 'null' noteCode: type: - string - 'null' status: type: - string - 'null' noteText: type: - string - 'null' dataType: type: - string - 'null' reportID: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetails: type: object properties: senderEDICode: type: - string - 'null' receiverEDICode: type: - string - 'null' interChange: type: - string - 'null' messageID: type: - string - 'null' messageType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetailsMessageType' messageTypeSpecified: type: boolean additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.EventType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' groupID: type: - string - 'null' episodicity: type: integer format: int32 episodicitySpecified: type: boolean numericValue: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.NumericValueType' textValue: {} abnormal: type: - string - 'null' gms: type: - string - 'null' eventType1: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EventTypeEventType' eventType1Specified: type: boolean templateID: type: - string - 'null' templateInstanceID: type: - string - 'null' templateComponentName: type: - string - 'null' qualifiedTerm: type: - string - 'null' qualifiedCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeNHS: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.StructuredIdentType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' item: {} itemElementName: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType' additionalProperties: false PartnerApi.EmisOpen.Base64AttachmentDataV2.root: type: object properties: filedata: type: - string - 'null' filename: type: - string - 'null' patientNHS: type: - string - 'null' organisationNACS: type: - string - 'null' additionalProperties: false 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.Service.Contracts.Attachment.PfsVisibilityType: enum: - 0 - 1 - -1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.DiaryType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' templateID: type: - string - 'null' templateInstanceID: type: - string - 'null' templateComponentName: type: - string - 'null' durationTerm: type: - string - 'null' reminder: type: - string - 'null' reminderType: type: - string - 'null' locationTypeID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.ControlledDrugInfoType: type: object properties: dduBatch: type: - string - 'null' dduPrinted: type: - string - 'null' dduCollect: type: - string - 'null' dduNextDate: type: - string - 'null' dduReduceBy: type: - string - 'null' dduAfter: type: - string - 'null' dduUntil: type: - string - 'null' dduNextDose: type: - string - 'null' dduOffset: type: - string - 'null' dduClWorker: type: - string - 'null' dduPickUp: type: - string - 'null' dduDoseAbbrev: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeCommunity: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.ApplicationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' applicationMnemonic: type: - string - 'null' applicationName: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonTypeLocum: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.ReferralTypeUrgency: enum: - 0 - 1 - 2 - 3 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.RegistrationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' dateOfBirth: type: - string - 'null' sex: type: - string - 'null' previousNames: type: - string - 'null' familyName: type: - string - 'null' callingName: type: - string - 'null' firstNames: type: - string - 'null' title: type: - string - 'null' nhsNumber: type: - string - 'null' address: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType' homeTelephone: type: - string - 'null' organisationNACS: type: - string - 'null' 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 - 'null' dispensing: type: - string - 'null' ruralMileage: type: - string - 'null' difficultQuarters: type: - string - 'null' residentialInstitute: type: - string - 'null' blockedSpecial: type: - string - 'null' recordsAt: type: - string - 'null' hospitalNumbers: type: - string - 'null' deductedDate: type: - string - 'null' dateOfDeath: type: - string - 'null' dead: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeDead' deadSpecified: type: boolean dateAdded: type: - string - 'null' oldNhsNumber: type: - string - 'null' workTelephone: type: - string - 'null' mobile: type: - string - 'null' email: type: - string - 'null' homeAddress: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType' homeGP: type: - string - 'null' homeGPCode: type: - string - 'null' chiNumber: type: - string - 'null' footpathMiles: type: - string - 'null' waterMiles: type: - string - 'null' serviceType: type: - string - 'null' serviceNumber: type: - string - 'null' customRegistrationFields: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeCustomRegistrationEntry' groNumber: type: - string - 'null' upciNumber: type: - string - 'null' maritalStatus: type: - string - 'null' medicationReviewDate: type: - string - 'null' exemptionExpiry: type: - string - 'null' screenMessage: type: - string - 'null' reminderSent: type: - string - 'null' ethnicCode: type: - string - 'null' prisonNumber: type: - string - 'null' previousPrisonNumbers: type: - string - 'null' prisonDoctorGP: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' socialSecurityNumber: type: - string - 'null' policyId: type: - string - 'null' archived: type: - string - 'null' scn: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonTypeDoctor: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PathologySpecimenType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' reportID: type: - string - 'null' specimenID: type: - string - 'null' specimenType: type: - string - 'null' fastingStatus: type: - string - 'null' specimenVolume: type: number format: float specimenVolumeSpecified: type: boolean specimenUnits: type: - string - 'null' collectionProcedure: type: - string - 'null' anotomicalOrigin: type: - string - 'null' specimenTextList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment' sampleDateTime: type: - string - 'null' collectionStartDate: type: - string - 'null' collectionEndDate: type: - string - 'null' receivedByLabDateTime: type: - string - 'null' ediInvestigationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyInvestigationType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.CarePlanType: type: object properties: pkId: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' displayTerm: type: - string - 'null' termId: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' notes: type: - string - 'null' 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.MedicationTypeDrug: type: object properties: item: {} additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordType: type: object properties: registration: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationType' registrationChangeHistory: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeRegistrationEntry' miscellaneousData: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMiscellaneousData' eventList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EventType' consultationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ConsultationType' investigationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.InvestigationType' referralList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ReferralType' allergyList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AllergyType' medicationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicationType' issueList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IssueType' attachmentList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AttachmentType' diaryList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.DiaryType' alertList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AlertType' registrationStatus: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusType' ediPathologyReportList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyReportType' testRequestHeaderList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderType' noteList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.NoteType' appointmentList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AppointmentType' peopleList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonType' locationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LocationType' locationTypeList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TypeOfLocationType' 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 - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PolicyListTypePolicyType' patientID: type: - string - 'null' 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.AppointmentType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' sessionHolder: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' locationID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' assignedDate: type: - string - 'null' time: type: - string - 'null' site: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AppointmentTypeSite' sessionID: type: - string - 'null' reason: type: - string - 'null' duration: type: number format: float durationSpecified: type: boolean rub: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicationLinkType: type: object properties: guid: type: - string - 'null' preparationID: type: - string - 'null' systemDate: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.CareAimType: type: object properties: pkId: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' goal: type: - string - 'null' targetDate: type: string format: date-time targetDateSpecified: type: boolean expectedValue: type: - string - 'null' actualValue: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonTypeConsulter: enum: - 0 - 1 - 2 - 3 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.StringCodeTypeScheme: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.AddressType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' houseNameFlat: type: - string - 'null' street: type: - string - 'null' village: type: - string - 'null' town: type: - string - 'null' county: type: - string - 'null' postCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeFasted: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagePurpose: type: object properties: item: {} additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeOriginalMessageDetailsMessageType: enum: - 0 - 1 - 2 - 3 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PersonTypeTwentyFourHour: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.ConsultationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean userID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' externalConsultant: type: - string - 'null' 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 - 'null' travelTime: type: - string - 'null' appointmentSlotID: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' elementList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ElementListTypeConsultationElement' pfsVisible: type: boolean pfsVisibleSpecified: type: boolean additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' reference: type: - string - 'null' requestHeaderID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' specimenType: type: - string - 'null' specimenTypeCode: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' collectionDate: type: - string - 'null' status: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestTypeStatus' statusSpecified: type: boolean lastStatusDate: type: - string - 'null' resultsRef: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' investigationRef: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' resultsDate: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContraceptive: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.LocationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' locationName: type: - string - 'null' nationalCode: type: - string - 'null' locationTypeID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' address: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AddressType' telephone1: type: - string - 'null' telephone2: type: - string - 'null' fax: type: - string - 'null' email: type: - string - 'null' contact: type: - string - 'null' cypher: type: - string - 'null' interchange: type: - string - 'null' linkCode: type: - string - 'null' seniorPartner: type: - string - 'null' pcgCode: type: - string - 'null' pctCode: type: - string - 'null' gpLinkCodeList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LocationTypeGPLinkCode' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeStatus: enum: - 0 - 1 - 2 - 3 - 4 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PersonTypeChildSurveillance: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.RegistrationHistoryType: type: object properties: dateRegistered: type: - string - 'null' dateDeregistered: type: - string - 'null' patientType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.AttachmentType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' title: type: - string - 'null' address: type: - string - 'null' version: type: - string - 'null' ddsIdentifier: type: - string - 'null' attachmentData: type: - string - 'null' 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 - 'null' additionalProperties: false PartnerApi.Service.Model.Details: type: object properties: text: type: - string - 'null' coding: $ref: '#/components/schemas/PartnerApi.Service.Model.Coding' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMiscellaneousData: type: object properties: medicationMessage: type: - string - 'null' automaticWeekNumber: type: - string - 'null' additionalProperties: false PartnerApi.Service.Model.SeverityType: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PersonTypeContractualRelationship: enum: - 0 - 1 - 2 - 3 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PathologyReportType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' reportDataType: type: - string - 'null' reportID: type: - string - 'null' reportReceivedDateTime: type: - string - 'null' reportIssueDateTime: type: - string - 'null' reportTextList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment' abnormal: type: - string - 'null' recordFileStatus: type: - string - 'null' consultationRef: type: - string - 'null' box: type: - string - 'null' requestID: type: - string - 'null' requestDateTime: type: - string - 'null' 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 - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment' viewedBy: {} trueReportID: {} specimenList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologySpecimenType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.DrugDeliveryType: type: object properties: doseQuantity: type: number format: float doseQuantitySpecified: type: boolean doseUnits: type: - string - 'null' frequency: type: - string - 'null' frequencyUnits: type: - string - 'null' dailyDose: type: number format: float dailyDoseSpecified: type: boolean dailyDoseUnits: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.RegistrationTypeCustomRegistrationEntry: type: object properties: fieldName: type: - string - 'null' fieldValue: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' mnemonic: type: - string - 'null' pcsUser: type: - string - 'null' activeEMISUser: type: - string - 'null' title: type: - string - 'null' firstNames: type: - string - 'null' lastName: type: - string - 'null' category: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryType' nationalCode: type: - string - 'null' prescriptionCode: type: - string - 'null' gmcCode: type: - string - 'null' ukccCode: type: - string - 'null' 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 - 'null' contractEnd: type: - string - 'null' 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 - 'null' 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 - 'null' telephone2: type: - string - 'null' fax: type: - string - 'null' email: type: - string - 'null' role: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.RoleType' security1: type: - string - 'null' security2: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeStatus: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.MedicationTypeIssueMethod: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformation: type: object properties: dateCreated: type: - string - 'null' timeCreated: type: - string - 'null' messagePurpose: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagePurpose' messagingError: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeMessageInformationMessagingError' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicalRecordTypeRegistrationEntry: type: object properties: fieldName: type: - string - 'null' fieldValue: type: - string - 'null' dateChanged: type: - string - 'null' userID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' 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.Service.Model.Coding: type: object properties: system: type: - string - 'null' code: type: - string - 'null' display: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.RegistrationStatusTypeCurrentStatus: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType' statusDate: type: - string - 'null' patientType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType' practiceRegistered: type: - string - 'null' haRegistered: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PathologyTestTypeRangeInformation: type: object properties: minRange: type: - string - 'null' maxRange: type: - string - 'null' rangeFTXList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment' rangeQualifier: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.MedicationTypePrescriptionType: enum: - 0 - 1 - 2 - 3 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.ItemChoiceType1: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.LinkTypeLinkType: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.InvestigationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' displayTerm: type: - string - 'null' dataSource: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' abnormal: type: - string - 'null' dataType: {} reportID: type: - string - 'null' specimenID: type: - string - 'null' specimenType: type: - string - 'null' numberOfTests: type: - string - 'null' repInvNumber: type: - string - 'null' userComment: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' descriptiveText: type: - string - 'null' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' policyID: type: - string - 'null' eventList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EventType' 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.EmisOpen.Base64AttachmentData.root: type: object properties: filedata: type: - string - 'null' filename: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.LocationTypeGPLinkCode: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' linkCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' requestor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' consultationID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' dateCreated: type: - string - 'null' dateForTest: type: - string - 'null' dateLastXRay: type: - string - 'null' status: {} lastStatusDate: type: - string - 'null' copyTo: type: - string - 'null' nhs: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypeNHS' nhsSpecified: type: boolean priority: type: - string - 'null' 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 - 'null' clinicalInformation: type: - string - 'null' pregnant: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.TestRequestHeaderTypePregnant' pregnantSpecified: type: boolean ediOrderList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIOrderType' additionalProperties: false PartnerApi.Service.Contracts.Attachment.ProvisionalType: enum: - 0 - 1 - -1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PersonTypeRegistrar: enum: - 0 - 1 type: integer format: int32 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.AlertType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' assignedDate: type: - string - 'null' datePart: type: integer format: int32 datePartSpecified: type: boolean assignedTime: type: - string - 'null' sequence: type: - string - 'null' authorID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IdentType' originalAuthor: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.AuthorType' externalConsultant: type: - string - 'null' displayTerm: type: - string - 'null' descriptiveText: type: - string - 'null' dataSource: type: - string - 'null' policyID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' qualifierList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.QualifierType' problem: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.ProblemType' problemLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' referralLinkList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.LinkType' book: type: - string - 'null' ariveSwap: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonCategoryTypePurpose: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.EDIOrderTypeFormDestination: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' description: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PathologyInvestigationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' displayTerm: type: - string - 'null' dataSource: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' termID: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' abnormal: type: - string - 'null' dataType: {} reportID: type: - string - 'null' specimenID: type: - string - 'null' specimenType: type: - string - 'null' numberOfTests: type: - string - 'null' repInvNumber: type: - string - 'null' userComment: type: - string - 'null' userCommentAppliedBy: type: - string - 'null' labSpecifiedCommentList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.EDIComment' ediResultStatus: type: - string - 'null' investigationPerformedDateTime: type: - string - 'null' filedCode: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.StringCodeType' invContainsStandAloneTest: type: - string - 'null' pathologyEventList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.PathologyTestType' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PersonTypeMinorSurgery: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersMatchedDetails: type: object properties: forename: type: - string - 'null' lastName: type: - string - 'null' dateOfBirth: type: - string - 'null' nhs: type: - string - 'null' patientID: type: - string - 'null' sex: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TestRequestTypeStatus: enum: - 0 - 1 - 2 - 3 - 4 type: integer format: int32 PartnerApi.EmisOpen.MedicalRecord38.ElementListTypeConsultationElement: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' 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.Service.Model.Issue: type: object properties: severity: $ref: '#/components/schemas/PartnerApi.Service.Model.SeverityType' code: type: - string - 'null' details: $ref: '#/components/schemas/PartnerApi.Service.Model.Details' diagnostics: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.PathologyReportTypeIdentifiersOriginalDetails: type: object properties: forename: type: - string - 'null' lastName: type: - string - 'null' dateOfBirth: type: - string - 'null' nhs: type: - string - 'null' address: type: - string - 'null' sex: type: - string - 'null' labSubjectID: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.TypeOfLocationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' description: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.MedicalRecord38.StatusType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' oldGUID: type: - string - 'null' code: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType' statusDate: type: - string - 'null' patientType: $ref: '#/components/schemas/PartnerApi.EmisOpen.MedicalRecord38.IntegerCodeType' additionalProperties: false PartnerApi.Service.Model.Text: type: object properties: status: type: - string - 'null' div: type: - string - 'null' 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