API Reference

Hero Health Public API (1.0.0)

Download OpenAPI description

Download API docs

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

Form

Operations

Form Response

Operations

Invoicing

Operations

Patients

Operations

Prescription

Operations

Task

Operations

Update a task

Request

Updates a task using the provided parameters.

Path

idstringrequired

Bodyapplication/jsonrequired

statusstring

Enum"open""closed""in_progress"

prioritystring

Enum"lowest""low""medium""high""highest"

assignee_typestring

Enum"admin""admin_team"

assignee_idstring^\d+$

curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/tasks/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "status": "open",
    "priority": "lowest",
    "assignee_type": "admin",
    "assignee_id": "string"
  }'

Responses

Bodyapplication/json

dataobjectrequired

data.idstring^\d+$required

Response

application/json

{
  "data": {
    "id": "string"
  }
}

Get Task

Request

Retrieve task information for the given ID.

Path

idstringrequired

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

Responses

Bodyapplication/json

idstring^\d+$required

type_labelstringrequired

statusstringrequired

Enum"open""closed""in_progress"

detailsstring or null

categorystringrequired

patientobjectrequired

patient.idstring^\d+$required

patient.uidstring or null

patient.ehr_partner_idstring or null

patient.emis_idstring or null

patient.deceased_atstring or null(date-time)

patient.dobstring or null(date-time)required

patient.titlestring or null

patient.first_namestring or null

patient.last_namestring or null

patient.sexstringrequired

Enum"unspecified""male""female""other"

patient.nhs_numberstring or null

patient.emailstring or null

patient.mobilestring or null

patient.last_sync_atstring or null(date-time)

patient.full_namestringrequired

patient.contact_emailsArray of strings or nullrequired

patient.registered_practitioner_namestring or nullrequired

patient.notesstring or nullrequired

patient.membership_scheme_namesArray of strings or nullrequired

patient.addressobjectrequired

patient.address.line1string or null

patient.address.line2string or null

patient.address.line3string or null

patient.address.townstringrequired

patient.address.countystring or null

patient.address.countrystringrequired

patient.address.postcodestringrequired

patient.verification_credentials_listArray of strings

An array of unique emails and mobile numbers from the verification credentials associated with the patients practice group, Only applicable for practices using the JS booking flow and marked as private

form_responseobject

appointmentobject

communicationobject

assignee_idstring or null

assignee_typestring

assignee_namestring or null

prioritystringrequired

Enum"lowest""low""medium""high""highest"

created_atstringrequired

titlestringrequired

title_sub_textstringrequired

Response

application/json

{
  "id": "string",
  "type_label": "string",
  "status": "open",
  "details": "string",
  "category": "string",
  "patient": {
    "id": "string",
    "uid": "string",
    "ehr_partner_id": "string",
    "emis_id": "string",
    "deceased_at": "2019-08-24T14:15:22Z",
    "dob": "2019-08-24T14:15:22Z",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "sex": "unspecified",
    "nhs_number": "string",
    "email": "string",
    "mobile": "string",
    "last_sync_at": "2019-08-24T14:15:22Z",
    "full_name": "string",
    "contact_emails": [ … ],
    "registered_practitioner_name": "string",
    "notes": "string",
    "membership_scheme_names": [ … ],
    "address": { … },
    "verification_credentials_list": [ … ]
  },
  "form_response": {
    "id": 0,
    "form_id": 0,
    "client_id": 0,
    "appointment_id": 0,
    "invoice_id": 0,
    "practice_group_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "hidden": true,
    "emis_file_record_at": "string",
    "short_link_id": 0,
    "admin_id": 0,
    "write_to_record_error": "string",
    "title": "string",
    "submitted_at": "string",
    "form_questions_responses": [ … ],
    "form": { … }
  },
  "appointment": {
    "id": "string",
    "location_id": "string",
    "start_time": "2019-08-24T14:15:22Z",
    "reserved_until": "2019-08-24T14:15:22Z",
    "booking_confirmed_at": "2019-08-24T14:15:22Z",
    "can_be_cancelled": false,
    "can_be_rescheduled": false,
    "cancellation_policy_hours": 0,
    "appointment_template_name": "string",
    "cancelled_at": "2019-08-24T14:15:22Z",
    "confirmed_at": "2019-08-24T14:15:22Z",
    "appointment_source": "string",
    "video": false,
    "in_person": false,
    "telephone": false,
    "location_name": "string",
    "service": "string",
    "source": "string",
    "status": "string",
    "appointment_type_id": "string",
    "duration": 0,
    "patient_uid": "string",
    "practitioner_id": "string",
    "created_at": "string",
    "reason": "string",
    "practitioner_name": "string",
    "communication_method": "string",
    "video_url": "string"
  },
  "communication": {
    "id": "string",
    "content": "string",
    "contact_method": "email",
    "write_to_record_timestamp": "string",
    "write_to_record_error": "string",
    "notification": { … }
  },
  "assignee_id": "string",
  "assignee_type": "string",
  "assignee_name": "string",
  "priority": "lowest",
  "created_at": "string",
  "title": "string",
  "title_sub_text": "string"
}

List Tasks

Request

Retrieves a list of all tasks for a practice group.

Query

page_indexinteger

page_sizeinteger

assignee_id[]Array of strings

assignee_type[]Array of strings

Items Enum"Admin""AdminTeam""Unassigned"

status[]Array of strings

Items Enum"open""closed""in_progress"

priority[]Array of strings

Items Enum"lowest""low""medium""high""highest"

order_by[]Array of strings

Items Enum"created_at""priority"

order_descending[]Array of strings

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/tasks?assignee_id%5B%5D=string&assignee_type%5B%5D=Admin&order_by%5B%5D=created_at&order_descending%5B%5D=string&page_index=0&page_size=0&priority%5B%5D=lowest&status%5B%5D=open' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objectsrequired

data[].idstring^\d+$required

data[].type_labelstringrequired

data[].statusstringrequired

Enum"open""closed""in_progress"

data[].detailsstring or null

data[].categorystringrequired

data[].patientobjectrequired

data[].patient.idstring^\d+$required

data[].patient.uidstring or null

data[].patient.ehr_partner_idstring or null

data[].patient.emis_idstring or null

data[].patient.deceased_atstring or null(date-time)

data[].patient.dobstring or null(date-time)required

data[].patient.titlestring or null

data[].patient.first_namestring or null

data[].patient.last_namestring or null

data[].patient.sexstringrequired

Enum"unspecified""male""female""other"

data[].patient.nhs_numberstring or null

data[].patient.emailstring or null

data[].patient.mobilestring or null

data[].patient.last_sync_atstring or null(date-time)

data[].patient.full_namestringrequired

data[].patient.contact_emailsArray of strings or nullrequired

data[].patient.registered_practitioner_namestring or nullrequired

data[].patient.notesstring or nullrequired

data[].patient.membership_scheme_namesArray of strings or nullrequired

data[].patient.addressobjectrequired

data[].patient.address.line1string or null

data[].patient.address.line2string or null

data[].patient.address.line3string or null

data[].patient.address.townstringrequired

data[].patient.address.countystring or null

data[].patient.address.countrystringrequired

data[].patient.address.postcodestringrequired

data[].patient.verification_credentials_listArray of strings

data[].form_responseobject

data[].appointmentobject

data[].communicationobject

data[].assignee_idstring or null

data[].assignee_typestring

data[].assignee_namestring or null

data[].prioritystringrequired

Enum"lowest""low""medium""high""highest"

data[].created_atstringrequired

data[].titlestringrequired

data[].title_sub_textstringrequired

countnumberrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "count": 0
}

Webhooks

Operations

Prescriptions

Operations

Hero Health Public API (1.0.0)

Practice Group

Admin

Booking

Links

Utilities

Messages

Care Navigation

Form

Form Response

Invoicing

Patients

Prescription

Task

Update a task

Request

Responses

Was this helpful?

Get Task

Request

Responses

Was this helpful?

List Tasks

Request

Responses

Was this helpful?

Webhooks

Prescriptions