Package org.hl7.fhir.r5.model

Class ElementDefinition.ElementDefinitionObligationComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionObligationComponent

All Implemented Interfaces:

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

Enclosing class:

ElementDefinition

public static class ElementDefinition.ElementDefinitionObligationComponent
extends Element
implements org.hl7.fhir.instance.model.api.IBaseDatatypeElement

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<CanonicalType>	actor	Actor(s) to which the obligation applies.
protected Coding	code	Codes, potentially combination code, that describe the obligations that apply to implementing applications.
protected MarkdownType	documentation	Human readable documentation of the purpose or application of the obligation.
protected StringType	filter	A FHIRPath expression that restricts to the obligation to one of a set of repeats.
protected StringType	filterDocumentation	Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.
protected List<UriType>	process	A process that the obligation applies to.
protected List<UsageContext>	usage	Qualifies the usage of the obligation.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ElementDefinitionObligationComponent()	Constructor
ElementDefinitionObligationComponent(Coding code)	Constructor

Method Summary

Modifier and Type	Method	Description
ElementDefinition.ElementDefinitionObligationComponent	addActor(String value)
CanonicalType	addActorElement()
Base	addChild(String name)
ElementDefinition.ElementDefinitionObligationComponent	addProcess(String value)
UriType	addProcessElement()
UsageContext	addUsage()
ElementDefinition.ElementDefinitionObligationComponent	addUsage(UsageContext t)
ElementDefinition.ElementDefinitionObligationComponent	copy()
void	copyValues(ElementDefinition.ElementDefinitionObligationComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CanonicalType>	getActor()
Coding	getCode()
String	getDocumentation()
MarkdownType	getDocumentationElement()
String	getFilter()
String	getFilterDocumentation()
StringType	getFilterDocumentationElement()
StringType	getFilterElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<UriType>	getProcess()
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
List<UsageContext>	getUsage()
UsageContext	getUsageFirstRep()
boolean	hasActor()
boolean	hasActor(String value)
boolean	hasCode()
boolean	hasDocumentation()
boolean	hasDocumentationElement()
boolean	hasFilter()
boolean	hasFilterDocumentation()
boolean	hasFilterDocumentationElement()
boolean	hasFilterElement()
boolean	hasProcess()
boolean	hasProcess(String value)
boolean	hasUsage()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ElementDefinition.ElementDefinitionObligationComponent	setActor(List<CanonicalType> theActor)
ElementDefinition.ElementDefinitionObligationComponent	setCode(Coding value)
ElementDefinition.ElementDefinitionObligationComponent	setDocumentation(String value)
ElementDefinition.ElementDefinitionObligationComponent	setDocumentationElement(MarkdownType value)
ElementDefinition.ElementDefinitionObligationComponent	setFilter(String value)
ElementDefinition.ElementDefinitionObligationComponent	setFilterDocumentation(String value)
ElementDefinition.ElementDefinitionObligationComponent	setFilterDocumentationElement(StringType value)
ElementDefinition.ElementDefinitionObligationComponent	setFilterElement(StringType value)
ElementDefinition.ElementDefinitionObligationComponent	setProcess(List<UriType> theProcess)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ElementDefinition.ElementDefinitionObligationComponent	setUsage(List<UsageContext> theUsage)

Methods inherited from class org.hl7.fhir.r5.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.r5.model.Base

addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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

Field Details

code

protected Coding code

Codes, potentially combination code, that describe the obligations that apply to implementing applications.

actor

protected List<CanonicalType> actor

Actor(s) to which the obligation applies.

documentation

protected MarkdownType documentation

Human readable documentation of the purpose or application of the obligation.

usage

protected List<UsageContext> usage

Qualifies the usage of the obligation. Typically obligations are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.

filter

protected StringType filter

A FHIRPath expression that restricts to the obligation to one of a set of repeats.

filterDocumentation

protected StringType filterDocumentation

Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.

process

protected List<UriType> process

A process that the obligation applies to. This might a canonical URL for an OperationDefinition, or some other reference.

Constructor Details

ElementDefinitionObligationComponent

public ElementDefinitionObligationComponent()

Constructor

ElementDefinitionObligationComponent

public ElementDefinitionObligationComponent(Coding code)

Constructor

Method Details

getCode

public Coding getCode()

Returns:

code (Codes, potentially combination code, that describe the obligations that apply to implementing applications.)

hasCode

public boolean hasCode()

setCode

public ElementDefinition.ElementDefinitionObligationComponent setCode(Coding value)

Parameters:

value - code (Codes, potentially combination code, that describe the obligations that apply to implementing applications.)

getActor

public List<CanonicalType> getActor()

Returns:

actor (Actor(s) to which the obligation applies.)

setActor

public ElementDefinition.ElementDefinitionObligationComponent setActor(List<CanonicalType> theActor)

Returns:

Returns a reference to this for easy method chaining

hasActor

public boolean hasActor()

addActorElement

public CanonicalType addActorElement()

Returns:

actor (Actor(s) to which the obligation applies.)

addActor

public ElementDefinition.ElementDefinitionObligationComponent addActor(String value)

Parameters:

value - actor (Actor(s) to which the obligation applies.)

hasActor

public boolean hasActor(String value)

Parameters:

value - actor (Actor(s) to which the obligation applies.)

getDocumentationElement

public MarkdownType getDocumentationElement()

Returns:

documentation (Human readable documentation of the purpose or application of the obligation.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

hasDocumentationElement

public boolean hasDocumentationElement()

hasDocumentation

public boolean hasDocumentation()

setDocumentationElement

public ElementDefinition.ElementDefinitionObligationComponent setDocumentationElement(MarkdownType value)

Parameters:

value - documentation (Human readable documentation of the purpose or application of the obligation.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

getDocumentation

public String getDocumentation()

Returns:

Human readable documentation of the purpose or application of the obligation.

setDocumentation

public ElementDefinition.ElementDefinitionObligationComponent setDocumentation(String value)

Parameters:

value - Human readable documentation of the purpose or application of the obligation.

getUsage

public List<UsageContext> getUsage()

Returns:

usage (Qualifies the usage of the obligation. Typically obligations are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.)

setUsage

public ElementDefinition.ElementDefinitionObligationComponent setUsage(List<UsageContext> theUsage)

Returns:

Returns a reference to this for easy method chaining

hasUsage

public boolean hasUsage()

addUsage

public UsageContext addUsage()

addUsage

public ElementDefinition.ElementDefinitionObligationComponent addUsage(UsageContext t)

getUsageFirstRep

public UsageContext getUsageFirstRep()

Returns:

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

getFilterElement

public StringType getFilterElement()

Returns:

filter (A FHIRPath expression that restricts to the obligation to one of a set of repeats.). This is the underlying object with id, value and extensions. The accessor "getFilter" gives direct access to the value

hasFilterElement

public boolean hasFilterElement()

hasFilter

public boolean hasFilter()

setFilterElement

public ElementDefinition.ElementDefinitionObligationComponent setFilterElement(StringType value)

Parameters:

value - filter (A FHIRPath expression that restricts to the obligation to one of a set of repeats.). This is the underlying object with id, value and extensions. The accessor "getFilter" gives direct access to the value

getFilter

public String getFilter()

Returns:

A FHIRPath expression that restricts to the obligation to one of a set of repeats.

setFilter

public ElementDefinition.ElementDefinitionObligationComponent setFilter(String value)

Parameters:

value - A FHIRPath expression that restricts to the obligation to one of a set of repeats.

getFilterDocumentationElement

public StringType getFilterDocumentationElement()

Returns:

filterDocumentation (Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.). This is the underlying object with id, value and extensions. The accessor "getFilterDocumentation" gives direct access to the value

hasFilterDocumentationElement

public boolean hasFilterDocumentationElement()

hasFilterDocumentation

public boolean hasFilterDocumentation()

setFilterDocumentationElement

public ElementDefinition.ElementDefinitionObligationComponent setFilterDocumentationElement(StringType value)

Parameters:

value - filterDocumentation (Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.). This is the underlying object with id, value and extensions. The accessor "getFilterDocumentation" gives direct access to the value

getFilterDocumentation

public String getFilterDocumentation()

Returns:

Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.

setFilterDocumentation

public ElementDefinition.ElementDefinitionObligationComponent setFilterDocumentation(String value)

Parameters:

value - Documents the FHIRPath expression for the benefit of users who are not familiar with FHIRPath.

getProcess

public List<UriType> getProcess()

Returns:

process (A process that the obligation applies to. This might a canonical URL for an OperationDefinition, or some other reference.)

setProcess

public ElementDefinition.ElementDefinitionObligationComponent setProcess(List<UriType> theProcess)

Returns:

Returns a reference to this for easy method chaining

hasProcess

public boolean hasProcess()

addProcessElement

public UriType addProcessElement()

Returns:

process (A process that the obligation applies to. This might a canonical URL for an OperationDefinition, or some other reference.)

addProcess

public ElementDefinition.ElementDefinitionObligationComponent addProcess(String value)

Parameters:

value - process (A process that the obligation applies to. This might a canonical URL for an OperationDefinition, or some other reference.)

hasProcess

public boolean hasProcess(String value)

Parameters:

value - process (A process that the obligation applies to. This might a canonical URL for an OperationDefinition, or some other reference.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

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

Overrides:

getNamedProperty in class Element

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 Element

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 Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public ElementDefinition.ElementDefinitionObligationComponent copy()

Specified by:

copy in class Element

copyValues

public void copyValues(ElementDefinition.ElementDefinitionObligationComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Element

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class Element