Skip to content

createFormAnswerGroupInput

Autogenerated input type of createFormAnswerGroup

Fields

deprecated DO NOT USE
appointment_id · ID · ID of the appointment associated with this form answer group.
course_id · ID · ID of the course associated with this form answer group.
course_item_id · ID · ID of the course item completed by submitting this form.
created_at · ISO8601DateTime · Sets the created_at timestamp of the form answer group.
custom_module_form_id · ID · ID of the form template (CustomModuleForm) being completed.
date · ISO8601DateTime · Date portion of the service date, used with `time` to set the creation timestamp.
dismissed_lock_charting_note_warning · Boolean · Deprecated: previously used to dismiss the lock charting note warning.
deprecated Not used
external_id · ID · External identifier for integration with third-party systems.
finished · Boolean · Whether the form has been completed and submitted, as opposed to saved as a draft.
form_answers · [FormAnswerInput] · Individual form answers to submit with this form.
formatted_date · ISO8601DateTime · The datetime of service.
individual_client_notes · [IndividualClientNoteInput] · Individual client notes for group appointment charting.
deprecated This argument is no longer needed. Empty `individual_client_notes` are created automatically
marked_complete · Boolean · Marks the form as explicitly completed, setting the marked_complete_at timestamp.
marked_locked · Boolean · Locks the form from further editing after creation.
name · String · Name or title for this form answer group.
metadata · String · Maximum character limit of 128,000.
requested_form_completion_id · ID · ID of the RequestedFormCompletion record this submission fulfills.
set_initial_answers · Boolean · When true and no form answers are provided, auto-populates the form with default initial answers.
time · String · Time portion of the service date (e.g., '10 30' for 10:30 AM), used with `date` to set the creation timestamp.
updated_at · ISO8601DateTime · Sets the updated_at timestamp of the form answer group. Requires additional permissions to edit.
user_id · ID · ID of the client or patient the form is associated with.
onboarding_item_id · ID · Creation of a form_answer_group in the context of an onboarding_item_id.

Used By

Definition

"""
Autogenerated input type of createFormAnswerGroup
"""
input createFormAnswerGroupInput {
"""
DO NOT USE
"""
clientMutationId: String @deprecated(reason: "DO NOT USE")
"""
ID of the appointment associated with this form answer group.
"""
appointment_id: ID
"""
ID of the course associated with this form answer group.
"""
course_id: ID
"""
ID of the course item completed by submitting this form.
"""
course_item_id: ID
"""
Sets the created_at timestamp of the form answer group.
"""
created_at: ISO8601DateTime
"""
ID of the form template (CustomModuleForm) being completed.
"""
custom_module_form_id: ID
"""
Date portion of the service date, used with `time` to set the creation timestamp.
"""
date: ISO8601DateTime
"""
Deprecated: previously used to dismiss the lock charting note warning.
"""
dismissed_lock_charting_note_warning: Boolean = false
@deprecated(reason: "Not used")
"""
External identifier for integration with third-party systems.
"""
external_id: ID
"""
Whether the form has been completed and submitted, as opposed to saved as a draft.
"""
finished: Boolean
"""
Individual form answers to submit with this form.
"""
form_answers: [FormAnswerInput]
"""
The datetime of service.
"""
formatted_date: ISO8601DateTime
"""
Individual client notes for group appointment charting.
"""
individual_client_notes: [IndividualClientNoteInput]
@deprecated(
reason: "This argument is no longer needed. Empty `individual_client_notes` are created automatically"
)
"""
Marks the form as explicitly completed, setting the marked_complete_at timestamp.
"""
marked_complete: Boolean
"""
Locks the form from further editing after creation.
"""
marked_locked: Boolean
"""
Name or title for this form answer group.
"""
name: String
"""
Maximum character limit of 128,000.
"""
metadata: String
"""
ID of the RequestedFormCompletion record this submission fulfills.
"""
requested_form_completion_id: ID = null
"""
When true and no form answers are provided, auto-populates the form with default initial answers.
"""
set_initial_answers: Boolean
"""
Time portion of the service date (e.g., '10 30' for 10:30 AM), used with `date` to set the creation timestamp.
"""
time: String
"""
Sets the updated_at timestamp of the form answer group. Requires additional permissions to edit.
"""
updated_at: ISO8601DateTime
"""
ID of the client or patient the form is associated with.
"""
user_id: ID
"""
Creation of a form_answer_group in the context of an onboarding_item_id.
"""
onboarding_item_id: ID = null
}