API Reference
/
Form

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

List Forms

Request

Retrieves a list of all forms configured for the requesting practice group.

Query
searchstring
reply_formboolean
form_typestring
Enum"questionnaire""response""appointment""care_navigation"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/forms?form_type=questionnaire&reply_form=true&search=string' \
  -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[].​descriptionstringrequired
data[].​patient_titlestring or nullrequired
data[].​patient_descriptionstring or nullrequired
data[].​reply_formbooleanrequired
data[].​form_typestringrequired
Enum"questionnaire""response""appointment""care_navigation"
data[].​snomed_codestring or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Get Form

Request

Get a form and its fields.

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

Responses

Ok

Bodyapplication/json
idstringrequired
form_typestringrequired
Enum"questionnaire""response""appointment""care_navigation"
titlestringrequired
descriptionstringrequired
patient_titlestring or nullrequired
patient_descriptionstring or nullrequired
snomed_codestring 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
Response
application/json
{
  "id": "string",
  "form_type": "questionnaire",
  "title": "string",
  "description": "string",
  "patient_title": "string",
  "patient_description": "string",
  "snomed_code": "string",
  "fields": [
    { … }
  ]
}

Create Form Response

Request

Create a response for a given Form ID.

Path
idstringrequired
Bodyapplication/jsonrequired
patient_idstring^\d+$required
auto_write_to_recordboolean
Default false
write_to_recordboolean
Default false
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
appointment_idstring^\d+$
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/forms/{id}/response' \
  -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",
    "auto_write_to_record": false,
    "write_to_record": false,
    "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"
      }
    ],
    "appointment_id": "string"
  }'

Responses

Ok

Bodyapplication/json
form_response_idstring^\d+$required
confirm_write_to_record_urlstring or null
Response
application/json
{
  "form_response_id": "string",
  "confirm_write_to_record_url": "string"
}

Update Form Response

Request

Update form response for a given form response ID.

Path
idstringrequired
Bodyapplication/jsonrequired
auto_write_to_recordboolean
Default false
write_to_recordboolean
Default false
curl -i -X POST \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/forms/response/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "auto_write_to_record": false,
    "write_to_record": false
  }'

Responses

Ok

Bodyapplication/json
form_response_idstring^\d+$required
confirm_write_to_record_urlstring or null
Response
application/json
{
  "form_response_id": "string",
  "confirm_write_to_record_url": "string"
}

Form Response

Operations

Invoicing

Operations

Patients

Operations

Prescription

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations