Package org.hl7.fhir.r5.model

Class Claim.SupportingInformationComponent

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.Claim.SupportingInformationComponent

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:

Claim

public static class Claim.SupportingInformationComponent
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 CodeableConcept	category	The general class of the information supplied: information; exception; accident, employment; onset, etc.
protected CodeableConcept	code	System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
protected CodeableConcept	reason	Provides the reason in the situation where a reason code is required in addition to the content.
protected PositiveIntType	sequence	A number to uniquely identify supporting information entries.
protected DataType	timing	The date when or period to which this information refers.
protected DataType	value	Additional data or information such as resources, documents, images etc.

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
SupportingInformationComponent()	Constructor
SupportingInformationComponent(int sequence, CodeableConcept category)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Claim.SupportingInformationComponent	copy()
void	copyValues(Claim.SupportingInformationComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getCategory()
CodeableConcept	getCode()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getReason()
int	getSequence()
PositiveIntType	getSequenceElement()
DataType	getTiming()
DateType	getTimingDateType()
Period	getTimingPeriod()
String[]	getTypesForProperty(int hash, String name)
DataType	getValue()
Attachment	getValueAttachment()
BooleanType	getValueBooleanType()
Identifier	getValueIdentifier()
Quantity	getValueQuantity()
Reference	getValueReference()
StringType	getValueStringType()
boolean	hasCategory()
boolean	hasCode()
boolean	hasReason()
boolean	hasSequence()
boolean	hasSequenceElement()
boolean	hasTiming()
boolean	hasTimingDateType()
boolean	hasTimingPeriod()
boolean	hasValue()
boolean	hasValueAttachment()
boolean	hasValueBooleanType()
boolean	hasValueIdentifier()
boolean	hasValueQuantity()
boolean	hasValueReference()
boolean	hasValueStringType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Claim.SupportingInformationComponent	setCategory(CodeableConcept value)
Claim.SupportingInformationComponent	setCode(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Claim.SupportingInformationComponent	setReason(CodeableConcept value)
Claim.SupportingInformationComponent	setSequence(int value)
Claim.SupportingInformationComponent	setSequenceElement(PositiveIntType value)
Claim.SupportingInformationComponent	setTiming(DataType value)
Claim.SupportingInformationComponent	setValue(DataType value)

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

sequence

protected PositiveIntType sequence

A number to uniquely identify supporting information entries.

category

protected CodeableConcept category

The general class of the information supplied: information; exception; accident, employment; onset, etc.

code

protected CodeableConcept code

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

timing

protected DataType timing

The date when or period to which this information refers.

value

protected DataType value

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

reason

protected CodeableConcept reason

Provides the reason in the situation where a reason code is required in addition to the content.

Constructor Details

SupportingInformationComponent

public SupportingInformationComponent()

Constructor

SupportingInformationComponent

public SupportingInformationComponent(int sequence,
 CodeableConcept category)

Constructor

Method Details

getSequenceElement

public PositiveIntType getSequenceElement()

Returns:

sequence (A number to uniquely identify supporting information entries.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

hasSequenceElement

public boolean hasSequenceElement()

hasSequence

public boolean hasSequence()

setSequenceElement

public Claim.SupportingInformationComponent setSequenceElement(PositiveIntType value)

Parameters:

value - sequence (A number to uniquely identify supporting information entries.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

getSequence

public int getSequence()

Returns:

A number to uniquely identify supporting information entries.

setSequence

public Claim.SupportingInformationComponent setSequence(int value)

Parameters:

value - A number to uniquely identify supporting information entries.

getCategory

public CodeableConcept getCategory()

Returns:

category (The general class of the information supplied: information; exception; accident, employment; onset, etc.)

hasCategory

public boolean hasCategory()

setCategory

public Claim.SupportingInformationComponent setCategory(CodeableConcept value)

Parameters:

value - category (The general class of the information supplied: information; exception; accident, employment; onset, etc.)

getCode

public CodeableConcept getCode()

Returns:

code (System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.)

hasCode

public boolean hasCode()

setCode

public Claim.SupportingInformationComponent setCode(CodeableConcept value)

Parameters:

value - code (System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.)

getTiming

public DataType getTiming()

Returns:

timing (The date when or period to which this information refers.)

getTimingDateType

public DateType getTimingDateType()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The date when or period to which this information refers.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateType

public boolean hasTimingDateType()

getTimingPeriod

public Period getTimingPeriod()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The date when or period to which this information refers.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingPeriod

public boolean hasTimingPeriod()

hasTiming

public boolean hasTiming()

setTiming

public Claim.SupportingInformationComponent setTiming(DataType value)

Parameters:

value - timing (The date when or period to which this information refers.)

getValue

public DataType getValue()

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

getValueBooleanType

public BooleanType getValueBooleanType()
                                throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueBooleanType

public boolean hasValueBooleanType()

getValueStringType

public StringType getValueStringType()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueStringType

public boolean hasValueStringType()

getValueQuantity

public Quantity getValueQuantity()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueQuantity

public boolean hasValueQuantity()

getValueAttachment

public Attachment getValueAttachment()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueAttachment

public boolean hasValueAttachment()

getValueReference

public Reference getValueReference()
                            throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueReference

public boolean hasValueReference()

getValueIdentifier

public Identifier getValueIdentifier()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueIdentifier

public boolean hasValueIdentifier()

hasValue

public boolean hasValue()

setValue

public Claim.SupportingInformationComponent setValue(DataType value)

Parameters:

value - value (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

getReason

public CodeableConcept getReason()

Returns:

reason (Provides the reason in the situation where a reason code is required in addition to the content.)

hasReason

public boolean hasReason()

setReason

public Claim.SupportingInformationComponent setReason(CodeableConcept value)

Parameters:

value - reason (Provides the reason in the situation where a reason code is required in addition to the content.)

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 Claim.SupportingInformationComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Claim.SupportingInformationComponent 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)