getPatientConsents

Returns list of all patient consents for either a single patient or a single project, optionally filtered by additional properties.

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

To ensure system performance, queries must be filtered by at least one of patientId, patientMRN, email, phone, externalId, or projectId.

Only one patient identifier should be provided at a time.

Request Body — REQUIRED
consentTypes string[] — REQUIRED Possible values: [DATA_AUTHORIZATION, PATIENT_DIRECTED_DATA_EXCHANGE, FUTURE_DATA_USE] The type of consent to search for. See documentation for more details on each type.
hasConsented boolean[] Include to change whether to search for only for patients who have consented (the default), patients who have not consented, or both.
patientId string Include to search for only a single patient's consents. This must be a valid HealthEx patient reference id. Only one patient identifier may be included.
patientMRN string Include to search for only a single patient's consents. This must be a valid patient Medical Record Number. Only one patient identifier may be included.
email string Include to search for only a single patient's consents. This must be a valid patient email address. Only one patient identifier may be included.
phone string Include to search for only a single patient's consents. This must be a valid patient phone number. Only one patient identifier may be included.
externalId string Include to search for only a single patient's consents. This must be a valid patient external identifier. Only one patient identifier may be included.
studyId string Include to search only for consents for a specific study.
expiredConsents boolean Include to search for expired consents.
includeReason boolean Include to compute and return the reason for each consent decision.

Responses

200 Returns all matching consent records, grouped by patient Schema — OPTIONAL object[] patientId string The patient that is giving consent consents object[] A list of all the consents (matching the search criteria) that this patient has given consentType string The type of consent that was recorded hasPatientConsented boolean Whether the patient consented or not consentDataScopes object[] What kinds of data the patient has consented to disclose. Null if the patient has not consented. resourceScope 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] sensitivityScope 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] consentRecordId string — OPTIONAL The ID of the consent record that recorded this consent. This ID can be used in subsequent API calls to get even more detail expirationTimestamp date-time — OPTIONAL When this consent record expires, if applicable. pdfUrl string — OPTIONAL The URL of the PDF of the consent record. reason string — OPTIONAL Possible values: [CONSENTED, DECLINED, REVOKED, EXPIRED, NO_RESPONSE] The reason for the consent decision. Only present if includeReason is true. consentRecord object — OPTIONAL The consent record object for this consent. 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 studyId object The study that the consent was recorded for, or null in the case of an IAS consent source string Possible values: [STUDY, DEFAULTS, IAS] If a patient explicitly gave or declined consent for a study, this will be STUDY. If a patient did not give a consent response at all, this will be DEFAULTS. IAS indicates a consent that was given for the patient's own use, and will never be returned by this API.