Package com.ibm.fhir.model.resource
Class Consent
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConsent.Builderstatic classConsent.PolicyThe references to the policies that are included in this consent scope.static classConsent.ProvisionAn exception to the base policy of this consent.static classConsent.VerificationWhether a treatment instruction (e.g.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static Consent.Builderbuilder()booleanequals(Object obj)List<CodeableConcept>getCategory()A classification of the type of consents found in the statement.DateTimegetDateTime()When this Consent was issued / created / indexed.List<Identifier>getIdentifier()Unique identifier for this copy of the Consent Statement.List<Reference>getOrganization()The organization that manages the consent, and the framework within which it is executed.ReferencegetPatient()The patient/healthcare consumer to whom this consent applies.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.List<Consent.Policy>getPolicy()The references to the policies that are included in this consent scope.CodeableConceptgetPolicyRule()A reference to the specific base computable regulation or policy.Consent.ProvisiongetProvision()An exception to the base policy of this consent.CodeableConceptgetScope()A selector of the type of consent being presented: ADR, Privacy, Treatment, Research.ElementgetSource()The source on which this consent statement is based.ConsentStategetStatus()Indicates the current state of this consent.List<Consent.Verification>getVerification()Whether a treatment instruction (e.g.booleanhasChildren()inthashCode()Consent.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
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
Identifierthat may be empty.
-
getStatus
public ConsentState getStatus()
Indicates the current state of this consent.- Returns:
- An immutable object of type
ConsentStatethat 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
CodeableConceptthat 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
CodeableConceptthat is non-empty.
-
getPatient
public Reference getPatient()
The patient/healthcare consumer to whom this consent applies.- Returns:
- An immutable object of type
Referencethat may be null.
-
getDateTime
public DateTime getDateTime()
When this Consent was issued / created / indexed.- Returns:
- An immutable object of type
DateTimethat 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
Referencethat 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
Referencethat 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
Elementthat 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.Policythat may be empty.
-
getPolicyRule
public CodeableConcept getPolicyRule()
A reference to the specific base computable regulation or policy.- Returns:
- An immutable object of type
CodeableConceptthat 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.Verificationthat 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.Provisionthat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept 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:
acceptin interfaceVisitable- Specified by:
acceptin 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
-
toBuilder
public Consent.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static Consent.Builder builder()
-
-