getConsentRecord

Returns details of a single consent record, including when and how the consent occurred.

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

Path Parameters
consentId string — REQUIRED The id of the consent record (as returned by any of the check consent APIs)

Responses

200 Returns consent record details Schema — OPTIONAL id string patientId string studyId object studyVersionId object consentType string Possible values: [DATA_AUTHORIZATION, PATIENT_DIRECTED_DATA_EXCHANGE, FUTURE_DATA_USE] The type of consent that was recorded 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