API Reference
/
Prescription
/
Create Pharmacy

Hero Health Public API (1.0.0)

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

Operations

Admin

Operations

Booking

Operations

Links

Operations

Utilities

Operations

Messages

Operations

Care Navigation

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Patients

Operations

Prescription

Operations

Get Prescriber's Pharmacies List

Request

Retrieve a list of pharmacies for the prescriber.

Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/prescriber/{id}/pharmacies' \
  -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[].​idstring^\d+$required
data[].​prescriber_idstring^\d+$required
data[].​namestringrequired
data[].​emailstringrequired
data[].​mobilestringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Create Pharmacy

Request

Create a new Pharmacy for the prescriber.

Bodyapplication/jsonrequired
namestringrequired
emailstringrequired
mobilestringrequired
prescriber_idstring^\d+$required
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/pharmacies \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "email": "string",
    "mobile": "string",
    "prescriber_id": "string"
  }'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
prescriber_idstring^\d+$required
namestringrequired
emailstringrequired
mobilestringrequired
Response
application/json
{
  "id": "string",
  "prescriber_id": "string",
  "name": "string",
  "email": "string",
  "mobile": "string"
}

Get Prescriber

Request

Retrieves a prescriber by its ID.

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
}

Create a Prescription

Request

Create a new prescription for a patient.

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_idstring^\d+$required
medicinesArray of objectsrequired
medicines[].​namestringrequired
medicines[].​quantitystringrequired
medicines[].​directionsstringrequired
medicines[].​snomed_codestringrequired
deliveryobjectrequired
delivery.​issue_methodstringrequired
Enum"messaging""pharmacy""delivery"
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/v1/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 a Prescription

Request

Retrieve details of a specific prescription by its ID.

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"
  }
}

Task

Operations

Webhooks

Operations

Prescriptions

Operations