FormAnswerGroup
A completed form, with metadata about the completion, and the saved answers
Fields
appointment
· Appointment · The appointment the note is connected to autoscored_sections
· [AutoscoredSectionType!]!
· required · The autoscored sections for the filled form charting_note_addendums
· [ChartingNoteAddendumType!] · The addendums added to the locked charting note current_summary
· GeneratedSummary · The most recent generated summary. Null if no summary has been generated custom_module_form
· CustomModuleForm · The form template that was filled out deleted_at
· String · The date the form was deleted external_id
· String · An external ID stored on the filled form or charting note form_answer_group_audit_events
· [FormAnswerGroupAuditEvent!]!
· required · The history when a charting note was locked, unlocked or signed form_answer_group_users_connections
· [FormAnswerGroupUserConnection!] · A list of connections between a form_answer_group and group appointment users group_appointment_attendees
· [User!] · All patients that have attended in the related group appointment individual_client_notes
· [IndividualClientType!] · A collection of individual charting notes related to the main group charting note individual_note
· IndividualClientType · Same as individual_client_notes but returns a specific instance for given user is_group_appt_note
· Boolean · Indicates whether the answer group is related to group appointment (charting note created for group appointment) offering_with_recommended_products
· Offering · If you have product recommendation algorithm enabled, this will return a package containing the products recommended by the algorithm packages_with_recommended_products_purchase_url
· String · If you have product recommendation algorithm enabled, this will return a package containing a URL to purchase the products recommended by the algorithm deprecated
Not used anywhere, will cause an errorprovider_can_add_addendum
· Boolean!
· required · Whether current user or given user can add addendum to this `form_answer_group` provider_can_lock
· Boolean!
· required · Whether current user or given user can lock this `form_answer_group` provider_can_sign
· Boolean!
· required · Whether current user or given user can sign this `form_answer_group` provider_can_unlock
· Boolean!
· required · Whether current user or given user can unlock this `form_answer_group` record_created_at
· String · The date that the note was actually created versioning_stream_name
· String · The name of the signed stream to track changes in `form_answers` Used By
Definition
"""A completed form, with metadata about the completion, and the saved answers"""type FormAnswerGroup { """ The appointment the note is connected to """ appointment: Appointment
""" The autoscored sections for the filled form """ autoscored_sections: [AutoscoredSectionType!]!
""" The addendums added to the locked charting note """ charting_note_addendums: [ChartingNoteAddendumType!]
""" The CMS1500 created from the form answer group """ cms1500: Cms1500
""" The date on which the filled form was saved """ created_at: String!
""" The most recent generated summary. Null if no summary has been generated """ current_summary: GeneratedSummary
""" Pagination cursor """ cursor: Cursor!
""" The form template that was filled out """ custom_module_form: CustomModuleForm
""" The date the form was deleted """ deleted_at: String
""" An external ID stored on the filled form or charting note """ external_id: String
""" The user who filled out the form """ filler: User
""" Whether the filled form has been saved by the user (verse a hidden draft) """ finished: Boolean!
""" The history when a charting note was locked, unlocked or signed """ form_answer_group_audit_events: [FormAnswerGroupAuditEvent!]!
""" Signatures for the form """ form_answer_group_signings: [FormAnswerGroupSigning!]!
""" A list of connections between a form_answer_group and group appointment users """ form_answer_group_users_connections: [FormAnswerGroupUserConnection!]
""" The visible answers for the filled form """ form_answers( """ When true, all answers (even conditionally hidden ones) are returned. """ is_for_editing: Boolean = false ): [FormAnswer!]!
""" when true, the note cannot be edited """ frozen: Boolean
""" All patients that have attended in the related group appointment """ group_appointment_attendees: [User!]
""" The unique identifier of the group """ id: ID!
""" A collection of individual charting notes related to the main group charting note """ individual_client_notes( """ Preferable sorting order """ order_by: IndividualClientNoteOrderKeys
""" Preferable sorting order """ sort_by: IndividualClientNoteSorting @deprecated(reason: "Use `order_by` instead") ): [IndividualClientType!]
""" Same as individual_client_notes but returns a specific instance for given user """ individual_note( """ The client's ID """ user_id: ID ): IndividualClientType
""" Indicates whether the answer group is related to group appointment (charting note created for group appointment) """ is_group_appt_note: Boolean
""" Shows whether `FormAnswerGroup` is locked """ is_locked: Boolean!
""" The date and time when the charting note was locked """ locked_at: String
""" The provider who have locked the charting note """ locked_by: User
""" A serialized JSON string of metadata. Maximum character limit of 128,000. Only accessible by staff and providers """ metadata: String
""" The given name of the filled form """ name: String
""" If you have product recommendation algorithm enabled, this will return a package containing the products recommended by the algorithm """ offering_with_recommended_products: Offering
""" If you have product recommendation algorithm enabled, this will return a package containing a URL to purchase the products recommended by the algorithm """ packages_with_recommended_products_purchase_url: String @deprecated(reason: "Not used anywhere, will cause an error")
""" Whether current user or given user can add addendum to this `form_answer_group` """ provider_can_add_addendum( """ Given provider's id. Falls back to current user if not given """ provider_id: ID = null ): Boolean!
""" Whether current user or given user can lock this `form_answer_group` """ provider_can_lock( """ Given provider's id. Falls back to current user if not given """ provider_id: ID = null ): Boolean!
""" Whether current user or given user can sign this `form_answer_group` """ provider_can_sign( """ Given provider's id. Falls back to current user if not given """ provider_id: ID = null ): Boolean!
""" Whether current user or given user can unlock this `form_answer_group` """ provider_can_unlock( """ Given provider's id. Falls back to current user if not given """ provider_id: ID = null ): Boolean!
""" The date that the note was actually created """ record_created_at: String
""" The last updated date for the filled form """ updated_at: String!
""" The user the form is about """ user: User
""" ID of the user """ user_id: String
""" The name of the signed stream to track changes in `form_answers` """ versioning_stream_name: String}