getConsentRecords

Returns a list of all consent records for a specific patient within the authenticated organization, with optional filtering by last modified date.

Results are restricted to records for projects added by the caller's organization.

Only one patient identifier should be provided as a query parameter.

Path Parameters
projectId string — REQUIRED Project id to fetch consent records for

Query Parameters
limit number Maximum number of results to return (default: 100, max: 1000)
offset number Number of results to skip for pagination (default: 0)
mrn string Patient Medical Record Number
externalId string Patient external identifier
patientId string HealthEx patient reference ID
phone string Patient phone identifier
email string Patient email identifier

Header Parameters
If-Modified-Since string Optional. RFC 2822 date string. If provided, only returns consent records modified after this date. If not provided, returns all consent records.

Responses

200 Returns list of consent records with screenshots Schema — OPTIONAL total number results object[] consentRecord object id string patientId string studyId object studyVersionId object consentType string Possible values: [DATA_AUTHORIZATION, PATIENT_DIRECTED_DATA_EXCHANGE, FUTURE_DATA_USE] consentStatus string Possible values: [OPTED_IN, OPTED_OUT] timestamp date-time expirationTimestamp date-time consentStats object — OPTIONAL studySnapshotId object consentConfigSnapshotId object consentUIFlow string Possible values: [PATIENT_DIRECTED_DATA_EXCHANGE] uiHash object language object fullRecordWithoutRestrictedData object — OPTIONAL consentDataResourceScopes string[] Possible values: [CONTACT_INFO, MEDICATIONS, ALLERGIES, DIAGNOSES, LABS, DEMOGRAPHICS, CLINICAL_NOTES, VISITS, DIAGNOSTIC_REPORTS, CLINICAL_VITALS, PROCEDURES, IMMUNIZATIONS, IMAGING, TREATMENT_PLAN, GENOMIC_DATA, FAMILY_HISTORY, SOCIAL_HISTORY, ADMINISTRATIVE_AND_BILLING] consentDataSensitivityScopes string[] Possible values: [NORMAL, HIV_OR_STI, SUBSTANCE_USE_OR_DRUG_ABUSE, MENTAL_HEALTH, GENETIC_TESTING, REPRODUCTIVE_HEALTH_DATA, PSYCHOTHERAPY_NOTES, SUD_PART_2, SICKLE_CELL] providerId object patientName object signerName object signingReason object pagesViewed string[] mp4Url object posterUrl object consentedByLink object providerSignerName object pdfUrl string