Skip to main content
Guide

Onboarding & Assurance

How to get approved and go live with a Medicus integration.

NHS IM1 programme

If your integration goes through the NHS IM1 programme, contact the IM1 team directly. Medicus does not manage IM1 assurance. See the NHS IM1 pairing integration page.

All integrations​

All direct integrations start with the same steps:

  1. Complete the integration request form and submit it to partners@medicus.health.
  2. If your request is approved, we share a partner agreement to sign.

From there, the process varies by integration type.

Transactional API​

  1. We add you to the Staging environment and configure your application. You provide a JWKS URL (see Authentication).
  2. Develop and test your integration against Staging.
  3. Submit assurance evidence:
    • the DDQ template (download below), and
    • demonstration videos of each interaction, covering both the happy and unhappy paths.
  4. Conduct a First of Type controlled pilot with an initial practice.
  5. Release to general availability across practices.
Download Transactional API DDQ (.docx)

Bulk Data Extracts​

  1. We add you to the Staging environment and set up a test extract to develop against. You provide your MESH mailbox or SFTP server details.
  2. Develop and test your integration.
  3. Submit the DDQ template (download below).
  4. Conduct a First of Type controlled pilot with an initial practice.
  5. Release to general availability across practices.
Download Bulk Data Extracts DDQ (.docx)

Once you're live, reach out to partners@medicus.health for any ongoing support.