forms

List form definitions

Returns all form definitions configured for the clinic, including section definitions and signature requirements

get/forms/definitions

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/forms/definitions
  • Auth: none declared

Query parameters

showArchivedboolean

Include archived form definitions

isTxPlanboolean

Filter to only treatment plan forms

fieldDefinitionIds[]string[]

Filter by specific field definition IDs

includeSectionDefinitionsboolean

Include each form's section definitions and their field definitions. Set to false for a lighter response with only form-level metadata.

Response

success

idstring uuid
labelstring

Internal label for the form

titlestring

Display title of the form

descriptionstring
isPatientEligibleboolean

Whether patients can fill out this form

isTxPlanFormboolean

Whether this is a treatment plan form

txPlanCategoryIdstring uuid nullable

Treatment plan category ID if applicable

newFormNeededInXDaysinteger

Number of days after which a new form instance is needed

archiveDueFormsOnDischargeboolean

Whether to archive due forms when patient is discharged

Changes

No recorded changes to this operation across all 1 revision of this API.