API Reference
/
Form Response
/
Get FormSubmissionResponse

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

Get FormResponse

Request

Get a form response and its fields.

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

Responses

Ok

Bodyapplication/json
idnumberrequired
form_idnumberrequired
client_idnumberrequired
appointment_idnumber or nullrequired
invoice_idnumber or nullrequired
practice_group_idnumberrequired
created_atstringrequired
updated_atstringrequired
hiddenbooleanrequired
emis_file_record_atstring or nullrequired
short_link_idnumber or nullrequired
admin_idnumber or nullrequired
write_to_record_errorstring or nullrequired
Response
application/json
{
  "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"
}

Get FormSubmissionResponse

Request

Get a form submission response and its fields.

Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/form_submission_response/{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
patient_idstring
emis_file_record_atstring or nullrequired
Response
application/json
{
  "id": "string",
  "form_type": "questionnaire",
  "title": "string",
  "description": "string",
  "patient_title": "string",
  "patient_description": "string",
  "snomed_code": "string",
  "fields": [
    { … }
  ],
  "patient_id": "string",
  "emis_file_record_at": "string"
}

List Form Responses

Request

Retrieves a list of all form responses.

Query
page_indexstring
page_sizestring
order_bystring
Enum"patient_first_name""patient_last_name""patient_full_name""form_title""form_type""created_at""updated_at"
statusstring
Enum"success""failed""not_written"
order_descendingboolean
patient_first_namestring
patient_last_namestring
patient_full_namestring
form_titlestring
form_typestring
patient_idstring
created_at[]Array of strings
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/form_responses?created_at%5B%5D=string&form_title=string&form_type=string&order_by=patient_first_name&order_descending=true&page_index=string&page_size=string&patient_first_name=string&patient_full_name=string&patient_id=string&patient_last_name=string&status=success' \
  -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 or null^\d+$
data[].​patientobject or null
data[].​write_to_recordobject or null
data[].​created_atstring or null(date-time)
data[].​updated_atstring or null(date-time)
data[].​form_typestring or null
data[].​form_titlestring or null
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Invoicing

Operations

Patients

Operations

Prescription

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations