Package org.hl7.fhir.r5.model

Class Permission

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.Permission

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Permission
extends DomainResource

Permission resource holds access rules for a given data and context.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Permission.PermissionJustificationComponent
static enum	Permission.PermissionRuleCombining
static class	Permission.PermissionRuleCombiningEnumFactory
static enum	Permission.PermissionStatus
static class	Permission.PermissionStatusEnumFactory
static class	Permission.RuleActivityComponent
static class	Permission.RuleComponent
static class	Permission.RuleDataComponent
static class	Permission.RuleDataResourceComponent

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 Reference	asserter	The person or entity that asserts the permission.
protected Enumeration<Permission.PermissionRuleCombining>	combining	Defines a procedure for arriving at an access decision given the set of rules.
protected List<DateTimeType>	date	The date that permission was asserted.
protected Permission.PermissionJustificationComponent	justification	The asserted justification for using the data.
protected List<Permission.RuleComponent>	rule	A set of rules.
static final String	SP_STATUS	Search parameter: status
protected Enumeration<Permission.PermissionStatus>	status	Status.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Period	validity	The period in which the permission is active.

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Permission()	Constructor
Permission(Permission.PermissionStatus status, Permission.PermissionRuleCombining combining)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Permission	addDate(Date value)
DateTimeType	addDateElement()
Permission.RuleComponent	addRule()
Permission	addRule(Permission.RuleComponent t)
Permission	copy()
void	copyValues(Permission dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAsserter()
Permission.PermissionRuleCombining	getCombining()
Enumeration<Permission.PermissionRuleCombining>	getCombiningElement()
List<DateTimeType>	getDate()
Permission.PermissionJustificationComponent	getJustification()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<Permission.RuleComponent>	getRule()
Permission.RuleComponent	getRuleFirstRep()
Permission.PermissionStatus	getStatus()
Enumeration<Permission.PermissionStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
Period	getValidity()
boolean	hasAsserter()
boolean	hasCombining()
boolean	hasCombiningElement()
boolean	hasDate()
boolean	hasDate(Date value)
boolean	hasJustification()
boolean	hasRule()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasValidity()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Permission	setAsserter(Reference value)
Permission	setCombining(Permission.PermissionRuleCombining value)
Permission	setCombiningElement(Enumeration<Permission.PermissionRuleCombining> value)
Permission	setDate(List<DateTimeType> theDate)
Permission	setJustification(Permission.PermissionJustificationComponent value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Permission	setRule(List<Permission.RuleComponent> theRule)
Permission	setStatus(Permission.PermissionStatus value)
Permission	setStatusElement(Enumeration<Permission.PermissionStatus> value)
Permission	setValidity(Period value)
protected Permission	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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, 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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

status

protected Enumeration<Permission.PermissionStatus> status

Status.

asserter

protected Reference asserter

The person or entity that asserts the permission.

date

protected List<DateTimeType> date

The date that permission was asserted.

validity

protected Period validity

The period in which the permission is active.

justification

protected Permission.PermissionJustificationComponent justification

The asserted justification for using the data.

combining

protected Enumeration<Permission.PermissionRuleCombining> combining

Defines a procedure for arriving at an access decision given the set of rules.

rule

protected List<Permission.RuleComponent> rule

A set of rules.

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: active | entered-in-error | draft | rejected
Type: token
Path: Permission.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: active | entered-in-error | draft | rejected
Type: token
Path: Permission.status

Constructor Details

Permission

public Permission()

Constructor

Permission

public Permission(Permission.PermissionStatus status,
 Permission.PermissionRuleCombining combining)

Constructor

Method Details

getStatusElement

public Enumeration<Permission.PermissionStatus> getStatusElement()

Returns:

status (Status.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Permission setStatusElement(Enumeration<Permission.PermissionStatus> value)

Parameters:

value - status (Status.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Permission.PermissionStatus getStatus()

Returns:

Status.

setStatus

public Permission setStatus(Permission.PermissionStatus value)

Parameters:

value - Status.

getAsserter

public Reference getAsserter()

Returns:

asserter (The person or entity that asserts the permission.)

hasAsserter

public boolean hasAsserter()

setAsserter

public Permission setAsserter(Reference value)

Parameters:

value - asserter (The person or entity that asserts the permission.)

getDate

public List<DateTimeType> getDate()

Returns:

date (The date that permission was asserted.)

setDate

public Permission setDate(List<DateTimeType> theDate)

Returns:

Returns a reference to this for easy method chaining

hasDate

public boolean hasDate()

addDateElement

public DateTimeType addDateElement()

Returns:

date (The date that permission was asserted.)

addDate

public Permission addDate(Date value)

Parameters:

value - date (The date that permission was asserted.)

hasDate

public boolean hasDate(Date value)

Parameters:

value - date (The date that permission was asserted.)

getValidity

public Period getValidity()

Returns:

validity (The period in which the permission is active.)

hasValidity

public boolean hasValidity()

setValidity

public Permission setValidity(Period value)

Parameters:

value - validity (The period in which the permission is active.)

getJustification

public Permission.PermissionJustificationComponent getJustification()

Returns:

justification (The asserted justification for using the data.)

hasJustification

public boolean hasJustification()

setJustification

public Permission setJustification(Permission.PermissionJustificationComponent value)

Parameters:

value - justification (The asserted justification for using the data.)

getCombiningElement

public Enumeration<Permission.PermissionRuleCombining> getCombiningElement()

Returns:

combining (Defines a procedure for arriving at an access decision given the set of rules.). This is the underlying object with id, value and extensions. The accessor "getCombining" gives direct access to the value

hasCombiningElement

public boolean hasCombiningElement()

hasCombining

public boolean hasCombining()

setCombiningElement

public Permission setCombiningElement(Enumeration<Permission.PermissionRuleCombining> value)

Parameters:

value - combining (Defines a procedure for arriving at an access decision given the set of rules.). This is the underlying object with id, value and extensions. The accessor "getCombining" gives direct access to the value

getCombining

public Permission.PermissionRuleCombining getCombining()

Returns:

Defines a procedure for arriving at an access decision given the set of rules.

setCombining

public Permission setCombining(Permission.PermissionRuleCombining value)

Parameters:

value - Defines a procedure for arriving at an access decision given the set of rules.

getRule

public List<Permission.RuleComponent> getRule()

Returns:

rule (A set of rules.)

setRule

public Permission setRule(List<Permission.RuleComponent> theRule)

Returns:

Returns a reference to this for easy method chaining

hasRule

public boolean hasRule()

addRule

public Permission.RuleComponent addRule()

addRule

public Permission addRule(Permission.RuleComponent t)

getRuleFirstRep

public Permission.RuleComponent getRuleFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

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

copy

public Permission copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Permission dst)

typedCopy

protected Permission typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource