Package org.hl7.fhir.dstu3.model

Class Consent.ExceptComponent

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.BackboneElement

org.hl7.fhir.dstu3.model.Consent.ExceptComponent

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.ExceptComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	action	Actions controlled by this Exception.
protected List<Consent.ExceptActorComponent>	actor	Who or what is controlled by this Exception.
protected List<Coding>	class_	The class of information covered by this exception.
protected List<Coding>	code	If this code is found in an instance, then the exception applies.
protected List<Consent.ExceptDataComponent>	data	The resources controlled by this exception, if specific resources are referenced.
protected Period	dataPeriod	Clinical or Operational Relevant period of time that bounds the data controlled by this exception.
protected Period	period	The timeframe in this exception is valid.
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 exception.
protected List<Coding>	securityLabel	A set of security labels that define which resources are controlled by this exception.
protected Enumeration<Consent.ConsentExceptType>	type	Action to take - permit or deny - when the exception conditions are met.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ExceptComponent()	Constructor
ExceptComponent(Enumeration<Consent.ConsentExceptType> type)	Constructor

Method Summary

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

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

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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.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

type

protected Enumeration<Consent.ConsentExceptType> type

Action to take - permit or deny - when the exception conditions are met.

period

protected Period period

The timeframe in this exception is valid.

actor

protected List<Consent.ExceptActorComponent> actor

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

securityLabel

protected List<Coding> securityLabel

A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.

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

class_

protected List<Coding> class_

The class of information covered by this exception. 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<Coding> code

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

dataPeriod

protected Period dataPeriod

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

data

protected List<Consent.ExceptDataComponent> data

The resources controlled by this exception, if specific resources are referenced.

Constructor Details

ExceptComponent

public ExceptComponent()

Constructor

ExceptComponent

public ExceptComponent(Enumeration<Consent.ConsentExceptType> type)

Constructor

Method Details

getTypeElement

public Enumeration<Consent.ConsentExceptType> getTypeElement()

Returns:

type (Action to take - permit or deny - when the exception conditions are met.). 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.ExceptComponent setTypeElement(Enumeration<Consent.ConsentExceptType> value)

Parameters:

value - type (Action to take - permit or deny - when the exception conditions are met.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Consent.ConsentExceptType getType()

Returns:

Action to take - permit or deny - when the exception conditions are met.

setType

public Consent.ExceptComponent setType(Consent.ConsentExceptType value)

Parameters:

value - Action to take - permit or deny - when the exception conditions are met.

getPeriod

public Period getPeriod()

Returns:

period (The timeframe in this exception is valid.)

hasPeriod

public boolean hasPeriod()

setPeriod

public Consent.ExceptComponent setPeriod(Period value)

Parameters:

value - period (The timeframe in this exception is valid.)

getActor

public List<Consent.ExceptActorComponent> getActor()

Returns:

actor (Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').)

setActor

public Consent.ExceptComponent setActor(List<Consent.ExceptActorComponent> theActor)

Returns:

Returns a reference to this for easy method chaining

hasActor

public boolean hasActor()

addActor

public Consent.ExceptActorComponent addActor()

addActor

public Consent.ExceptComponent addActor(Consent.ExceptActorComponent t)

getActorFirstRep

public Consent.ExceptActorComponent 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 Exception.)

setAction

public Consent.ExceptComponent 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.ExceptComponent 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 set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.)

setSecurityLabel

public Consent.ExceptComponent 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.ExceptComponent 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 exception.)

setPurpose

public Consent.ExceptComponent 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.ExceptComponent 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 exception. 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.ExceptComponent 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.ExceptComponent 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<Coding> getCode()

Returns:

code (If this code is found in an instance, then the exception applies.)

setCode

public Consent.ExceptComponent setCode(List<Coding> theCode)

Returns:

Returns a reference to this for easy method chaining

hasCode

public boolean hasCode()

addCode

public Coding addCode()

addCode

public Consent.ExceptComponent addCode(Coding t)

getCodeFirstRep

public Coding 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 exception.)

hasDataPeriod

public boolean hasDataPeriod()

setDataPeriod

public Consent.ExceptComponent setDataPeriod(Period value)

Parameters:

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

getData

public List<Consent.ExceptDataComponent> getData()

Returns:

data (The resources controlled by this exception, if specific resources are referenced.)

setData

public Consent.ExceptComponent setData(List<Consent.ExceptDataComponent> theData)

Returns:

Returns a reference to this for easy method chaining

hasData

public boolean hasData()

addData

public Consent.ExceptDataComponent addData()

addData

public Consent.ExceptComponent addData(Consent.ExceptDataComponent t)

getDataFirstRep

public Consent.ExceptDataComponent getDataFirstRep()

Returns:

The first repetition of repeating field data, 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.ExceptComponent copy()

Specified by:

copy in class BackboneElement

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