Skip to main content

HS.FHIR.DTL.vR4.Model.Element.ExplanationOfBenefit.benefitBalance

class HS.FHIR.DTL.vR4.Model.Element.ExplanationOfBenefit.benefitBalance extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Balance by Benefit Category.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = ExplanationOfBenefit.benefitBalance;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = ExplanationOfBenefit.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 category as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Benefit classification.

any FHIR4 code may be used; ex-benefitcategory shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Description of the benefit or services covered.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property excluded as %Boolean (XMLNAME = "excluded", XMLPROJECTION = "ATTRIBUTE");
boolean

Excluded from the plan.

Property methods: excludedDisplayToLogical(), excludedGet(), excludedIsValid(), excludedLogicalToDisplay(), excludedLogicalToXSD(), excludedNormalize(), excludedSet(), excludedXSDToLogical()
property financial as list of HS.FHIR.DTL.vR4.Model.Element.ExplanationOfBenefit.benefitBalance.financial (XMLNAME = "financial", XMLPROJECTION = "ELEMENT");
BackboneElement

Benefit Summary.

Property methods: financialBuildValueArray(), financialCollectionToDisplay(), financialCollectionToOdbc(), financialDisplayToCollection(), financialGet(), financialGetObject(), financialGetObjectId(), financialGetSwizzled(), financialIsValid(), financialOdbcToCollection(), financialSet(), financialSetObject(), financialSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Short name for the benefit.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property network as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "network", XMLPROJECTION = "ELEMENT");
CodeableConcept

In or out of network.

any FHIR4 code may be used; benefit-network shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
property term as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "term", XMLPROJECTION = "ELEMENT");
CodeableConcept

Annual or lifetime.

any FHIR4 code may be used; benefit-term shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: termGet(), termGetSwizzled(), termIsValid(), termNewObject(), termSet()
property unit as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "unit", XMLPROJECTION = "ELEMENT");
CodeableConcept

Individual or family.

any FHIR4 code may be used; benefit-unit shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: unitGet(), unitGetSwizzled(), unitIsValid(), unitNewObject(), unitSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab