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

Booking - HCA

Operations

List Pathways

Request

Retrieves a list of pathways for the requesting practice group.

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

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.

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

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.

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

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

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

List Care Navigation Submissions

Request

Retrieves a list of all care navigation submissions.

Query

page_indexstring

page_sizestring

order_bystring

Value"created_at"

order_descendingboolean

patient_idstring

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/submissions?order_by=created_at&order_descending=true&page_index=string&page_size=string&patient_id=string' \
  -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[].created_atstring(date-time)required

data[].titlestringrequired

data[].write_to_recordobject or null

data[].typestring or null

Enum"Admin request""Clinical request""Other request"

countnumberrequired

Response

application/json

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

Create Care Nav Submission

Request

Create a Care Nav Submission.

Bodyapplication/jsonrequired

submission_type_idstring^\d+$required

patient_idstring^\d+$required

responsesArray of objectsrequired

responses[].form_question_idstring^\d+$required

responses[].text_responsestring

responses[].integer_responsenumber or null

responses[].boolean_responseboolean

responses[].checkbox_responseArray of strings or string

One of:

responses[].datetime_responsestring

responses[].observation_value_responsestring

responses[].problem_responsestring

responses[].immunisation_responsestring

responses[].base_64_content_typestring

responses[].base_64_file_namestring

responses[].base_64_file_responsestring

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/submission \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "submission_type_id": "string",
    "patient_id": "string",
    "responses": [
      {
        "form_question_id": "string",
        "text_response": "string",
        "integer_response": 0,
        "boolean_response": true,
        "checkbox_response": [
          "string"
        ],
        "datetime_response": "string",
        "observation_value_response": "string",
        "problem_response": "string",
        "immunisation_response": "string",
        "base_64_content_type": "string",
        "base_64_file_name": "string",
        "base_64_file_response": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

care_nav_submission_idstring^\d+$required

Response

application/json

{
  "care_nav_submission_id": "string"
}

List Submission Types

Request

Retrieves a list of submission types for the requesting practice group.

Query

pathway_idstring

partner_idstring

typestring

Enum"form""internal_url""external_url"

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/submission-types?partner_id=string&pathway_id=string&type=form' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

countnumberrequired

dataArray of objectsrequired

data[].idstring^\d+$required

data[].pathway_idstring^\d+$required

data[].partner_idstring or null^\d+$required

data[].form_idstring or null^\d+$required

data[].titlestringrequired

data[].summarystring or nullrequired

data[].internal_urlstring or nullrequired

data[].external_urlstring or nullrequired

data[].external_url_namestring or nullrequired

data[].typestringrequired

Enum"admin_request""clinical_request""other_request"

Response

application/json

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

Get Submission Type

Request

Retrieves a submission type.

Path

idstringrequired

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

Responses

Bodyapplication/json

idstring^\d+$required

pathway_idstring^\d+$required

partner_idstring or null^\d+$required

form_idstring or null^\d+$required

titlestringrequired

summarystring or nullrequired

internal_urlstring or nullrequired

external_urlstring or nullrequired

external_url_namestring or nullrequired

typestringrequired

Enum"admin_request""clinical_request""other_request"

Response

application/json

{
  "id": "string",
  "pathway_id": "string",
  "partner_id": "string",
  "form_id": "string",
  "title": "string",
  "summary": "string",
  "internal_url": "string",
  "external_url": "string",
  "external_url_name": "string",
  "type": "admin_request"
}

Form

Operations

Form Response

Operations

Invoicing

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations

Hero Health Public API (1.0.0)

Practice Group

Admin

Booking

Links

Utilities

Messages

Booking - HCA

Care Navigation

List Pathways

Request

Responses

Was this helpful?

Get Pathway

Request

Responses

Was this helpful?

Get Care Navigation Submission

Request

Responses

Was this helpful?

List Care Navigation Submissions

Request

Responses

Was this helpful?

Create Care Nav Submission

RequestExpand all

Responses

Was this helpful?

List Submission Types

Request

Responses

Was this helpful?

Get Submission Type

Request

Responses

Was this helpful?

Form

Form Response

Invoicing

Patients

Prescription

Subscriptions

Task

Webhooks

Prescriptions

Request