Form Response

A form response is a collection of answers to a form.

The form response model

Properties

Name
id
Type
string
Description
Unique identifier for the form response.
Name
object
Type
string
Description
Always 'form_response'.
Name
patient
Type
string
Description
Patient this form response is for.
Name
form
Type
string
Description
Form this is a response to.
Name
form_version
Type
string
Description
Form version this is a response to.
Name
sections
Type
array of objects
Description
All the sections and answers in the form response.
Name
status_history
Type
array of objects
Description
Status history of the form_response.
Name
created_by
Type
string
Description
Creator of the form response.
Name
created_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the form response was created.
Name
last_updated_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the form response was last updated.

Response

{
    "id": "fres_2UxtAULYUrX7GVsTKePy",
    "object": "form_response",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "form": "form_NOIYLBGOBNhSwTWCUzfu",
    "form_version": "fver_1JtjV1QEY84Fv395Hl7h",
    "sections": [
        [{
        "id": "fans_ap0jVVAdR23DgkQPpdX8",
        "object": "form_response_answer",
        "question": "fqst_ap0jVVAdR23DgkQPpdX8",
        "response": 646077022
        }]
    ],
    "status_history": [
        {
        "status": "inProgress",
        "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
        "changed_at": 1653798303
        }
    ],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}