Skip to content

CustomModuleForm

A template for a form, that can then be filled out

Fields

created_at · ISO8601DateTime! · required · The date on which the template was created
cursor · Cursor! · required · Pagination cursor
customInstructions · String · Form-level general instructions passed to AI Scribe alongside the form title (tone, style, structure preferences). Available for charting forms only. Backed by AiScribeFormInstruction so the form schema stays Scribe-agnostic.
custom_modules · [CustomModule!]! · required · The questions in the template
deleted_at · ISO8601DateTime · The date on which the template was deleted
external_id · String · A custom identifier set by API users. Used to relate our form objects with objects in third-party systems
external_id_type · String · The type or source system of the custom external identifier. Used to relate our form objects with objects in third-party systems
form_answer_groups · [FormAnswerGroup!]! · required · All filled out forms for this template
has_matrix_field · Boolean · The form has matrix field
has_non_readonly_modules · Boolean · When true, the form has modules that the user has to fill out
id · ID! · required · The unique identifier of the module form
is_scribe_form · Boolean! · required · Whether this form is linked to an appointment type as an AI Scribe autocomplete form
is_video · Boolean · Whether the form contains only one custom_module with mod_type 'video' and was created as part of a program
last_updated_by_user · User · User who last updated this form
metadata · String · A serialized JSON string of metadata. Maximum character limit of 10,000.
name · String · The given name of the template
prefill · Boolean · Whether subsequent times filling out the template, will start with the template prefilled with the previous answers
propagated_from · FormPropagation · The propagation record that brought this form to the viewing organization. Null when the form is local.
propagation_source · FormPropagationSource! · required · Where this form came from, relative to the viewing organization
propagations · FormPropagationPaginationConnection! · required · Outgoing propagation records for this form, newest first. Empty unless the viewing organization is the source.
question_groups · [CustomModuleCollection!]! · required · The question groups in this form
updated_at · ISO8601DateTime! · required · The date on which the template was updated
uploaded_by_healthie_team · Boolean! · required · Whether or not this form was uploaded by Healthie team member
use_for_charting · Boolean! · required · Whether the template can be used to chart with
use_for_program · Boolean! · required · Whether the template was made for a program
user · User · The owner of the template

Used By

Definition

"""
A template for a form, that can then be filled out
"""
type CustomModuleForm {
"""
The date on which the template was created
"""
created_at: ISO8601DateTime!
"""
Pagination cursor
"""
cursor: Cursor!
"""
Form-level general instructions passed to AI Scribe alongside the form title (tone, style, structure preferences). Available for charting forms only. Backed by AiScribeFormInstruction so the form schema stays Scribe-agnostic.
"""
customInstructions: String
"""
The questions in the template
"""
custom_modules: [CustomModule!]!
"""
The date on which the template was deleted
"""
deleted_at: ISO8601DateTime
"""
A custom identifier set by API users. Used to relate our form objects with objects in third-party systems
"""
external_id: String
"""
The type or source system of the custom external identifier. Used to relate our form objects with objects in third-party systems
"""
external_id_type: String
"""
All filled out forms for this template
"""
form_answer_groups: [FormAnswerGroup!]!
"""
The form has matrix field
"""
has_matrix_field: Boolean
"""
When true, the form has modules that the user has to fill out
"""
has_non_readonly_modules: Boolean
"""
The unique identifier of the module form
"""
id: ID!
"""
Whether this form is linked to an appointment type as an AI Scribe autocomplete form
"""
is_scribe_form: Boolean!
"""
Whether the form contains only one custom_module with mod_type 'video' and was created as part of a program
"""
is_video: Boolean
"""
User who last updated this form
"""
last_updated_by_user: User
"""
A serialized JSON string of metadata. Maximum character limit of 10,000.
"""
metadata: String
"""
The given name of the template
"""
name: String
"""
Whether subsequent times filling out the template, will start with the template prefilled with the previous answers
"""
prefill: Boolean
"""
The propagation record that brought this form to the viewing organization. Null when the form is local.
"""
propagated_from: FormPropagation
"""
Where this form came from, relative to the viewing organization
"""
propagation_source: FormPropagationSource!
"""
Outgoing propagation records for this form, newest first. Empty unless the viewing organization is the source.
"""
propagations(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Only return records with this mode
"""
mode: ContentPropagationMode
"""
Only return records with this status
"""
status: ContentPropagationStatus
): FormPropagationPaginationConnection!
"""
The question groups in this form
"""
question_groups: [CustomModuleCollection!]!
"""
The date on which the template was updated
"""
updated_at: ISO8601DateTime!
"""
Whether or not this form was uploaded by Healthie team member
"""
uploaded_by_healthie_team: Boolean!
"""
Whether the template can be used to chart with
"""
use_for_charting: Boolean!
"""
Whether the template was made for a program
"""
use_for_program: Boolean!
"""
The owner of the template
"""
user: User
}