insights

Get form outcomes report

Returns outcomes data for a specific form definition within the specified date range, including patient information, encounter details, and form field values

get/insights/form-outcomes

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/insights/form-outcomes
  • Auth: none declared

Query parameters

formDefinitionIdstring uuid required

The form definition ID to get outcomes for

startDatestring date-time required

Start date of report range (ISO 8601)

endDatestring date-time required

End date of report range (ISO 8601)

patientIds[]string[]

Filter by specific patient IDs

limitinteger

Maximum number of results to return

offsetinteger

Number of results to skip for pagination

csvboolean

Return as CSV file

Response

success

formNamestring required

Name of the form definition

startDatestring date-time required
endDatestring date-time required

Changes

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