Skip to content
/Booking - HCA

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

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

Search HCA Consultants

Request

Search for consultants in the HCA system by specified fields.

Security
apiKeyAuth and practiceGroupId
Query
searchstringrequired

The search query string

fieldsArray of stringsrequired

Fields to search within

Items Enum"first_name""last_name""speciality""mnemonic""gmc_number""service"
Example: fields=fields=first_name&fields=last_name
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/consultants?search=string&fields=fields%3Dfirst_name%26fields%3Dlast_name' \
  -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[].​first_namestringrequired
data[].​last_namestringrequired
data[].​specialitystringrequired
data[].​mnemonicstringrequired
data[].​gmc_numberstring^\d{7}$required
data[].​available_to_book_with_onlinebooleanrequired
data[].​servicestringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Get HCA Consultant Details

Request

Retrieves consultant details from the HCA system.

Security
apiKeyAuth and practiceGroupId
Path
gmc_numberstring^\d{7}$required

The GMC number of the consultant

Query
booking_typestringrequired

The type of appointment to be booked

Enum"initial""follow_on"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/consultants/{gmc_number}?booking_type=initial' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
hca_consultant_idstringrequired
crm_idstring(uuid)required
provider_typestringrequired
professional_registration_numberstring^\d{7}$required
provider_main_specialtystringrequired
titlestringrequired
first_namestringrequired
last_namestringrequired
live_diary_booking_availablebooleanrequired
availabilityArray of objectsrequired
availability[].​facility_locationstringrequired
availability[].​facility_crm_idstring(uuid)required
availability[].​facility_full_namestringrequired
availability[].​facility_addressstringrequired
availability[].​latitudestringrequired
availability[].​longitudestringrequired
availability[].​first_appointment_slot_date_timestring(date-time)required
Response
application/json
{
  "hca_consultant_id": "string",
  "crm_id": "a1cca198-42e1-4e72-a0e1-017dec9db0e1",
  "provider_type": "string",
  "professional_registration_number": "string",
  "provider_main_specialty": "string",
  "title": "string",
  "first_name": "string",
  "last_name": "string",
  "live_diary_booking_available": true,
  "availability": [
    { … }
  ]
}

Get HCA Consultant Availability

Request

Retrieves consultant availability from the HCA system.

Security
apiKeyAuth and practiceGroupId
Path
crm_idstring(uuid)required

UUID of the consultant

Query
location_idstring(uuid)required

UUID of the location

date_fromstring(date)required

Start date for availability search

date_tostring(date)required

End date for availability search

booking_typestringrequired

Type of appointment to be booked

Enum"initial""follow_on"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking-hca/consultants/{crm_id}/availability?location_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&date_from=2019-08-24&date_to=2019-08-24&booking_type=initial' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
date_fromstring(date-time)required
date_tostring(date-time)required
slotsArray of objectsrequired
slots[].​start_timestring(date-time)required
slots[].​end_timestring(date-time)required
slots[].​is_blockedbooleanrequired
Response
application/json
{
  "date_from": "2019-08-24T14:15:22Z",
  "date_to": "2019-08-24T14:15:22Z",
  "slots": [
    { … }
  ]
}