Skip to main content

Data Export - User Consents

Generated by the Bulk Data Export system

The order of columns is subject to change. When parsing files, please ensure to use headers rather than positional parsing to ensure you are reading the data correctly.

What this export contains​

One row per instance of a patient or participant approving or rejecting a consent form, with the consent name, participant and status. Use it to evidence consent and to audit who has agreed to what.

Example questions this export can answer​

  • Show which patients have accepted a given consent
  • Audit consent status across the caseload
  • Evidence consent for compliance or research
PropertyNameField TypeNotes
instituteidInstitute Ididentifier
instituteShortcodeInstitute ShortcodeString
idIDidentifierThe identifier that links the unique agreement by a participant and the consent form
patientIdPatient IDidentifierPatient
patientLastNamePatient Last Namestring
patientFirstNamePatient First Namestring
consentAgreementIdConsent Agreement IDidentifierThe agreement of a specific participant
consentIdConsent IDidentifierThe consent form ID
consentNameConsent Namestring
participantIdParticipant IDidentifierID of the patient or related person
participantTypeParticipant Typeenumpatient | guardianteachermotherfatherchild
participantLastNameParticipant Last Namestring
participantFirstNameParticipant First Namestring
statusStatusenumdeclined | accepted
createdAtCreated Attimestamp