API Reference
/
Care Navigation
/
List Pathways

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

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

Ok

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

Ok

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
}

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

Ok

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

Ok

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

Ok

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

Task

Operations

Webhooks

Operations

Prescriptions

Operations