Skip to main content

Getting Consent Screenshots

If you need to audit a patient's consent, one of the most valuable things you can do is see exactly what the patient saw when they consented.

This visual proof is crucial because the contents of a consent flow can change over time. Common reasons for this include:

  • The study's content or terms were amended.
  • The HealthEx application UI was updated.

Having a definitive record of exactly what the patient saw is your best defense in the event of a dispute over what was consented to.

HealthEx solves this by capturing screenshots of every single page the user visits during the consent process. These screenshots are then associated with the consent record and become queryable via the HealthEx API.

See Getting Consent Record Details for instructions on how to identify a specific consent record ID.

Example Request​

For this example, we will retrieve the screenshots for Consent Record ID 21.

Make a GET request to the /consents/{id}/screenshot endpoint:

GET https://api.healthex.io/v1/consents/21/screenshot
Accept: application/json
Authorization: Bearer <your JWT token>
Authentication Required

This API requires a valid JWT token. See the Authentication guide for setup instructions.

Response Payload​

The response body returns an array of objects, with each object representing a "step" or "screen" the patient interacted with during the consent process:

[
    {
        "step": 1,
        "name": "PRESCREEN_WELCOME",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-welcome.png"
    },
    {
        "step": 2,
        "name": "PRESCREEN_BILL_OF_RIGHTS",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-bill-of-rights.png"
    },
    {
        "step": 3,
        "name": "PRESCREEN_STUDY_INFORMATION",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-study-information.png"
    },
    {
        "step": 4,
        "name": "PRESCREEN_RISKS_AND_BENEFITS",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-risks-and-benefits.png"
    },
    {
        "step": 5,
        "name": "PRESCREEN_SENSITIVE_DATA_CONFIRMATION",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-sensitive-data-confirmation.png"
    },
    {
        "step": 6,
        "name": "PRESCREEN_INFORMED_CONSENT",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-informed-consent.png"
    },
    {
        "step": 7,
        "name": "PRESCREEN_HIPAA_AUTHORIZATION",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-hipaa-authorization.png"
    },
    {
        "step": 8,
        "name": "PRESCREEN_CONFIRMED",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-confirmed.png"
    },
    {
        "step": 9,
        "name": "PRESCREEN_DECLINED",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-declined.png"
    },
    {
        "step": 10,
        "name": "PRESCREEN_AGE_RESTRICTED",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-age-restricted.png"
    },
    {
        "step": 11,
        "name": "PRESCREEN_NOT_RECRUITING",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-not-recruiting.png"
    },
    {
        "step": 12,
        "name": "PRESCREEN_WELCOME_BACK",
        "imageUrl": "https://healthex-consent-screenshots.s3.us-west-2.amazonaws.com/0a7f8266-60ae-93ec-ba6b/PER_STUDY_PRESCREEN/prescreen-welcome-back.png"
    }
]

Response Fields​

FieldTypeDescription
stepintegerThe chronological order in which the screen appeared to the patient.
namestringThe unique identifier or name of the specific screen.
imageUrlstringA direct link to a PNG image capturing the screen exactly as the patient saw it.
Publicly Accessible URLs

All imageUrl links returned in the payload are publicly accessible. They can be downloaded or reviewed at any time without requiring additional authentication.