Skip to main content

HS.FHIRModel.R4.ExplanationOfBenefitX.BenefitBalance

class HS.FHIRModel.R4.ExplanationOfBenefitX.BenefitBalance extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ExplanationOfBenefitX.BenefitBalance generated class schema
*****************************************
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_EXPLANATIONOFBENEFITX_BENEFITBALANCE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _excluded as HS.FHIRModel.R4.Element;
Extensions for excluded
Property methods: _excludedGet(), _excludedGetSwizzled(), _excludedIsValid(), _excludedNewObject(), _excludedSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property category as HS.FHIRModel.R4.CodeableConcept [ Required ];
Code to identify the general type of benefits under which products and services are provided.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property description as %String;
A richer description of the benefit or services covered.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property excluded as %Boolean;
True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
Property methods: excludedDisplayToLogical(), excludedGet(), excludedIsValid(), excludedLogicalToDisplay(), excludedLogicalToXSD(), excludedNormalize(), excludedSet(), excludedXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
Benefits Used to date.
Property methods: financialGet(), financialGetSwizzled(), financialIsValid(), financialNewObject(), financialSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
A short name or tag for the benefit.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property network as HS.FHIRModel.R4.CodeableConcept;
Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
Property methods: termGet(), termGetSwizzled(), termIsValid(), termNewObject(), termSet()
Indicates if the benefits apply to an individual or to the family.
Property methods: unitGet(), unitGetSwizzled(), unitIsValid(), unitNewObject(), unitSet()

Methods

method IncludeCategory()
method IncludeExtension()
method IncludeFinancial()
method IncludeModifierExtension()
method IncludeNetwork()
method IncludeTerm()
method IncludeUnit()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab