Consent.provisionComponent (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.BackboneElement
    - - org.hl7.fhir.r4.model.Consent.provisionComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Consent
```
public static class Consent.provisionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<CodeableConcept>`	`action` Actions controlled by this Rule.
`protected List<Consent.provisionActorComponent>`	`actor` Who or what is controlled by this rule.
`protected List<Coding>`	`class_` The class of information covered by this rule.
`protected List<CodeableConcept>`	`code` If this code is found in an instance, then the rule applies.
`protected List<Consent.provisionDataComponent>`	`data` The resources controlled by this rule if specific resources are referenced.
`protected Period`	`dataPeriod` Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
`protected Period`	`period` The timeframe in this rule is valid.
`protected List<Consent.provisionComponent>`	`provision` Rules which provide exceptions to the base rule or subrules.
`protected List<Coding>`	`purpose` The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
`protected List<Coding>`	`securityLabel` A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
`protected Enumeration<Consent.ConsentProvisionType>`	`type` Action to take - permit or deny - when the rule conditions are met.

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

provisionComponent()
Constructor

Constructors
Constructor and Description
`provisionComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeableConcept`	`addAction()`
`Consent.provisionComponent`	`addAction(CodeableConcept t)`
`Consent.provisionActorComponent`	`addActor()`
`Consent.provisionComponent`	`addActor(Consent.provisionActorComponent t)`
`Base`	`addChild(String name)`
`Coding`	`addClass_()`
`Consent.provisionComponent`	`addClass_(Coding t)`
`CodeableConcept`	`addCode()`
`Consent.provisionComponent`	`addCode(CodeableConcept t)`
`Consent.provisionDataComponent`	`addData()`
`Consent.provisionComponent`	`addData(Consent.provisionDataComponent t)`
`Consent.provisionComponent`	`addProvision()`
`Consent.provisionComponent`	`addProvision(Consent.provisionComponent t)`
`Coding`	`addPurpose()`
`Consent.provisionComponent`	`addPurpose(Coding t)`
`Coding`	`addSecurityLabel()`
`Consent.provisionComponent`	`addSecurityLabel(Coding t)`
`Consent.provisionComponent`	`copy()`
`void`	`copyValues(Consent.provisionComponent dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<CodeableConcept>`	`getAction()`
`CodeableConcept`	`getActionFirstRep()`
`List<Consent.provisionActorComponent>`	`getActor()`
`Consent.provisionActorComponent`	`getActorFirstRep()`
`List<Coding>`	`getClass_()`
`Coding`	`getClass_FirstRep()`
`List<CodeableConcept>`	`getCode()`
`CodeableConcept`	`getCodeFirstRep()`
`List<Consent.provisionDataComponent>`	`getData()`
`Consent.provisionDataComponent`	`getDataFirstRep()`
`Period`	`getDataPeriod()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Period`	`getPeriod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Consent.provisionComponent>`	`getProvision()`
`Consent.provisionComponent`	`getProvisionFirstRep()`
`List<Coding>`	`getPurpose()`
`Coding`	`getPurposeFirstRep()`
`List<Coding>`	`getSecurityLabel()`
`Coding`	`getSecurityLabelFirstRep()`
`Consent.ConsentProvisionType`	`getType()`
`Enumeration<Consent.ConsentProvisionType>`	`getTypeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAction()`
`boolean`	`hasActor()`
`boolean`	`hasClass_()`
`boolean`	`hasCode()`
`boolean`	`hasData()`
`boolean`	`hasDataPeriod()`
`boolean`	`hasPeriod()`
`boolean`	`hasProvision()`
`boolean`	`hasPurpose()`
`boolean`	`hasSecurityLabel()`
`boolean`	`hasType()`
`boolean`	`hasTypeElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Consent.provisionComponent`	`setAction(List<CodeableConcept> theAction)`
`Consent.provisionComponent`	`setActor(List<Consent.provisionActorComponent> theActor)`
`Consent.provisionComponent`	`setClass_(List<Coding> theClass_)`
`Consent.provisionComponent`	`setCode(List<CodeableConcept> theCode)`
`Consent.provisionComponent`	`setData(List<Consent.provisionDataComponent> theData)`
`Consent.provisionComponent`	`setDataPeriod(Period value)`
`Consent.provisionComponent`	`setPeriod(Period value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Consent.provisionComponent`	`setProvision(List<Consent.provisionComponent> theProvision)`
`Consent.provisionComponent`	`setPurpose(List<Coding> thePurpose)`
`Consent.provisionComponent`	`setSecurityLabel(List<Coding> theSecurityLabel)`
`Consent.provisionComponent`	`setType(Consent.ConsentProvisionType value)`
`Consent.provisionComponent`	`setTypeElement(Enumeration<Consent.ConsentProvisionType> value)`

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

- Field Detail
  - type
```
protected Enumeration<Consent.ConsentProvisionType> type
```
    Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
  - period
```
protected Period period
```
    The timeframe in this rule is valid.
  - actor
```
protected List<Consent.provisionActorComponent> actor
```
    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').
  - action
```
protected List<CodeableConcept> action
```
    Actions controlled by this Rule.
  - securityLabel
```
protected List<Coding> securityLabel
```
    A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
  - purpose
```
protected List<Coding> purpose
```
    The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
  - class_
```
protected List<Coding> class_
```
    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.
  - code
```
protected List<CodeableConcept> code
```
    If this code is found in an instance, then the rule applies.
  - dataPeriod
```
protected Period dataPeriod
```
    Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
  - data
```
protected List<Consent.provisionDataComponent> data
```
    The resources controlled by this rule if specific resources are referenced.
  - provision
```
protected List<Consent.provisionComponent> provision
```
    Rules which provide exceptions to the base rule or subrules.
- Constructor Detail
  - provisionComponent
```
public provisionComponent()
```
    Constructor
- Method Detail
  - getTypeElement
```
public Enumeration<Consent.ConsentProvisionType> getTypeElement()
```
    Returns:
    
    type (Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
  - hasTypeElement
```
public boolean hasTypeElement()
```
  - hasType
```
public boolean hasType()
```
  - setTypeElement
```
public Consent.provisionComponent setTypeElement(Enumeration<Consent.ConsentProvisionType> value)
```
    Parameters:
    
    value - type (Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
  - getType
```
public Consent.ConsentProvisionType getType()
```
    Returns:
    
    Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
  - setType
```
public Consent.provisionComponent setType(Consent.ConsentProvisionType value)
```
    Parameters:
    
    value - Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (The timeframe in this rule is valid.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public Consent.provisionComponent setPeriod(Period value)
```
    Parameters:
    
    value - period (The timeframe in this rule is valid.)
  - getActor
```
public List<Consent.provisionActorComponent> getActor()
```
    Returns:
    
    actor (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').)
  - setActor
```
public Consent.provisionComponent setActor(List<Consent.provisionActorComponent> theActor)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasActor
```
public boolean hasActor()
```
  - addActor
```
public Consent.provisionActorComponent addActor()
```
  - addActor
```
public Consent.provisionComponent addActor(Consent.provisionActorComponent t)
```
  - getActorFirstRep
```
public Consent.provisionActorComponent getActorFirstRep()
```
    Returns:
    
    The first repetition of repeating field actor, creating it if it does not already exist
  - getAction
```
public List<CodeableConcept> getAction()
```
    Returns:
    
    action (Actions controlled by this Rule.)
  - setAction
```
public Consent.provisionComponent setAction(List<CodeableConcept> theAction)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAction
```
public boolean hasAction()
```
  - addAction
```
public CodeableConcept addAction()
```
  - addAction
```
public Consent.provisionComponent addAction(CodeableConcept t)
```
  - getActionFirstRep
```
public CodeableConcept getActionFirstRep()
```
    Returns:
    
    The first repetition of repeating field action, creating it if it does not already exist
  - getSecurityLabel
```
public List<Coding> getSecurityLabel()
```
    Returns:
    
    securityLabel (A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.)
  - setSecurityLabel
```
public Consent.provisionComponent setSecurityLabel(List<Coding> theSecurityLabel)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSecurityLabel
```
public boolean hasSecurityLabel()
```
  - addSecurityLabel
```
public Coding addSecurityLabel()
```
  - addSecurityLabel
```
public Consent.provisionComponent addSecurityLabel(Coding t)
```
  - getSecurityLabelFirstRep
```
public Coding getSecurityLabelFirstRep()
```
    Returns:
    
    The first repetition of repeating field securityLabel, creating it if it does not already exist
  - getPurpose
```
public List<Coding> getPurpose()
```
    Returns:
    
    purpose (The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.)
  - setPurpose
```
public Consent.provisionComponent setPurpose(List<Coding> thePurpose)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasPurpose
```
public boolean hasPurpose()
```
  - addPurpose
```
public Coding addPurpose()
```
  - addPurpose
```
public Consent.provisionComponent addPurpose(Coding t)
```
  - getPurposeFirstRep
```
public Coding getPurposeFirstRep()
```
    Returns:
    
    The first repetition of repeating field purpose, creating it if it does not already exist
  - getClass_
```
public List<Coding> getClass_()
```
    Returns:
    
    class_ (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.)
  - setClass_
```
public Consent.provisionComponent setClass_(List<Coding> theClass_)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasClass_
```
public boolean hasClass_()
```
  - addClass_
```
public Coding addClass_()
```
  - addClass_
```
public Consent.provisionComponent addClass_(Coding t)
```
  - getClass_FirstRep
```
public Coding getClass_FirstRep()
```
    Returns:
    
    The first repetition of repeating field class_, creating it if it does not already exist
  - getCode
```
public List<CodeableConcept> getCode()
```
    Returns:
    
    code (If this code is found in an instance, then the rule applies.)
  - setCode
```
public Consent.provisionComponent setCode(List<CodeableConcept> theCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCode
```
public boolean hasCode()
```
  - addCode
```
public CodeableConcept addCode()
```
  - addCode
```
public Consent.provisionComponent addCode(CodeableConcept t)
```
  - getCodeFirstRep
```
public CodeableConcept getCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field code, creating it if it does not already exist
  - getDataPeriod
```
public Period getDataPeriod()
```
    Returns:
    
    dataPeriod (Clinical or Operational Relevant period of time that bounds the data controlled by this rule.)
  - hasDataPeriod
```
public boolean hasDataPeriod()
```
  - setDataPeriod
```
public Consent.provisionComponent setDataPeriod(Period value)
```
    Parameters:
    
    value - dataPeriod (Clinical or Operational Relevant period of time that bounds the data controlled by this rule.)
  - getData
```
public List<Consent.provisionDataComponent> getData()
```
    Returns:
    
    data (The resources controlled by this rule if specific resources are referenced.)
  - setData
```
public Consent.provisionComponent setData(List<Consent.provisionDataComponent> theData)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasData
```
public boolean hasData()
```
  - addData
```
public Consent.provisionDataComponent addData()
```
  - addData
```
public Consent.provisionComponent addData(Consent.provisionDataComponent t)
```
  - getDataFirstRep
```
public Consent.provisionDataComponent getDataFirstRep()
```
    Returns:
    
    The first repetition of repeating field data, creating it if it does not already exist
  - getProvision
```
public List<Consent.provisionComponent> getProvision()
```
    Returns:
    
    provision (Rules which provide exceptions to the base rule or subrules.)
  - setProvision
```
public Consent.provisionComponent setProvision(List<Consent.provisionComponent> theProvision)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasProvision
```
public boolean hasProvision()
```
  - addProvision
```
public Consent.provisionComponent addProvision()
```
  - addProvision
```
public Consent.provisionComponent addProvision(Consent.provisionComponent t)
```
  - getProvisionFirstRep
```
public Consent.provisionComponent getProvisionFirstRep()
```
    Returns:
    
    The first repetition of repeating field provision, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - copy
```
public Consent.provisionComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - copyValues
```
public void copyValues(Consent.provisionComponent dst)
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class BackboneElement

Class Consent.provisionComponent

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement

Fields inherited from class org.hl7.fhir.r4.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement

Methods inherited from class org.hl7.fhir.r4.model.Element

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

Field Detail

type

period

actor

action

securityLabel

purpose

class_

code

dataPeriod

data

provision

Constructor Detail

provisionComponent

Method Detail

getTypeElement

hasTypeElement

hasType

setTypeElement

getType

setType

getPeriod

hasPeriod

setPeriod

getActor

setActor

hasActor

addActor

addActor

getActorFirstRep

getAction

setAction

hasAction

addAction

addAction

getActionFirstRep

getSecurityLabel

setSecurityLabel

hasSecurityLabel

addSecurityLabel

addSecurityLabel

getSecurityLabelFirstRep

getPurpose

setPurpose

hasPurpose

addPurpose

addPurpose

getPurposeFirstRep

getClass_

setClass_

hasClass_

addClass_

addClass_

getClass_FirstRep

getCode

setCode

hasCode

addCode

addCode

getCodeFirstRep

getDataPeriod

hasDataPeriod

setDataPeriod

getData

setData

hasData