Skip to content

RecurringForm

A Recurring Form

Fields

custom_module_form · CustomModuleForm · Associated custom module form
form_id · String · The ID of the form itself
form_type · String! · required · The type of form
has_connected_recipient · Boolean · Whether the user or group is connected to the recurring form
id · ID! · required · The unique identifier of the recurring form
interval · String · The interval of recurrence. Can be: '23:12' / 'Monday, Tuesday' / '31st'
interval_type · String · The type of recurrence('Daily'(1) / 'Weekly'(2) / 'Monthly'(3))
is_active · Boolean! · required · Whether the recurrence is active or not
recurrence_end_at · String · The day when recurrence ends
userGroups · [UserGroup!] · Get user_group assigned to the recurring form
user_id · String · The ID of the provider who set up recurrence
users · [User!] · Get patients assigned to the recurring form
users_and_groups · [String]! · required · The identifiers of associated users and groups: ['1', '2', 'group-5', 'group-13']

Used By

Definition

"""
A Recurring Form
"""
type RecurringForm {
"""
Associated custom module form
"""
custom_module_form: CustomModuleForm
"""
The ID of the form itself
"""
form_id: String
"""
The type of form
"""
form_type: String!
"""
Whether the user or group is connected to the recurring form
"""
has_connected_recipient(
"""
The ID of the user or group
"""
connectable_id: ID
"""
The type of the user or group
"""
connectable_type: String
): Boolean
"""
The unique identifier of the recurring form
"""
id: ID!
"""
The interval of recurrence. Can be: '23:12' / 'Monday, Tuesday' / '31st'
"""
interval: String
"""
The type of recurrence('Daily'(1) / 'Weekly'(2) / 'Monthly'(3))
"""
interval_type: String
"""
Whether the recurrence is active or not
"""
is_active: Boolean!
"""
The day when recurrence ends
"""
recurrence_end_at: String
"""
Get user_group assigned to the recurring form
"""
userGroups: [UserGroup!]
"""
The ID of the provider who set up recurrence
"""
user_id: String
"""
Get patients assigned to the recurring form
"""
users: [User!]
"""
The identifiers of associated users and groups: ['1', '2', 'group-5', 'group-13']
"""
users_and_groups: [String]!
}