QuestionnaireResponses

Create a new questionnaire response

Changed on
post/QuestionnaireResponses

Request

Request body

questionnaireIdstring required
patientIdstring nullable
clientIdstring nullable
appointmentIdstring nullable
responsesstring nullable
customAttributesstring nullable

Response

OK

idstring
questionnaireIdstring
patientIdstring nullable
clientIdstring nullable
appointmentIdstring nullable
responsesstring
statusinteger
submittedAtstring date-time nullable
submittedBystring nullable
createdAtstring date-time
updatedAtstring date-time
readAtstring date-time nullable

When the client read a read-only handout on the public page (ITE-1712). A Completed handout with no ReadAt was completed by opening the link, before ITE-1712: opened, not read.

customAttributesstring nullable
linkExpiresAtstring date-time nullable

Latest expiry among the response's public links. Lets read surfaces derive "Sent, awaiting" (InProgress, unexpired) vs "Expired" (InProgress, expired).

linkFirstViewedAtstring date-time nullable

Earliest first-view among the response's public links (null = never opened). Lets read surfaces distinguish "Sent, awaiting" from "Opened, awaiting".

deliveryMethodstring nullable

How the latest link reached the client (ITE-1477): "Email", "SMS", "Both", or "InClinic" for a tablet / QR handoff. Null for a link from before the channel was recorded.

Example response

{
  "patient": {
    "species": "Cat",
    "breed": "Siamese",
    "sex": "Male"
  }
}

Changes

    • warning

      added the new Handout enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new Handout enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new Handout enum value to the ///// response property for the response status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • breaking

      the ///// response's property type changed from integer to no type for status (media type: text/plain)

    • breaking

      the ///// response's property type changed from integer to no type for status (media type: application/json)

    • breaking

      the ///// response's property type changed from integer to no type for status (media type: text/json)

    • warning

      added the new AppointmentConfirmation enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new AppointmentConfirmation enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new AppointmentConfirmation enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new Consent enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new Consent enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new Consent enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new Custom enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new Custom enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new Custom enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new Intake enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new Intake enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new Intake enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new NewClient enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new NewClient enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new NewClient enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new PostVisit enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new PostVisit enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new PostVisit enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new PreVisit enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new PreVisit enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new PreVisit enum value to the ///// response property for the response status (media type: text/json)

    • warning

      added the new Satisfaction enum value to the ///// response property for the response status (media type: text/plain)

    • warning

      added the new Satisfaction enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new Satisfaction enum value to the ///// response property for the response status (media type: text/json)