Class Consent
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Consent
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.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)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Consent.Builder
static class
Consent.Policy
The references to the policies that are included in this consent scope.static class
Consent.Provision
An exception to the base policy of this consent.static class
Consent.Verification
Whether a treatment instruction (e.g.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Consent.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<CodeableConcept>
getCategory()
A classification of the type of consents found in the statement.DateTime
getDateTime()
When this Consent was issued / created / indexed.java.util.List<Identifier>
getIdentifier()
Unique identifier for this copy of the Consent Statement.java.util.List<Reference>
getOrganization()
The organization that manages the consent, and the framework within which it is executed.Reference
getPatient()
The patient/healthcare consumer to whom this consent applies.java.util.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.java.util.List<Consent.Policy>
getPolicy()
The references to the policies that are included in this consent scope.CodeableConcept
getPolicyRule()
A reference to the specific base computable regulation or policy.Consent.Provision
getProvision()
An exception to the base policy of this consent.CodeableConcept
getScope()
A selector of the type of consent being presented: ADR, Privacy, Treatment, Research.Element
getSource()
The source on which this consent statement is based.ConsentState
getStatus()
Indicates the current state of this consent.java.util.List<Consent.Verification>
getVerification()
Whether a treatment instruction (e.g.boolean
hasChildren()
int
hashCode()
Consent.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.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 java.util.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 java.util.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 java.util.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
Attachment
orReference
that may be null.
-
getPolicy
public java.util.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 java.util.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.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Consent.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static Consent.Builder builder()
-
-