Skip to main content

HS.FHIR.vSTU3.Model.Resource.Claim

deprecated class HS.FHIR.vSTU3.Model.Resource.Claim extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
If the element is present, it must have either a @value, an @id, or extensions

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 XMLNAME = Claim;
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.

Properties

property accident as HS.FHIR.vSTU3.Model.Resource.Claim.Accident (XMLNAME = "accident", XMLPROJECTION = "ELEMENT");
An accident which resulted in the need for healthcare services.
Property methods: accidentGet(), accidentGetSwizzled(), accidentIsValid(), accidentNewObject(), accidentSet()
property billablePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "billablePeriod", XMLPROJECTION = "ELEMENT");
The billable period for which charges are being submitted.
Property methods: billablePeriodGet(), billablePeriodGetSwizzled(), billablePeriodIsValid(), billablePeriodNewObject(), billablePeriodSet()
property careTeam as list of HS.FHIR.vSTU3.Model.Resource.Claim.CareTeam (XMLNAME = "careTeam", XMLPROJECTION = "ELEMENT");
The members of the team who provided the overall service as well as their role and whether responsible and qualifications.
Property methods: careTeamBuildValueArray(), careTeamCollectionToDisplay(), careTeamCollectionToOdbc(), careTeamDisplayToCollection(), careTeamGet(), careTeamGetObject(), careTeamGetObjectId(), careTeamGetSwizzled(), careTeamIsValid(), careTeamOdbcToCollection(), careTeamSet(), careTeamSetObject(), careTeamSetObjectId()
property created as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "created", XMLPROJECTION = "ELEMENT");
The date when the enclosed suite of services were performed or completed.
Property methods: createdGet(), createdGetSwizzled(), createdIsValid(), createdNewObject(), createdSet()
property diagnosis as list of HS.FHIR.vSTU3.Model.Resource.Claim.Diagnosis (XMLNAME = "diagnosis", XMLPROJECTION = "ELEMENT");
List of patient diagnosis for which care is sought.
Property methods: diagnosisBuildValueArray(), diagnosisCollectionToDisplay(), diagnosisCollectionToOdbc(), diagnosisDisplayToCollection(), diagnosisGet(), diagnosisGetObject(), diagnosisGetObjectId(), diagnosisGetSwizzled(), diagnosisIsValid(), diagnosisOdbcToCollection(), diagnosisSet(), diagnosisSetObject(), diagnosisSetObjectId()
property employmentImpacted as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "employmentImpacted", XMLPROJECTION = "ELEMENT");
The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).
Property methods: employmentImpactedGet(), employmentImpactedGetSwizzled(), employmentImpactedIsValid(), employmentImpactedNewObject(), employmentImpactedSet()
property enterer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");
Person who created the invoice/claim/pre-determination or pre-authorization.
Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property facility as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "facility", XMLPROJECTION = "ELEMENT");
Facility where the services were provided.
Property methods: facilityGet(), facilityGetSwizzled(), facilityIsValid(), facilityNewObject(), facilitySet()
property fundsReserve as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "fundsReserve", XMLPROJECTION = "ELEMENT");
In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.
Property methods: fundsReserveGet(), fundsReserveGetSwizzled(), fundsReserveIsValid(), fundsReserveNewObject(), fundsReserveSet()
property hospitalization as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "hospitalization", XMLPROJECTION = "ELEMENT");
The start and optional end dates of when the patient was confined to a treatment center.
Property methods: hospitalizationGet(), hospitalizationGetSwizzled(), hospitalizationIsValid(), hospitalizationNewObject(), hospitalizationSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
The business identifier for the instance: claim number, pre-determination or pre-authorization number.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property information as list of HS.FHIR.vSTU3.Model.Resource.Claim.Information (XMLNAME = "information", XMLPROJECTION = "ELEMENT");
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.
Property methods: informationBuildValueArray(), informationCollectionToDisplay(), informationCollectionToOdbc(), informationDisplayToCollection(), informationGet(), informationGetObject(), informationGetObjectId(), informationGetSwizzled(), informationIsValid(), informationOdbcToCollection(), informationSet(), informationSetObject(), informationSetObjectId()
property insurance as list of HS.FHIR.vSTU3.Model.Resource.Claim.Insurance (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
Financial instrument by which payment information for health care.
Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property insurer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "insurer", XMLPROJECTION = "ELEMENT");
The Insurer who is target of the request.
Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
property item as list of HS.FHIR.vSTU3.Model.Resource.Claim.Item (XMLNAME = "item", XMLPROJECTION = "ELEMENT");
First tier of goods and services.
Property methods: itemBuildValueArray(), itemCollectionToDisplay(), itemCollectionToOdbc(), itemDisplayToCollection(), itemGet(), itemGetObject(), itemGetObjectId(), itemGetSwizzled(), itemIsValid(), itemOdbcToCollection(), itemSet(), itemSetObject(), itemSetObjectId()
property organization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");
The organization which is responsible for the bill, claim pre-determination, pre-authorization.
Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()
property originalPrescription as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "originalPrescription", XMLPROJECTION = "ELEMENT");
Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.
Property methods: originalPrescriptionGet(), originalPrescriptionGetSwizzled(), originalPrescriptionIsValid(), originalPrescriptionNewObject(), originalPrescriptionSet()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");
Patient Resource.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property payee as HS.FHIR.vSTU3.Model.Resource.Claim.Payee (XMLNAME = "payee", XMLPROJECTION = "ELEMENT");
The party to be reimbursed for the services.
Property methods: payeeGet(), payeeGetSwizzled(), payeeIsValid(), payeeNewObject(), payeeSet()
property prescription as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "prescription", XMLPROJECTION = "ELEMENT");
Prescription to support the dispensing of Pharmacy or Vision products.
Property methods: prescriptionGet(), prescriptionGetSwizzled(), prescriptionIsValid(), prescriptionNewObject(), prescriptionSet()
property priority as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
Immediate (STAT), best effort (NORMAL), deferred (DEFER).
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property procedure as list of HS.FHIR.vSTU3.Model.Resource.Claim.Procedure (XMLNAME = "procedure", XMLPROJECTION = "ELEMENT");
Ordered list of patient procedures performed to support the adjudication.
Property methods: procedureBuildValueArray(), procedureCollectionToDisplay(), procedureCollectionToOdbc(), procedureDisplayToCollection(), procedureGet(), procedureGetObject(), procedureGetObjectId(), procedureGetSwizzled(), procedureIsValid(), procedureOdbcToCollection(), procedureSet(), procedureSetObject(), procedureSetObjectId()
property provider as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "provider", XMLPROJECTION = "ELEMENT");
The provider which is responsible for the bill, claim pre-determination, pre-authorization.
Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()
property referral as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "referral", XMLPROJECTION = "ELEMENT");
The referral resource which lists the date, practitioner, reason and other supporting information.
Property methods: referralGet(), referralGetSwizzled(), referralIsValid(), referralNewObject(), referralSet()
Other claims which are related to this claim such as prior claim versions or for related services.
Property methods: relatedBuildValueArray(), relatedCollectionToDisplay(), relatedCollectionToOdbc(), relatedDisplayToCollection(), relatedGet(), relatedGetObject(), relatedGetObjectId(), relatedGetSwizzled(), relatedIsValid(), relatedOdbcToCollection(), relatedSet(), relatedSetObject(), relatedSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.FinancialResourceStatusCodes (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
The status of the resource instance.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subType as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "subType", XMLPROJECTION = "ELEMENT");
A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.
Property methods: subTypeBuildValueArray(), subTypeCollectionToDisplay(), subTypeCollectionToOdbc(), subTypeDisplayToCollection(), subTypeGet(), subTypeGetObject(), subTypeGetObjectId(), subTypeGetSwizzled(), subTypeIsValid(), subTypeOdbcToCollection(), subTypeSet(), subTypeSetObject(), subTypeSetObjectId()
property total as HS.FHIR.vSTU3.Model.Base.Money (XMLNAME = "total", XMLPROJECTION = "ELEMENT");
The total value of the claim.
Property methods: totalGet(), totalGetSwizzled(), totalIsValid(), totalNewObject(), totalSet()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
The category of claim, eg, oral, pharmacy, vision, insitutional, professional.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property use as HS.FHIR.vSTU3.Model.Base.Use (XMLNAME = "use", XMLPROJECTION = "ELEMENT");
Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).
Property methods: useGet(), useGetSwizzled(), useIsValid(), useNewObject(), useSet()

Methods

deprecated method SetBillablePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "billablePeriod" property.
deprecated method SetCreated(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 "created" property.
deprecated method SetEmploymentImpacted(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "employmentImpacted" property.
deprecated method SetEnterer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "enterer" property.
deprecated method SetFacility(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "facility" property.
deprecated method SetFundsReserve(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 "fundsReserve" property.
deprecated method SetHospitalization(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "hospitalization" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetInsurer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "insurer" property.
deprecated method SetOrganization(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "organization" property.
deprecated method SetOriginalPrescription(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "originalPrescription" property.
deprecated method SetPatient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "patient" property.
deprecated method SetPrescription(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "prescription" property.
deprecated method SetPriority(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 "priority" property.
deprecated method SetProvider(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "provider" property.
deprecated method SetReferral(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "referral" property.
deprecated method SetStatus(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 "status" property.
deprecated method SetSubType(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.
Insert method for the "subType" property.
deprecated method SetType(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 "type" property.
deprecated method SetUse(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 "use" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab