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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Permission.PermissionJustificationComponent
static class	Permission.PermissionProcessingActivityComponent
static class	Permission.PermissionStatus
static class	Permission.PermissionStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	asserter	The person or entity that asserts the permission.
protected List<DateTimeType>	assertionDate	The date that permission was asserted.
protected List<Expression>	dataScope	This can be 1) the definition of data elements, or 2) a category or label) e.g.
protected CodeableConcept	intent	grant|refuse.
protected Permission.PermissionJustificationComponent	justification	The asserted justification for using the data.
protected List<Permission.PermissionProcessingActivityComponent>	processingActivity	A description or definition of which activities are allowed to be done on the data.
protected List<CodeableConcept>	purpose	The purpose for which the permission is given.
static String	SP_STATUS	Search parameter: status
protected Enumeration<Permission.PermissionStatus>	status	Status.
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<CodeableConcept>	usageLimitations	What limits apply to the use of the data.
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, SP_RES_ID, SP_RES_LANGUAGE

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)	Constructor

Method Summary

Modifier and Type	Method	Description
Permission	addAssertionDate(Date value)
DateTimeType	addAssertionDateElement()
Base	addChild(String name)
Expression	addDataScope()
Permission	addDataScope(Expression t)
Permission.PermissionProcessingActivityComponent	addProcessingActivity()
Permission	addProcessingActivity(Permission.PermissionProcessingActivityComponent t)
CodeableConcept	addPurpose()
Permission	addPurpose(CodeableConcept t)
CodeableConcept	addUsageLimitations()
Permission	addUsageLimitations(CodeableConcept t)
Permission	copy()
void	copyValues(Permission dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAsserter()
List<DateTimeType>	getAssertionDate()
List<Expression>	getDataScope()
Expression	getDataScopeFirstRep()
CodeableConcept	getIntent()
Permission.PermissionJustificationComponent	getJustification()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Permission.PermissionProcessingActivityComponent>	getProcessingActivity()
Permission.PermissionProcessingActivityComponent	getProcessingActivityFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getPurpose()
CodeableConcept	getPurposeFirstRep()
ResourceType	getResourceType()
Permission.PermissionStatus	getStatus()
Enumeration<Permission.PermissionStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
List<CodeableConcept>	getUsageLimitations()
CodeableConcept	getUsageLimitationsFirstRep()
Period	getValidity()
boolean	hasAsserter()
boolean	hasAssertionDate()
boolean	hasAssertionDate(Date value)
boolean	hasDataScope()
boolean	hasIntent()
boolean	hasJustification()
boolean	hasProcessingActivity()
boolean	hasPurpose()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasUsageLimitations()
boolean	hasValidity()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Permission	setAsserter(Reference value)
Permission	setAssertionDate(List<DateTimeType> theAssertionDate)
Permission	setDataScope(List<Expression> theDataScope)
Permission	setIntent(CodeableConcept value)
Permission	setJustification(Permission.PermissionJustificationComponent value)
Permission	setProcessingActivity(List<Permission.PermissionProcessingActivityComponent> theProcessingActivity)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Permission	setPurpose(List<CodeableConcept> thePurpose)
Permission	setStatus(Permission.PermissionStatus value)
Permission	setStatusElement(Enumeration<Permission.PermissionStatus> value)
Permission	setUsageLimitations(List<CodeableConcept> theUsageLimitations)
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, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, 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.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, setId

Field Detail

status

protected Enumeration<Permission.PermissionStatus> status

Status.

intent

protected CodeableConcept intent

grant|refuse.

asserter

protected Reference asserter

The person or entity that asserts the permission.

assertionDate

protected List<DateTimeType> assertionDate

The date that permission was asserted.

validity

protected Period validity

The period in which the permission is active.

purpose

protected List<CodeableConcept> purpose

The purpose for which the permission is given.

dataScope

protected List<Expression> dataScope

This can be 1) the definition of data elements, or 2) a category or label) e.g. “sensitive”. It could also be a c) graph-like definition of a set of data elements.

processingActivity

protected List<Permission.PermissionProcessingActivityComponent> processingActivity

A description or definition of which activities are allowed to be done on the data.

justification

protected Permission.PermissionJustificationComponent justification

The asserted justification for using the data.

usageLimitations

protected List<CodeableConcept> usageLimitations

What limits apply to the use of the data.

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 Detail

Permission

public Permission()

Constructor

Permission

public Permission(Permission.PermissionStatus status)

Constructor

Method Detail

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.

getIntent

public CodeableConcept getIntent()

Returns:

intent (grant|refuse.)

hasIntent

public boolean hasIntent()

setIntent

public Permission setIntent(CodeableConcept value)

Parameters:

value - intent (grant|refuse.)

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

getAssertionDate

public List<DateTimeType> getAssertionDate()

Returns:

assertionDate (The date that permission was asserted.)

setAssertionDate

public Permission setAssertionDate(List<DateTimeType> theAssertionDate)

Returns:

Returns a reference to this for easy method chaining

hasAssertionDate

public boolean hasAssertionDate()

addAssertionDateElement

public DateTimeType addAssertionDateElement()

Returns:

assertionDate (The date that permission was asserted.)

addAssertionDate

public Permission addAssertionDate(Date value)

Parameters:

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

hasAssertionDate

public boolean hasAssertionDate(Date value)

Parameters:

value - assertionDate (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.)

getPurpose

public List<CodeableConcept> getPurpose()

Returns:

purpose (The purpose for which the permission is given.)

setPurpose

public Permission setPurpose(List<CodeableConcept> thePurpose)

Returns:

Returns a reference to this for easy method chaining

hasPurpose

public boolean hasPurpose()

addPurpose

public CodeableConcept addPurpose()

addPurpose

public Permission addPurpose(CodeableConcept t)

getPurposeFirstRep

public CodeableConcept getPurposeFirstRep()

Returns:

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

getDataScope

public List<Expression> getDataScope()

Returns:

dataScope (This can be 1) the definition of data elements, or 2) a category or label) e.g. “sensitive”. It could also be a c) graph-like definition of a set of data elements.)

setDataScope

public Permission setDataScope(List<Expression> theDataScope)

Returns:

Returns a reference to this for easy method chaining

hasDataScope

public boolean hasDataScope()

addDataScope

public Expression addDataScope()

addDataScope

public Permission addDataScope(Expression t)

getDataScopeFirstRep

public Expression getDataScopeFirstRep()

Returns:

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

getProcessingActivity

public List<Permission.PermissionProcessingActivityComponent> getProcessingActivity()

Returns:

processingActivity (A description or definition of which activities are allowed to be done on the data.)

setProcessingActivity

public Permission setProcessingActivity(List<Permission.PermissionProcessingActivityComponent> theProcessingActivity)

Returns:

Returns a reference to this for easy method chaining

hasProcessingActivity

public boolean hasProcessingActivity()

addProcessingActivity

public Permission.PermissionProcessingActivityComponent addProcessingActivity()

addProcessingActivity

public Permission addProcessingActivity(Permission.PermissionProcessingActivityComponent t)

getProcessingActivityFirstRep

public Permission.PermissionProcessingActivityComponent getProcessingActivityFirstRep()

Returns:

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

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

getUsageLimitations

public List<CodeableConcept> getUsageLimitations()

Returns:

usageLimitations (What limits apply to the use of the data.)

setUsageLimitations

public Permission setUsageLimitations(List<CodeableConcept> theUsageLimitations)

Returns:

Returns a reference to this for easy method chaining

hasUsageLimitations

public boolean hasUsageLimitations()

addUsageLimitations

public CodeableConcept addUsageLimitations()

addUsageLimitations

public Permission addUsageLimitations(CodeableConcept t)

getUsageLimitationsFirstRep

public CodeableConcept getUsageLimitationsFirstRep()

Returns:

The first repetition of repeating field usageLimitations, 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

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

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