Skip to main content

HS.FHIR.vSTU3.Model.Resource.ExplanationOfBenefit.BenefitBalance

deprecated class HS.FHIR.vSTU3.Model.Resource.ExplanationOfBenefit.BenefitBalance extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
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 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.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT") [ Required ];
Dental, Vision, Medical, Pharmacy, Rehab etc.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property excluded as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "excluded", XMLPROJECTION = "ELEMENT");
True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage.
Property methods: excludedGet(), excludedGetSwizzled(), excludedIsValid(), excludedNewObject(), excludedSet()
property financial as list of HS.FHIR.vSTU3.Model.Resource.ExplanationOfBenefit.Financial (XMLNAME = "financial", XMLPROJECTION = "ELEMENT");
Benefits Used to date.
Property methods: financialBuildValueArray(), financialCollectionToDisplay(), financialCollectionToOdbc(), financialDisplayToCollection(), financialGet(), financialGetObject(), financialGetObjectId(), financialGetSwizzled(), financialIsValid(), financialOdbcToCollection(), financialSet(), financialSetObject(), financialSetObjectId()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
A short name or tag for the benefit, for example MED01, or DENT2.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property network as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "network", XMLPROJECTION = "ELEMENT");
Network designation.
Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
property subCategory as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "subCategory", XMLPROJECTION = "ELEMENT");
Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
Property methods: subCategoryGet(), subCategoryGetSwizzled(), subCategoryIsValid(), subCategoryNewObject(), subCategorySet()
property term as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "term", XMLPROJECTION = "ELEMENT");
The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'.
Property methods: termGet(), termGetSwizzled(), termIsValid(), termNewObject(), termSet()
property unit as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "unit", XMLPROJECTION = "ELEMENT");
Unit designation: individual or family.
Property methods: unitGet(), unitGetSwizzled(), unitIsValid(), unitNewObject(), unitSet()

Methods

deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "category" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetExcluded(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "excluded" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetNetwork(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "network" property.
deprecated method SetSubCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subCategory" property.
deprecated method SetTerm(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "term" property.
deprecated method SetUnit(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "unit" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab