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 documentList prescriptionsCreate 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 recordCreate patient contactRegister permanent NHS patientRegister permanent patient without NHS numberUpdate EPS nominated pharmacyUpdate Summary Care Record consentUpdate patient official nameUpdate patient preferred nameUpdate patient addressUpdate patient telephone numberUpdate patient email addressList collection locationsList unfiled investigation reportsGet investigation reportList unfulfilled investigation requestsFile investigation report

Resource Publishing

All resource publishing endpointsList communication templates, Get communication template version, Create communication template, Create communication template version, Update communication template version, Delete communication template version, Publish communication template version, Archive communication template, Create data entry template, Create data entry template version, Update data entry template version, Delete data entry template version, Publish data entry template version, Archive data entry template, Create document template, Create document template version, Update document template version, Delete document template version, Publish document template version, Archive document template, Create patient questionnaire template, Create patient questionnaire template version, Update patient questionnaire template version, Delete patient questionnaire template version, Publish patient questionnaire template version, Archive patient questionnaire template, Create future action rule, Create future action rule version, Update future action rule version, Delete future action rule version, Publish future action rule version, Archive future action rule, Create custom dashboard, Create custom dashboard version, Update custom dashboard version, Delete custom dashboard version, Publish custom dashboard version, Archive custom dashboard, List content packages, Get content package, Create content package, Update content package, Set content package items, Publish content package, Archive content package, List future action rules, Get future action rule version, List patient questionnaire templates, Get patient questionnaire template version, List data entry templates, Get data entry template version, List document templates, Get document template version, List custom dashboards, Get custom dashboard version, Generate report launch URL

Audit

List patient audit eventsGet audit event

Research

List research studiesList research study participantsList research study linked records

Inbound Referrals & Case Management

Create patient recordGet inbound referral metadataCreate inbound referral

Staging Access

Developer email addresses

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