Skip to content
API Docs/
API Reference
/
/
Create Form Response

Create Form Response

Request

Create a response for a given Form ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
patient_idstring^\d+$required
write_to_recordboolean
Default:false
responsesArray of objectsrequired
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",
    "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
{
  "form_response_id": "string",
  "confirm_write_to_record_url": "string"
}