Package com.ibm.fhir.model.resource
Class Consent.Provision
- java.lang.Object
 - 
- com.ibm.fhir.model.visitor.AbstractVisitable
 - 
- com.ibm.fhir.model.type.Element
 - 
- com.ibm.fhir.model.type.BackboneElement
 - 
- com.ibm.fhir.model.resource.Consent.Provision
 
 
 
 
 
- 
- All Implemented Interfaces:
 Visitable
- Enclosing class:
 - Consent
 
public static class Consent.Provision extends BackboneElement
An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConsent.Provision.ActorWho or what is controlled by this rule.static classConsent.Provision.Builderstatic classConsent.Provision.DataThe resources controlled by this rule if specific resources are referenced. 
- 
Field Summary
- 
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension 
 - 
 
- 
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.Provision.Builderbuilder()booleanequals(Object obj)List<CodeableConcept>getAction()Actions controlled by this Rule.List<Consent.Provision.Actor>getActor()Who or what is controlled by this rule.List<Coding>getClazz()The class of information covered by this rule.List<CodeableConcept>getCode()If this code is found in an instance, then the rule applies.List<Consent.Provision.Data>getData()The resources controlled by this rule if specific resources are referenced.PeriodgetDataPeriod()Clinical or Operational Relevant period of time that bounds the data controlled by this rule.PeriodgetPeriod()The timeframe in this rule is valid.List<Consent.Provision>getProvision()Rules which provide exceptions to the base rule or subrules.List<Coding>getPurpose()The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.List<Coding>getSecurityLabel()A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.ConsentProvisionTypegetType()Action to take - permit or deny - when the rule conditions are met.booleanhasChildren()inthashCode()Consent.Provision.BuildertoBuilder()Create a new Builder from the contents of this Element- 
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension 
 - 
 
 - 
 
- 
- 
Method Detail
- 
getType
public ConsentProvisionType getType()
Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.- Returns:
 - An immutable object of type 
ConsentProvisionTypethat may be null. 
 
- 
getPeriod
public Period getPeriod()
The timeframe in this rule is valid.- Returns:
 - An immutable object of type 
Periodthat may be null. 
 
- 
getActor
public List<Consent.Provision.Actor> getActor()
Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').- Returns:
 - An unmodifiable list containing immutable objects of type 
Consent.Provision.Actorthat may be empty. 
 
- 
getAction
public List<CodeableConcept> getAction()
Actions controlled by this Rule.- Returns:
 - An unmodifiable list containing immutable objects of type 
CodeableConceptthat may be empty. 
 
- 
getSecurityLabel
public List<Coding> getSecurityLabel()
A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.- Returns:
 - An unmodifiable list containing immutable objects of type 
Codingthat may be empty. 
 
- 
getPurpose
public List<Coding> getPurpose()
The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.- Returns:
 - An unmodifiable list containing immutable objects of type 
Codingthat may be empty. 
 
- 
getClazz
public List<Coding> getClazz()
The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.- Returns:
 - An unmodifiable list containing immutable objects of type 
Codingthat may be empty. 
 
- 
getCode
public List<CodeableConcept> getCode()
If this code is found in an instance, then the rule applies.- Returns:
 - An unmodifiable list containing immutable objects of type 
CodeableConceptthat may be empty. 
 
- 
getDataPeriod
public Period getDataPeriod()
Clinical or Operational Relevant period of time that bounds the data controlled by this rule.- Returns:
 - An immutable object of type 
Periodthat may be null. 
 
- 
getData
public List<Consent.Provision.Data> getData()
The resources controlled by this rule if specific resources are referenced.- Returns:
 - An unmodifiable list containing immutable objects of type 
Consent.Provision.Datathat may be empty. 
 
- 
getProvision
public List<Consent.Provision> getProvision()
Rules which provide exceptions to the base rule or subrules.- Returns:
 - An unmodifiable list containing immutable objects of type 
Consent.Provisionthat may be empty. 
 
- 
hasChildren
public boolean hasChildren()
- Overrides:
 hasChildrenin classBackboneElement
 
- 
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.Provision.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
 toBuilderin classBackboneElement
 
- 
builder
public static Consent.Provision.Builder builder()
 
 - 
 
 -