EMIS Partner API FileRecord

API Platform
, , , ,
1

I want to edit a consultation using the Partner API. According to the documentation, we need to change the FileStatus to 1 to enable editing. However, this approach is not working. Can anyone guide me on how to proceed?

2

Hi Ali,

Thank you for getting in touch with NHS England API Platform team.

Editing an existing consultation in the EMIS Partner API can sometimes be complicated. Although setting FileStatus to 1 is documented as a way to enable editing, there are a few additional steps you may need to check:

  1. Confirm you have the correct Record Type and Permissions
  • Make sure you are working with the correct FileRecord type. Sometimes “File” in the context of EMIS may refer to other clinical objects, so confirm you have the right record and endpoint.
  • Ensure the user or role under which you are calling the Partner API has the necessary write/edit permissions to modify existing consultations.
  1. Retrieve the Latest Version of the Record First
  • Often, you must retrieve the most up-to-date consultation record from EMIS, then update its FileStatus and relevant fields, and finally send it back. If your local copy of the consultation is outdated or missing required fields, EMIS can reject your edit request.
  • Check that you are not inadvertently overwriting or omitting mandatory data fields in your update payload.
  1. Double-Check EMIS API Methods and Field Requirements
  • Depending on your EMIS Partner API version, there may be a specific “Amend” or “Update” operation for consultation records (sometimes separate from simply manipulating FileStatus). Also review the Partner API documentation to confirm if additional flags or fields must be set to mark a record as editable. For example, some workflows require setting a “complete” status to false, or toggling a specific field that indicates the consultation is “open” for edits.
  1. Look for Error Messages or Logging Information
  • When your request fails, see if the Partner API returns any HTTP status codes or error messages. Sometimes you’ll receive a generic error that indicates invalid data or insufficient access rights.
  • If you have an integration log or an audit trail, check what’s being rejected by EMIS.
  1. Confirm the sequence for updating a Consultation
  • EMIS typically expects a particular sequence to ensure data consistency:
    1. Retrieve the record.
    2. Set the record to a status that allows editing (and update other fields as needed).
    3. Resend it with the required changes.
  • If any step in that chain is missed or if the record is locked by another user/process, the FileStatus change alone might fail.
  1. Check for additional business rules
  • Some practices or organisations use custom settings, forms, or templates that can limit editing after certain conditions are met (e.g., after sign-off by a clinician or after the record is “finalised”). Also investigate and rule out and local configuration issues.
  1. Contact EMIS Support or Consult the Partner API Forum
  • If you have tried the above steps and still can’t edit the consultation, EMIS Partner Support may be able to offer more specific guidance. Provide them with detailed logs, the exact endpoints and payload you are using, and any API error responses you receive.

Hope the above helps.

Thanks,

NHS England API Platform team

Please note: The API Platform team can only address queries relevant to the NHS England API platform, including security, rate limiting, logging, monitoring and alerting. For any API specific queries, please reach out the relevant API teams.