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 is important because it is possible for the contents of the consent flow to change over time. Some of the reasons for this include:

• The study's content might have been amended
• The HealthEx application itself might have been updated

Having a record of exactly what the patient saw is the best defense if a dispute occurs about what exactly the patient consented to!

HealthEx solves this problem by taking screenshots of every single page that the user visited during the consent process. These screenshot are then associated with a consent record, and become queryable by a HealthEx API

Identifying a Consent Record

See Getting Consent Record Details for how to identify a consent record.

Example Values

For this example, we will use the following values:

• Consent Record ID: 21

Making the API Call

To get the screenshots associated with a the consent record, you would make the following API call:

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

This API requires you to pass a JWT token to authenticate. See the Authentication guide for more info.

The response body will look something like this:

[
    {
        "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"
    }
]

The response will consist of an array of objects, with each object representing a "step" or "screen" that the patient went through during the consent process. Each step has a step number and a name, which give the order that the steps occurred as well as a unique name for that step. More importantly, however, is the imageUrl, which provides a URL to a PNG image containing a screenshot of that step, exactly as the patient saw it when they went through the consent flow.

All of the images linked are publicly accessible and can be downloaded at any time and reviewed!