Skip to content
API Docs/
API Reference
/
/
List Patients (v3)

Hero Health Public API (1.0.0)

The Hero Health Public API enables healthtech partners to build products that leverage Hero Health's IM1-assured EMIS/TPP integrated functionality.

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

List Patients (v2)

Request

Retrieves a list of all patients, from either the EHR or HERO. The verified_email and verified_phone fields search against verified portal credentials (Hero DB only).

Security
apiKeyAuth and practiceGroupId
Query
fieldstring
Enum"ehr_partner_id""nhs_number""dob""verified_email""verified_phone"
searchstring
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/patients?field=ehr_partner_id&search=string' \
  -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_idstring or null
data[].​emis_idstring or null
data[].​deceased_atstring or null(date-time)
data[].​ods_codestring or null
data[].​dobstring or null(date-time)required

ISO 8601 date format

Example: "1989-04-11"
data[].​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
data[].​first_namestring or null
data[].​last_namestring or null
data[].​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
data[].​nhs_numberstring or null
data[].​emailstring or null
data[].​mobilestring or null
data[].​last_sync_atstring or null(date-time)
data[].​data_sourcestring or null
Enum"hero""emis""pds""gha""systm_one"
data[].​restrictedboolean
Default false
data[].​line_1string or null
data[].​line_2string or null
data[].​line_3string or null
data[].​townstring or null
data[].​countystring or null
data[].​postcodestring or null
data[].​hero_idstring or null^\d+$
data[].​hero_uidstring or null
data[].​identifiersArray of objectsrequired
data[].​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
data[].​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
data[].​identifiers[].​rolestringrequired
Enum"main""secondary"
data[].​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
data[].​identifiers[].​valuestringrequired
data[].​ehr_registeredboolean or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

List Patients (v3)

Request

Retrieve a list of patients for the practice group using explicit patient filters.

This endpoint is intended for structured patient search flows where partners can provide named filters such as first_name, last_name, dob, nhs_number, or ehr_partner_id.

Compared with the v2 patients endpoint, v3 supports multi-field search in a single request instead of the older field + search format.

At least one filter must be supplied.

Security
apiKeyAuth and practiceGroupId
Query
page_indexstring

Zero-based page index for paginated results.

page_sizestring

Number of results to return per page.

first_namestring

Filter by patient first name.

last_namestring

Filter by patient last name.

dobstring

Filter by exact date of birth in YYYY-MM-DD format.

Example: dob=1990-12-31
nhs_numberstring

Filter by NHS number.

ehr_partner_idstring

Filter by the patient identifier used by the connected EHR.

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v3/patients?page_index=string&page_size=string&first_name=string&last_name=string&dob=1990-12-31&nhs_number=string&ehr_partner_id=string' \
  -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_idstring or null
data[].​emis_idstring or null
data[].​deceased_atstring or null(date-time)
data[].​ods_codestring or null
data[].​dobstring or null(date-time)required

ISO 8601 date format

Example: "1989-04-11"
data[].​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
data[].​first_namestring or null
data[].​last_namestring or null
data[].​sexstring or null
Enum"Not known""Not specified""Male""Female""Other"
data[].​nhs_numberstring or null
data[].​emailstring or null
data[].​mobilestring or null
data[].​last_sync_atstring or null(date-time)
data[].​data_sourcestring or null
Enum"hero""emis""pds""gha""systm_one"
data[].​restrictedboolean
Default false
data[].​line_1string or null
data[].​line_2string or null
data[].​line_3string or null
data[].​townstring or null
data[].​countystring or null
data[].​postcodestring or null
data[].​hero_idstring or null^\d+$
data[].​hero_uidstring or null
data[].​identifiersArray of objectsrequired
data[].​identifiers[].​sourcestringrequired
Enum"nhs""gha""ehr_partner""hero"
data[].​identifiers[].​namestringrequired
Enum"nhs_number""gha_number""ehr_partner_id""hero_id""hero_uid"
data[].​identifiers[].​rolestringrequired
Enum"main""secondary"
data[].​identifiers[].​labelstringrequired
Enum"NHS""GHA""EMIS""Hero""Systm One"
data[].​identifiers[].​valuestringrequired
data[].​ehr_registeredboolean or nullrequired
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.

Task

Manage tasks assigned to admin users.

Operations

Partner

Retrieve partner information and integrations.

Operations

Partners

Retrieve partner information and integrations.

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.

Booking - HCA

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

Operations