Skip to content
API Reference
/
/
Get a Patient

Hero Health Public API (1.0.0)

The Hero Health Public API enables healthtech partners to integrate with NHS GP practices connected to EMIS Web and TPP SystmOne.

Key capabilities

  • Patient messaging — Send SMS, email, and NHS App messages on behalf of a practice
  • Appointment booking — List available slots, create reservations, and confirm bookings
  • Patient management — Register and look up patients via PDS (Personal Demographics Service)
  • Webhooks — Subscribe to events such as appointment confirmations and write-to-record outcomes
  • Booking & form links — Generate sharable links for patient self-service flows
  • Elements — Generate access tokens for embedding pre-built Hero UI components

Authentication

All endpoints require an x-api-key and x-practice-group-id header. API keys are scoped to specific functionality (messaging, booking, booking links). Contact Hero support to request your key.

Rate limits

Rate limits are defined in your Partner agreement. If you exceed your limit you will receive a 429 Too Many Requests response.

Download OpenAPI description
Download API docs
Languages
Servers
Mock server
https://developer.herohealth.net/_mock/apis/public-api/openapi/
Staging
https://api.staging.htech.app/
Production
https://api.herohealth.net/

Practice Group

Manage practice group settings, access tokens, and configuration. Use the access token endpoint to generate short-lived JWTs for Hero Elements.

Operations

Patients

Register, search, and manage patient records. Supports PDS (Personal Demographics Service) lookups to trace patients against the NHS Spine.

Operations

Merge Patients

Request

Merge one patient with another

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
merge_tokenstringrequired
patient_idstring^\d+$required
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/merge' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "merge_token": "string",
    "patient_id": "string"
  }'

Responses

Ok

Response
No content

Get a Patient

Request

Retrieve patient information.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
uidstring or null
emis_idstring or null
ehr_partner_idstring or null
dobstring or null(date-time)required
deceased_atstring or null(date-time)
titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
first_namestring or null
last_namestring or null
sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
nhs_numberstring or null
emailstring or null
emailsArray of strings or null
mobilestring or null
last_sync_atstring or null(date-time)
address_line_1string or null
address_line_2string or null
address_line_3string or null
countrystring or null
postcodestring or null
townstring or null
countystring or null
notesstring or null
verification_credentialsArray of strings or null
data_sourcestringrequired
Enum"hero""emis""pds""gha""systm_one"
restrictedboolean
Default false
sex_changed_atstring or null(date-time)
statusstringrequired
Enum"archived""unarchived"
ods_codestring or null
identifiersArray of objectsrequired
identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
identifiers[].​rolestringrequired
Enum"main""secondary"
identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
identifiers[].​valuestringrequired
ehr_registeredboolean or nullrequired
Response
application/json
{
  "id": "string",
  "uid": "string",
  "emis_id": "string",
  "ehr_partner_id": "string",
  "dob": "2019-08-24T14:15:22Z",
  "deceased_at": "2019-08-24T14:15:22Z",
  "title": "Baron",
  "first_name": "string",
  "last_name": "string",
  "sex": "Not known",
  "nhs_number": "string",
  "email": "string",
  "emails": [
    "string"
  ],
  "mobile": "string",
  "last_sync_at": "2019-08-24T14:15:22Z",
  "address_line_1": "string",
  "address_line_2": "string",
  "address_line_3": "string",
  "country": "string",
  "postcode": "string",
  "town": "string",
  "county": "string",
  "notes": "string",
  "verification_credentials": [
    "string"
  ],
  "data_source": "hero",
  "restricted": false,
  "sex_changed_at": "2019-08-24T14:15:22Z",
  "status": "archived",
  "ods_code": "string",
  "identifiers": [
    { … }
  ],
  "ehr_registered": true
}

List Patient EHR Attachments

Request

Retrieves a list of attachments for the patient.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients/{id}/attachments' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
data[].​ehr_partner_file_idstringrequired
data[].​file_namestringrequired
data[].​file_extensionstringrequired
data[].​created_atstring or null(date-time)required
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Messages

Send SMS, email, NHS App, and Hero-only messages to patients. Supports write-to-record to persist messages in the patient's EHR.

Operations

Booking

Create appointment reservations, confirm bookings, cancel, and reschedule. Query available slots filtered by location, practitioner, and appointment type.

Operations

Episode

Manage clinical episodes — containers for related patient interactions and messages.

Operations

Care Navigation

Manage care navigation pathways and patient submissions for triage workflows.

Operations

Prescription

Create and manage prescriptions.

Operations

Prescriptions

List and manage prescriptions.

Operations

WriteToRecord

Check the status of write-to-record operations for messages sent to the EHR.

Operations

Admin

Manage admin users, signatures, and preferences within a practice group.

Operations

ApiKey

List and manage API keys for your practice group.

Operations

Task

Manage tasks assigned to admin users.

Operations

Partner

Retrieve partner information and integrations.

Operations

Partners

Retrieve partner information and integrations.

Operations

Form

List and retrieve forms (questionnaires) configured for a practice group.

Operations

Form Response

Create, retrieve, and update form responses submitted by patients.

Operations

Subscriptions

Manage notification subscriptions and subscribers.

Operations

Webhooks

Subscribe to Hero events (e.g. appointment confirmations, write-to-record outcomes) and receive real-time notifications via HTTP callbacks.

Operations

Invoicing

Manage invoicing customers, products, coupons, and membership schemes.

Operations

Utilities

Utility endpoints for address lookup and SNOMED code validation.

Operations

Booking - HCA

Specialist booking endpoints for HCA (Healthcare Assistant) diary consultants and appointments.

Operations