A C F G H I O R S T V

A

affectsAllFields() - Method in interface org.phenotips.consents.Consent

A convenience method to determine that all or no fields are affected.

affectsSomeFields() - Method in interface org.phenotips.consents.Consent

A convenience method to determine that at least one field is affected (e.g.

C

Consent - Interface in org.phenotips.consents

Used for representing a single consent; for example in a patient record.

ConsentAuthorizerService - Class in org.phenotips.consents.script

The service exposing DefaultConsentAuthorizer.

ConsentAuthorizerService() - Constructor for class org.phenotips.consents.script.ConsentAuthorizerService

ConsentManager - Interface in org.phenotips.consents

Used for interacting with several consents (represented as Consent) at once; for example loading all consents from a patient and converting them to JSON.

ConsentManagerScriptService - Class in org.phenotips.consents.script

API that provides access to patient consents.

ConsentManagerScriptService() - Constructor for class org.phenotips.consents.script.ConsentManagerScriptService

consentsGloballyEnabled() - Method in class org.phenotips.consents.script.ConsentAuthorizerService

Forwards the call to ConsentAuthorizer.

ConsentStatus - Enum in org.phenotips.consents

Used to indicate the status of a consent, which is not limited to 'granted'/'not granted'.

copy(ConsentStatus) - Method in interface org.phenotips.consents.Consent

Returns a copy of this consent with the given status set instead of the current status.

F

filterEnabled(List<RecordElement>, String) - Method in class org.phenotips.consents.script.ConsentAuthorizerService

Finds a patient by `patientId`, and calls ConsentAuthorizer.filterForm(List, Patient).

fromJSON(JSONArray) - Method in interface org.phenotips.consents.ConsentManager

A convenience function that allows for conversion of JSON representing several consents.

fromString(String) - Static method in enum org.phenotips.consents.ConsentStatus

For converting a string into this Enum.

G

getAllConsentsForPatient(Patient) - Method in interface org.phenotips.consents.ConsentManager

Returns the list of all consents configured in the system, with "granted"/"not granted" status for the given patient for each consent.

getAllConsentsForPatient(String) - Method in interface org.phenotips.consents.ConsentManager

Same as ConsentManager.getAllConsentsForPatient(Patient), for the exception that the patient record lookup happens internally.

getAllConsentsForPatient(String) - Method in class org.phenotips.consents.script.ConsentManagerScriptService

Returns the list of all consents configured in the system, with "granted"/"not granted" status for the given patient for each consent.

getDataFields() - Method in interface org.phenotips.consents.Consent

The list of (UIX) fields only available if consent is granted.

getDescription() - Method in interface org.phenotips.consents.Consent

An optional (potentially long) description which is supposed to be displayed under a consent, possibly with links to external documents such as consent form(s).

getFields() - Method in interface org.phenotips.consents.Consent

The list of (patient form) fields only available if consent is granted.

getId() - Method in interface org.phenotips.consents.Consent

Internally, consents are referred by their identifiers.

getLabel() - Method in interface org.phenotips.consents.Consent

The users never sees the ids of the consents, they only see labels (aka titles).

getMissingConsentsForPatient(Patient) - Method in interface org.phenotips.consents.ConsentManager

Returns the list of consents configured in the system but NOT granted for the patient.

getMissingConsentsForPatient(String) - Method in interface org.phenotips.consents.ConsentManager

Same as ConsentManager.getMissingConsentsForPatient(Patient), for the exception that the patient record lookup happens internally.

getStatus() - Method in interface org.phenotips.consents.Consent

Could be notLoaded/Yes/No.

getSystemConsents() - Method in interface org.phenotips.consents.ConsentManager

The underlying system should have a configuration of different consents available.

grantConsent(Patient, String) - Method in interface org.phenotips.consents.ConsentManager

Grants a specific consent in a patient record.

H

hasConsent(Patient, String) - Method in interface org.phenotips.consents.ConsentManager

Checks if a specific consent is given for the patient record.

hasConsent(String, String) - Method in interface org.phenotips.consents.ConsentManager

Same as ConsentManager.hasConsent(Patient,String), for the exception that the patient record lookup happens internally.

hasConsent(String, String) - Method in class org.phenotips.consents.script.ConsentManagerScriptService

Checks if a specific consent is given for the patient record.

I

isGranted() - Method in interface org.phenotips.consents.Consent

A convenience method to check if Consent status is Yes.

isRequired() - Method in interface org.phenotips.consents.Consent

Some consents are required to for any interaction with a patient record data (viewing, modifying, etc).

isValidConsentId(String) - Method in interface org.phenotips.consents.ConsentManager

Checks if passed in consent id is actually configured (in the system).

O

org.phenotips.consents - package org.phenotips.consents

org.phenotips.consents.script - package org.phenotips.consents.script

R

revokeConsent(Patient, String) - Method in interface org.phenotips.consents.ConsentManager

Revokes a specific consent in a patient record.

S

setPatientConsents(Patient, Iterable<String>) - Method in interface org.phenotips.consents.ConsentManager

Determines if the given ids are present in the system, and grants them on the given patient record.

setStatus(ConsentStatus) - Method in interface org.phenotips.consents.Consent

The status should be dynamically changeable.

T

toJSON() - Method in interface org.phenotips.consents.Consent

Consents should be convertible into a JSON format.

toJSON(Collection<Consent>) - Method in interface org.phenotips.consents.ConsentManager

A convenience function that allows for conversion of a list of consents into a JSONArray containing JSON representations of all consents.

toString() - Method in enum org.phenotips.consents.ConsentStatus

V

valueOf(String) - Static method in enum org.phenotips.consents.ConsentStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.phenotips.consents.ConsentStatus

Returns an array containing the constants of this enum type, in the order they are declared.

A C F G H I O R S T V