Package org.hl7.fhir.r5.model

Class Consent.ProvisionComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.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

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	action	Actions controlled by this provision.
protected List<Consent.ProvisionActorComponent>	actor	Who or what is controlled by this provision.
protected List<CodeableConcept>	code	If this code is found in an instance, then the provision applies.
protected List<Consent.ProvisionDataComponent>	data	The resources controlled by this provision if specific resources are referenced.
protected Period	dataPeriod	Clinical or Operational Relevant period of time that bounds the data controlled by this provision.
protected List<Coding>	documentType	The documentType(s) covered by this provision.
protected Expression	expression	A computable (FHIRPath or other) definition of what is controlled by this consent.
protected Period	period	Timeframe for this provision.
protected List<Consent.ProvisionComponent>	provision	Provisions which provide exceptions to the base provision or subprovisions.
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 provision.
protected List<Coding>	resourceType	The resourceType(s) covered by this provision.
protected List<Coding>	securityLabel	A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ProvisionComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAction()
Consent.ProvisionComponent	addAction(CodeableConcept t)
Consent.ProvisionActorComponent	addActor()
Consent.ProvisionComponent	addActor(Consent.ProvisionActorComponent t)
Base	addChild(String name)
CodeableConcept	addCode()
Consent.ProvisionComponent	addCode(CodeableConcept t)
Consent.ProvisionDataComponent	addData()
Consent.ProvisionComponent	addData(Consent.ProvisionDataComponent t)
Coding	addDocumentType()
Consent.ProvisionComponent	addDocumentType(Coding t)
Consent.ProvisionComponent	addProvision()
Consent.ProvisionComponent	addProvision(Consent.ProvisionComponent t)
Coding	addPurpose()
Consent.ProvisionComponent	addPurpose(Coding t)
Coding	addResourceType()
Consent.ProvisionComponent	addResourceType(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<CodeableConcept>	getCode()
CodeableConcept	getCodeFirstRep()
List<Consent.ProvisionDataComponent>	getData()
Consent.ProvisionDataComponent	getDataFirstRep()
Period	getDataPeriod()
List<Coding>	getDocumentType()
Coding	getDocumentTypeFirstRep()
Expression	getExpression()
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>	getResourceType()
Coding	getResourceTypeFirstRep()
List<Coding>	getSecurityLabel()
Coding	getSecurityLabelFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAction()
boolean	hasActor()
boolean	hasCode()
boolean	hasData()
boolean	hasDataPeriod()
boolean	hasDocumentType()
boolean	hasExpression()
boolean	hasPeriod()
boolean	hasProvision()
boolean	hasPurpose()
boolean	hasResourceType()
boolean	hasSecurityLabel()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Consent.ProvisionComponent	setAction(List<CodeableConcept> theAction)
Consent.ProvisionComponent	setActor(List<Consent.ProvisionActorComponent> theActor)
Consent.ProvisionComponent	setCode(List<CodeableConcept> theCode)
Consent.ProvisionComponent	setData(List<Consent.ProvisionDataComponent> theData)
Consent.ProvisionComponent	setDataPeriod(Period value)
Consent.ProvisionComponent	setDocumentType(List<Coding> theDocumentType)
Consent.ProvisionComponent	setExpression(Expression 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	setResourceType(List<Coding> theResourceType)
Consent.ProvisionComponent	setSecurityLabel(List<Coding> theSecurityLabel)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

period

protected Period period

Timeframe for this provision.

actor

protected List<Consent.ProvisionActorComponent> actor

Who or what is controlled by this provision. 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 provision.

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 provision.

documentType

protected List<Coding> documentType

The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.

resourceType

protected List<Coding> resourceType

The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.

code

protected List<CodeableConcept> code

If this code is found in an instance, then the provision applies.

dataPeriod

protected Period dataPeriod

Clinical or Operational Relevant period of time that bounds the data controlled by this provision.

data

protected List<Consent.ProvisionDataComponent> data

The resources controlled by this provision if specific resources are referenced.

expression

protected Expression expression

A computable (FHIRPath or other) definition of what is controlled by this consent.

provision

protected List<Consent.ProvisionComponent> provision

Provisions which provide exceptions to the base provision or subprovisions.

Constructor Details

ProvisionComponent

public ProvisionComponent()

Constructor

Method Details

getPeriod

public Period getPeriod()

Returns:

period (Timeframe for this provision.)

hasPeriod

public boolean hasPeriod()

setPeriod

public Consent.ProvisionComponent setPeriod(Period value)

Parameters:

value - period (Timeframe for this provision.)

getActor

public List<Consent.ProvisionActorComponent> getActor()

Returns:

actor (Who or what is controlled by this provision. 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 {3}

getAction

public List<CodeableConcept> getAction()

Returns:

action (Actions controlled by this provision.)

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 {3}

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 {3}

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 provision.)

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 {3}

getDocumentType

public List<Coding> getDocumentType()

Returns:

documentType (The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.)

setDocumentType

public Consent.ProvisionComponent setDocumentType(List<Coding> theDocumentType)

Returns:

Returns a reference to this for easy method chaining

hasDocumentType

public boolean hasDocumentType()

addDocumentType

public Coding addDocumentType()

addDocumentType

public Consent.ProvisionComponent addDocumentType(Coding t)

getDocumentTypeFirstRep

public Coding getDocumentTypeFirstRep()

Returns:

The first repetition of repeating field documentType, creating it if it does not already exist {3}

getResourceType

public List<Coding> getResourceType()

Returns:

resourceType (The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.)

setResourceType

public Consent.ProvisionComponent setResourceType(List<Coding> theResourceType)

Returns:

Returns a reference to this for easy method chaining

hasResourceType

public boolean hasResourceType()

addResourceType

public Coding addResourceType()

addResourceType

public Consent.ProvisionComponent addResourceType(Coding t)

getResourceTypeFirstRep

public Coding getResourceTypeFirstRep()

Returns:

The first repetition of repeating field resourceType, creating it if it does not already exist {3}

getCode

public List<CodeableConcept> getCode()

Returns:

code (If this code is found in an instance, then the provision 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 {3}

getDataPeriod

public Period getDataPeriod()

Returns:

dataPeriod (Clinical or Operational Relevant period of time that bounds the data controlled by this provision.)

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 provision.)

getData

public List<Consent.ProvisionDataComponent> getData()

Returns:

data (The resources controlled by this provision 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 {3}

getExpression

public Expression getExpression()

Returns:

expression (A computable (FHIRPath or other) definition of what is controlled by this consent.)

hasExpression

public boolean hasExpression()

setExpression

public Consent.ProvisionComponent setExpression(Expression value)

Parameters:

value - expression (A computable (FHIRPath or other) definition of what is controlled by this consent.)

getProvision

public List<Consent.ProvisionComponent> getProvision()

Returns:

provision (Provisions which provide exceptions to the base provision or subprovisions.)

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 {3}

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)