Skip to content
API Reference
/
/
Create Prescription with...

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

Prescription

Create and manage prescriptions.

Operations

Get a Prescription

Request

Retrieve details of a specific prescription by its ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired

The ID of the prescription to retrieve.

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/prescriptions/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
external_prescription_idstringrequired
statusstringrequired
signed_atstring or null(date-time)required
notesstring or nullrequired
medicinesArray of objectsrequired
medicines[].​quantitystringrequired
medicines[].​namestringrequired
medicines[].​directionsstringrequired
patientobject or nullrequired
patient.​idstringrequired
patient.​first_namestring or nullrequired
patient.​last_namestring or nullrequired
prescriberobject or nullrequired
prescriber.​idstringrequired
prescriber.​namestringrequired
prescriber.​emailstring(email)required
Response
application/json
{
  "id": "string",
  "external_prescription_id": "string",
  "status": "string",
  "signed_at": "2019-08-24T14:15:22Z",
  "notes": "string",
  "medicines": [
    { … }
  ],
  "patient": {
    "id": "string",
    "first_name": "string",
    "last_name": "string"
  },
  "prescriber": {
    "id": "string",
    "name": "string",
    "email": "user@example.com"
  }
}

Create Prescription with Patient

Request

Creates a new prescription and associates it with a patient.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
patientobjectrequired
patient.​idstring^\d+$required
patient.​first_namestringrequired
patient.​last_namestringrequired
patient.​sexstringrequired
Enum"Not known""Not specified""Male""Female""Other"
patient.​titlestring
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
patient.​dobstring or null(date-time)required
patient.​nhs_numberstring or null
patient.​emailstring(email)required
patient.​mobilestringrequired
patient.​addressobjectrequired
patient.​address.​line1stringrequired
patient.​address.​line2string or null
patient.​address.​line3string or null
patient.​address.​townstringrequired
patient.​address.​countystring or null
patient.​address.​countrystringrequired
patient.​address.​postcodestringrequired
prescriberobjectrequired
prescriber.​namestringrequired
prescriber.​codestring or null^\d+$
prescriber.​contact_numberstring or null
prescriber.​prescriber_idstringrequired
medicinesArray of objectsrequired
medicines[].​namestringrequired
medicines[].​quantitystringrequired
medicines[].​directionsstringrequired
medicines[].​snomed_codestring
deliveryobjectrequired
delivery.​issue_methodstringrequired
Enum"messaging""pharmacy""delivery""provider"
delivery.​send_smsboolean
Default false
delivery.​pharmacy_idstring
delivery.​invoice_clinicboolean
delivery.​delivery_addressobject
secure_pinstringrequired
notesstring
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/prescriptions \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "patient": {
      "id": "string",
      "first_name": "string",
      "last_name": "string",
      "sex": "Not known",
      "title": "Baron",
      "dob": "2019-08-24T14:15:22Z",
      "nhs_number": "string",
      "email": "user@example.com",
      "mobile": "string",
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "town": "string",
        "county": "string",
        "country": "string",
        "postcode": "string"
      }
    },
    "prescriber": {
      "name": "string",
      "code": "string",
      "contact_number": "string",
      "prescriber_id": "string"
    },
    "medicines": [
      {
        "name": "string",
        "quantity": "string",
        "directions": "string",
        "snomed_code": "string"
      }
    ],
    "delivery": {
      "issue_method": "messaging",
      "send_sms": false,
      "pharmacy_id": "string",
      "invoice_clinic": true,
      "delivery_address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "town": "string",
        "county": "string",
        "country": "string",
        "postcode": "string"
      }
    },
    "secure_pin": "string",
    "notes": "string"
  }'

Responses

Ok

Bodyapplication/json
prescription_idstring^\d+$required
Response
application/json
{
  "prescription_id": "string"
}

Get PrescriberDeprecated

Request

Retrieves a prescriber by its ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/prescriber/{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
emailstring(email)required
full_namestringrequired
tokensstring or null
activebooleanrequired
verifiedbooleanrequired
Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "full_name": "string",
  "tokens": "string",
  "active": true,
  "verified": true
}

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