Package org.hl7.fhir.r5.model

Class Requirements.RequirementsStatementComponent

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.Requirements.RequirementsStatementComponent

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:

Requirements

public static class Requirements.RequirementsStatementComponent
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 BooleanType	conditionality	This boolean flag is set to true of the text of the requirement is conditional on something e.g.
protected List<Enumeration<Requirements.ConformanceExpectation>>	conformance	A short human usable label for this statement.
protected StringType	derivedFrom	Another statement on one of the requirements that this requirement clarifies or restricts.
protected IdType	key	Key that identifies this statement (unique within this resource).
protected StringType	label	A short human usable label for this statement.
protected StringType	parent	A larger requirement that this requirement helps to refine and enable.
protected List<UrlType>	reference	A reference to another artifact that created this requirement.
protected MarkdownType	requirement	The actual requirement for human consumption.
protected List<UrlType>	satisfiedBy	A reference to another artifact that satisfies this requirement.
protected List<Reference>	source	Who asked for this statement to be a requirement.

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
RequirementsStatementComponent()	Constructor
RequirementsStatementComponent(String key, String requirement)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Requirements.RequirementsStatementComponent	addConformance(Requirements.ConformanceExpectation value)
Enumeration<Requirements.ConformanceExpectation>	addConformanceElement()
Requirements.RequirementsStatementComponent	addReference(String value)
UrlType	addReferenceElement()
Requirements.RequirementsStatementComponent	addSatisfiedBy(String value)
UrlType	addSatisfiedByElement()
Reference	addSource()
Requirements.RequirementsStatementComponent	addSource(Reference t)
Requirements.RequirementsStatementComponent	copy()
void	copyValues(Requirements.RequirementsStatementComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getConditionality()
BooleanType	getConditionalityElement()
List<Enumeration<Requirements.ConformanceExpectation>>	getConformance()
String	getDerivedFrom()
StringType	getDerivedFromElement()
String	getKey()
IdType	getKeyElement()
String	getLabel()
StringType	getLabelElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getParent()
StringType	getParentElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<UrlType>	getReference()
String	getRequirement()
MarkdownType	getRequirementElement()
List<UrlType>	getSatisfiedBy()
List<Reference>	getSource()
Reference	getSourceFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasConditionality()
boolean	hasConditionalityElement()
boolean	hasConformance()
boolean	hasConformance(Requirements.ConformanceExpectation value)
boolean	hasDerivedFrom()
boolean	hasDerivedFromElement()
boolean	hasKey()
boolean	hasKeyElement()
boolean	hasLabel()
boolean	hasLabelElement()
boolean	hasParent()
boolean	hasParentElement()
boolean	hasReference()
boolean	hasReference(String value)
boolean	hasRequirement()
boolean	hasRequirementElement()
boolean	hasSatisfiedBy()
boolean	hasSatisfiedBy(String value)
boolean	hasSource()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Requirements.RequirementsStatementComponent	setConditionality(boolean value)
Requirements.RequirementsStatementComponent	setConditionalityElement(BooleanType value)
Requirements.RequirementsStatementComponent	setConformance(List<Enumeration<Requirements.ConformanceExpectation>> theConformance)
Requirements.RequirementsStatementComponent	setDerivedFrom(String value)
Requirements.RequirementsStatementComponent	setDerivedFromElement(StringType value)
Requirements.RequirementsStatementComponent	setKey(String value)
Requirements.RequirementsStatementComponent	setKeyElement(IdType value)
Requirements.RequirementsStatementComponent	setLabel(String value)
Requirements.RequirementsStatementComponent	setLabelElement(StringType value)
Requirements.RequirementsStatementComponent	setParent(String value)
Requirements.RequirementsStatementComponent	setParentElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Requirements.RequirementsStatementComponent	setReference(List<UrlType> theReference)
Requirements.RequirementsStatementComponent	setRequirement(String value)
Requirements.RequirementsStatementComponent	setRequirementElement(MarkdownType value)
Requirements.RequirementsStatementComponent	setSatisfiedBy(List<UrlType> theSatisfiedBy)
Requirements.RequirementsStatementComponent	setSource(List<Reference> theSource)

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

key

protected IdType key

Key that identifies this statement (unique within this resource).

label

protected StringType label

A short human usable label for this statement.

conformance

protected List<Enumeration<Requirements.ConformanceExpectation>> conformance

A short human usable label for this statement.

conditionality

protected BooleanType conditionality

This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.

requirement

protected MarkdownType requirement

The actual requirement for human consumption.

derivedFrom

protected StringType derivedFrom

Another statement on one of the requirements that this requirement clarifies or restricts.

parent

protected StringType parent

A larger requirement that this requirement helps to refine and enable.

satisfiedBy

protected List<UrlType> satisfiedBy

A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.

reference

protected List<UrlType> reference

A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.

source

protected List<Reference> source

Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters.

Constructor Details

RequirementsStatementComponent

public RequirementsStatementComponent()

Constructor

RequirementsStatementComponent

public RequirementsStatementComponent(String key,
 String requirement)

Constructor

Method Details

getKeyElement

public IdType getKeyElement()

Returns:

key (Key that identifies this statement (unique within this resource).). This is the underlying object with id, value and extensions. The accessor "getKey" gives direct access to the value

hasKeyElement

public boolean hasKeyElement()

hasKey

public boolean hasKey()

setKeyElement

public Requirements.RequirementsStatementComponent setKeyElement(IdType value)

Parameters:

value - key (Key that identifies this statement (unique within this resource).). This is the underlying object with id, value and extensions. The accessor "getKey" gives direct access to the value

getKey

public String getKey()

Returns:

Key that identifies this statement (unique within this resource).

setKey

public Requirements.RequirementsStatementComponent setKey(String value)

Parameters:

value - Key that identifies this statement (unique within this resource).

getLabelElement

public StringType getLabelElement()

Returns:

label (A short human usable label for this statement.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

hasLabelElement

public boolean hasLabelElement()

hasLabel

public boolean hasLabel()

setLabelElement

public Requirements.RequirementsStatementComponent setLabelElement(StringType value)

Parameters:

value - label (A short human usable label for this statement.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

getLabel

public String getLabel()

Returns:

A short human usable label for this statement.

setLabel

public Requirements.RequirementsStatementComponent setLabel(String value)

Parameters:

value - A short human usable label for this statement.

getConformance

public List<Enumeration<Requirements.ConformanceExpectation>> getConformance()

Returns:

conformance (A short human usable label for this statement.)

setConformance

public Requirements.RequirementsStatementComponent setConformance(List<Enumeration<Requirements.ConformanceExpectation>> theConformance)

Returns:

Returns a reference to this for easy method chaining

hasConformance

public boolean hasConformance()

addConformanceElement

public Enumeration<Requirements.ConformanceExpectation> addConformanceElement()

Returns:

conformance (A short human usable label for this statement.)

addConformance

public Requirements.RequirementsStatementComponent addConformance(Requirements.ConformanceExpectation value)

Parameters:

value - conformance (A short human usable label for this statement.)

hasConformance

public boolean hasConformance(Requirements.ConformanceExpectation value)

Parameters:

value - conformance (A short human usable label for this statement.)

getConditionalityElement

public BooleanType getConditionalityElement()

Returns:

conditionality (This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.). This is the underlying object with id, value and extensions. The accessor "getConditionality" gives direct access to the value

hasConditionalityElement

public boolean hasConditionalityElement()

hasConditionality

public boolean hasConditionality()

setConditionalityElement

public Requirements.RequirementsStatementComponent setConditionalityElement(BooleanType value)

Parameters:

value - conditionality (This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.). This is the underlying object with id, value and extensions. The accessor "getConditionality" gives direct access to the value

getConditionality

public boolean getConditionality()

Returns:

This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.

setConditionality

public Requirements.RequirementsStatementComponent setConditionality(boolean value)

Parameters:

value - This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.

getRequirementElement

public MarkdownType getRequirementElement()

Returns:

requirement (The actual requirement for human consumption.). This is the underlying object with id, value and extensions. The accessor "getRequirement" gives direct access to the value

hasRequirementElement

public boolean hasRequirementElement()

hasRequirement

public boolean hasRequirement()

setRequirementElement

public Requirements.RequirementsStatementComponent setRequirementElement(MarkdownType value)

Parameters:

value - requirement (The actual requirement for human consumption.). This is the underlying object with id, value and extensions. The accessor "getRequirement" gives direct access to the value

getRequirement

public String getRequirement()

Returns:

The actual requirement for human consumption.

setRequirement

public Requirements.RequirementsStatementComponent setRequirement(String value)

Parameters:

value - The actual requirement for human consumption.

getDerivedFromElement

public StringType getDerivedFromElement()

Returns:

derivedFrom (Another statement on one of the requirements that this requirement clarifies or restricts.). This is the underlying object with id, value and extensions. The accessor "getDerivedFrom" gives direct access to the value

hasDerivedFromElement

public boolean hasDerivedFromElement()

hasDerivedFrom

public boolean hasDerivedFrom()

setDerivedFromElement

public Requirements.RequirementsStatementComponent setDerivedFromElement(StringType value)

Parameters:

value - derivedFrom (Another statement on one of the requirements that this requirement clarifies or restricts.). This is the underlying object with id, value and extensions. The accessor "getDerivedFrom" gives direct access to the value

getDerivedFrom

public String getDerivedFrom()

Returns:

Another statement on one of the requirements that this requirement clarifies or restricts.

setDerivedFrom

public Requirements.RequirementsStatementComponent setDerivedFrom(String value)

Parameters:

value - Another statement on one of the requirements that this requirement clarifies or restricts.

getParentElement

public StringType getParentElement()

Returns:

parent (A larger requirement that this requirement helps to refine and enable.). This is the underlying object with id, value and extensions. The accessor "getParent" gives direct access to the value

hasParentElement

public boolean hasParentElement()

hasParent

public boolean hasParent()

setParentElement

public Requirements.RequirementsStatementComponent setParentElement(StringType value)

Parameters:

value - parent (A larger requirement that this requirement helps to refine and enable.). This is the underlying object with id, value and extensions. The accessor "getParent" gives direct access to the value

getParent

public String getParent()

Returns:

A larger requirement that this requirement helps to refine and enable.

setParent

public Requirements.RequirementsStatementComponent setParent(String value)

Parameters:

value - A larger requirement that this requirement helps to refine and enable.

getSatisfiedBy

public List<UrlType> getSatisfiedBy()

Returns:

satisfiedBy (A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.)

setSatisfiedBy

public Requirements.RequirementsStatementComponent setSatisfiedBy(List<UrlType> theSatisfiedBy)

Returns:

Returns a reference to this for easy method chaining

hasSatisfiedBy

public boolean hasSatisfiedBy()

addSatisfiedByElement

public UrlType addSatisfiedByElement()

Returns:

satisfiedBy (A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.)

addSatisfiedBy

public Requirements.RequirementsStatementComponent addSatisfiedBy(String value)

Parameters:

value - satisfiedBy (A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.)

hasSatisfiedBy

public boolean hasSatisfiedBy(String value)

Parameters:

value - satisfiedBy (A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.)

getReference

public List<UrlType> getReference()

Returns:

reference (A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.)

setReference

public Requirements.RequirementsStatementComponent setReference(List<UrlType> theReference)

Returns:

Returns a reference to this for easy method chaining

hasReference

public boolean hasReference()

addReferenceElement

public UrlType addReferenceElement()

Returns:

reference (A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.)

addReference

public Requirements.RequirementsStatementComponent addReference(String value)

Parameters:

value - reference (A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.)

hasReference

public boolean hasReference(String value)

Parameters:

value - reference (A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.)

getSource

public List<Reference> getSource()

Returns:

source (Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters.)

setSource

public Requirements.RequirementsStatementComponent setSource(List<Reference> theSource)

Returns:

Returns a reference to this for easy method chaining

hasSource

public boolean hasSource()

addSource

public Reference addSource()

addSource

public Requirements.RequirementsStatementComponent addSource(Reference t)

getSourceFirstRep

public Reference getSourceFirstRep()

Returns:

The first repetition of repeating field source, 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 Requirements.RequirementsStatementComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Requirements.RequirementsStatementComponent 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)