Function update

Returns <T extends Report.v1.Report | ReportWithLineage>(
    updated: UpdateReportInput<T>,
) => Promise<T>

a function for updating a report

• • <T extends Report.v1.Report | ReportWithLineage>(
        updated: UpdateReportInput<T>,
    ): Promise<T>

  • Updates an existing report to have the provided data.

    Type Parameters

    • T extends Report.v1.Report | ReportWithLineage

    Parameters

    • updated: UpdateReportInput<T>

      the updated report data. The complete data for the report must be provided. Existing fields not included in the updated data will be removed from the report. If the provided parent/patient/place lineage is hydrated (e.g. for a ReportWithLineage), the lineage will be properly dehydrated before being stored.

    Returns Promise<T>

    the updated report with the new _rev value

    Throws

    InvalidArgumentError if _id is not provided

    Throws

    ResourceNotFoundError if _id does not identify an existing report

    Throws

    InvalidArgumentError if _rev is not provided or does not match the report's current _rev value

    Throws

    InvalidArgumentError if form is not provided or is not a supported form id

    Throws

    InvalidArgumentError if contact is not provided or is not a valid contact

    Throws

    InvalidArgumentError if any of the following read-only properties are changed: reported_date, type