Guide

Integration Request

Before you complete this form

You must have read the developer documentation in full. Requests submitted without a clear understanding of our APIs will not be progressed.

Complete this form to apply for integration access. All responses are subject to review by Medicus Health. Approval is not guaranteed. If your integration goes through the NHS IM1 programme, contact the IM1 team directly.

Fields marked *with an asterisk are required.

Organisation

Organisation name *

Website URL

Completed by *

Role *

Contact email *

Date *

Integration Overview

Integration type *

Transactional APIREST API, real-timeBulk data extractScheduled CSV exportsBothTransactional and bulk

First of Type customer *

Only integrations with a named First of Type customer can be progressed.

Use case description *

Describe what you are building and how it will interact with patient data.

Transactional API

Access model *

Application-restricted means your server calls Medicus directly. User-restricted means calls are made on behalf of a logged-in Medicus user.

Application-restrictedServer-to-serverUser-restrictedOn behalf of a userBothBoth models

Application identifier *

A unique kebab-case identifier for your application, e.g. my-partner-app.

JWKS URL *

The public URL of your JSON Web Key Set, used to verify request signatures.

Application description *

Shown to GP practice admins in Medicus when they decide whether to enable your integration. Write for a clinical audience, not a technical one.

Endpoints required *

Select only the endpoints your integration genuinely needs.

Core (IM1)

Find patientMatch patientGet patient demographicsRetrieve care recordList documentsRetrieve documentCreate encounterCreate noteCreate observationCreate documentCreate outbound referralList sitesList available slotsBook appointmentGet appointment metadataList called-in appointmentsMark patient as arrivedCancel appointmentList staffTerminology versionsGet organisation detailsWebhooks

Front Door

Find appointments for check-inCreate appointment booking linkCreate patient requestCaller ID lookup

Workflow

Retrieve confidential care recordList unfiled investigation reportsGet investigation reportList unfulfilled investigation requestsFile investigation report

Resource Publishing

All resource publishing endpoints

Staging Access

Developer email addresses

Email addresses for team members who need access to the Medicus Staging environment.