getPatientConsentDataScopes

Returns all of the data scopes that a patient has consented to disclose across all of their consents for a study.

The study must have been added by the caller's organization.

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

Path Parameters
studyId string — REQUIRED Study id to check consent for

Query Parameters
externalId string Patient external identifier
patientId string HealthEx patient reference ID
mrn string Patient Medical Record Number
phone string Patient phone identifier
email string Patient email identifier

Responses

200 Object containing information which data scopes the patient has consented to. Schema — OPTIONAL consentDataScopes object[] What kinds of data the patient has consented to disclose. 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] consentRecordIds string[] The IDs of the consent records that recorded the relevant consents. These IDs can be used in subsequent API calls to get even more detail fullRecordWithoutRestrictedData boolean Indicates that the patient has consented to disclose their entire medical record. In this case, consentDataScopes can be ignored. pdfUrls array[] — OPTIONAL List of URLs of the PDF of consent records.