Skip to content
Healthie API Docs

formAnswerGroups

All filled forms for a given set of arguments

Arguments

custom_module_form_id · ID · Filter by form template ID.
date · String · Filter by a specific date. Supersedes `start_date` and `end_date`.
end_date · ISO8601Date · When passed in, only filled forms created before the specified datetime are returned.
filler_id · String · Filter by the ID of the individual who filled out the items.
form_answer_group_id · String · Filter by form answer group ID.
ids · [ID] · Accepts an array of FormAnswerGroup IDs.
include_group_notes · Boolean · When true, includes group notes (form answer groups tied to a group appointment). When false or not passed in, group notes are excluded.
name · String · Filter by name of the form answer group or associated form template.
user_id · String · The ID of the client whose form answer groups to retrieve.
locked_status · Boolean · When true, returns only locked form answer groups. When false, returns only unlocked form answer groups. When not passed in, returns both locked and unlocked form answer groups.
signed_status · Boolean · When true, returns only signed form answer groups. When false, returns only unsigned form answer groups. When not passed in, returns both signed and unsigned form answer groups.
start_date · ISO8601Date · When passed in, only filled forms created after the specified datetime are returned.
updated_after · ISO8601DateTime · When passed in, only objects updated after the specified datetime are returned.
updated_before · ISO8601DateTime · When passed in, only objects updated before the specified datetime are returned.
order_by · FormAnswerGroupOrderKeys · The order to return the form answer groups in.
use_for_charting · Boolean · When true, only returns form answer groups for forms marked for charting use.
after · Cursor · Cursor to fetch results after

Returns

[FormAnswerGroup!]

Example 

query formAnswerGroups(
  $custom_module_form_id: ID
  $date: String
  $end_date: ISO8601Date
  $filler_id: String
  $form_answer_group_id: String
  $ids: [ID]
  $include_group_notes: Boolean
  $name: String
  $user_id: String
  $locked_status: Boolean
  $signed_status: Boolean
  $start_date: ISO8601Date
  $updated_after: ISO8601DateTime
  $updated_before: ISO8601DateTime
  $order_by: FormAnswerGroupOrderKeys
  $use_for_charting: Boolean
  $offset: Int
  $page_size: Int
  $should_paginate: Boolean
  $after: Cursor
) {
  formAnswerGroups(
    custom_module_form_id: $custom_module_form_id
    date: $date
    end_date: $end_date
    filler_id: $filler_id
    form_answer_group_id: $form_answer_group_id
    ids: $ids
    include_group_notes: $include_group_notes
    name: $name
    user_id: $user_id
    locked_status: $locked_status
    signed_status: $signed_status
    start_date: $start_date
    updated_after: $updated_after
    updated_before: $updated_before
    order_by: $order_by
    use_for_charting: $use_for_charting
    offset: $offset
    page_size: $page_size
    should_paginate: $should_paginate
    after: $after
  ) {
    appointment
    autoscored_sections
    chart_note_status
    charting_note_addendums
    cms1500
    created_at
    current_summary
    cursor
    custom_module_form
    deleted_at
    documents
    external_id
    filler
    finished
    form_answer_group_audit_events
    form_answer_group_prescriptions
    form_answer_group_signings
    form_answer_group_users_connections
    form_answers
    frozen
    group_appointment_attendees
    id
    individual_client_notes
    individual_note
    is_group_appt_note
    is_locked
    lab_orders
    locked_at
    locked_by
    metadata
    name
    narx_checks
    offering_with_recommended_products
    provider_can_add_addendum
    provider_can_lock
    provider_can_sign
    provider_can_unlock
    record_created_at
    requested_form_completion
    updated_at
    user
    user_id
    versioning_stream_name
  }
}