Package com.ibm.fhir.model.resource

Class Consent

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Consent
extends DomainResource
    A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Unique identifier for this copy of the Consent Statement.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getStatus

        public ConsentState getStatus()
        Indicates the current state of this consent.
        Returns:
        An immutable object of type ConsentState that is non-null.

      • getScope

        public CodeableConcept getScope()
        A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
        Returns:
        An immutable object of type CodeableConcept that is non-null.

      • getCategory

        public List<CodeableConcept> getCategory()
        A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that is non-empty.

      • getPatient

        public Reference getPatient()
        The patient/healthcare consumer to whom this consent applies.
        Returns:
        An immutable object of type Reference that may be null.

      • getDateTime

        public DateTime getDateTime()
        When this Consent was issued / created / indexed.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPerformer

        public List<Reference> getPerformer()
        Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getOrganization

        public List<Reference> getOrganization()
        The organization that manages the consent, and the framework within which it is executed.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getSource

        public Element getSource()
        The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
        Returns:
        An immutable object of type Element that may be null.

      • getPolicy

        public List<Consent.Policy> getPolicy()
        The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
        Returns:
        An unmodifiable list containing immutable objects of type Consent.Policy that may be empty.

      • getPolicyRule

        public CodeableConcept getPolicyRule()
        A reference to the specific base computable regulation or policy.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getVerification

        public List<Consent.Verification> getVerification()
        Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
        Returns:
        An unmodifiable list containing immutable objects of type Consent.Verification that may be empty.

      • getProvision

        public Consent.Provision getProvision()
        An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
        Returns:
        An immutable object of type Consent.Provision that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object