Skip to content
API Reference
/
/
Get Pathway

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

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

List Pathways

Request

Retrieves a list of pathways for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
Query
has_formsboolean
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/pathways?has_forms=true' \
  -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[].​idstringrequired
data[].​titlestringrequired
data[].​summarystring or nullrequired
data[].​in_hoursboolean or nullrequired
data[].​out_of_hoursboolean or nullrequired
data[].​suspendedboolean or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Get Pathway

Request

Retrieves a pathway.

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

Responses

Ok

Bodyapplication/json
idstringrequired
titlestringrequired
summarystring or nullrequired
in_hoursboolean or nullrequired
out_of_hoursboolean or nullrequired
suspendedboolean or nullrequired
Response
application/json
{
  "id": "string",
  "title": "string",
  "summary": "string",
  "in_hours": true,
  "out_of_hours": true,
  "suspended": true
}

Get Care Navigation Submission

Request

Get a care navigation submission and its fields.

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

Responses

Ok

Bodyapplication/json
idstringrequired
created_atstring(date-time)required
titlestringrequired
write_to_recordobject or null
typestring or null
Enum"Admin request""Clinical request""Other request"
descriptionstringrequired
patient_titlestring or nullrequired
patient_descriptionstring or nullrequired
fieldsArray of objectsrequired
fields[].​form_question_idstringrequired
fields[].​namestringrequired
fields[].​typestringrequired
Enum"string""integer""boolean""datepicker""text""radio""dropdown""checkboxes""consent""paragraph"
fields[].​observation_namestring
Enum"systolic_blood_pressure""diastolic_blood_pressure""height""weight""body_mass_index"
fields[].​problem_namestring
Enum"asthmatic""type_2_diabetes_mellitus""heart_disease""essential_hypertension""copd""atrial_fibrillation""cerebrovascular_accident""type_1_diabetes""ischaemic_heart_disease""rheumatoid_arthritis"
fields[].​immunisation_namestring
Enum"administration_of_men_a_c_w135_and_y_vaccine""first_measles_mumps_and_rubella_vaccination_first_mmr""second_measles_mumps_and_rubella_vaccination_second_mmr"
fields[].​hintstring or null
fields[].​optionalbooleanrequired
fields[].​textstring or null
fields[].​snomed_codestring or null
fields[].​optionsArray of objects or null
fields[].​validationobject or null
fields[].​conditionsobject or null
fields[].​defaultValuestring or number or boolean or Array of strings or (string or null) or null
One of:
string
fields[].​attachment_urlstring
patient_idstring
appointment_idnumber or nullrequired
Response
application/json
{
  "id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "title": "string",
  "write_to_record": {
    "write_to_record_at": "2019-08-24T14:15:22Z",
    "status": "string",
    "failure_reason": "string"
  },
  "type": "Admin request",
  "description": "string",
  "patient_title": "string",
  "patient_description": "string",
  "fields": [
    { … }
  ],
  "patient_id": "string",
  "appointment_id": 0
}

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