Skip to main content

HS.FHIR.vSTU3.Model.Resource.ClaimResponse

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
This resource provides the adjudication details from the processing of a Claim resource.
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 = ClaimResponse;
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 addItem as list of HS.FHIR.vSTU3.Model.Resource.ClaimResponse.AddItem (XMLNAME = "addItem", XMLPROJECTION = "ELEMENT");
The first tier service adjudications for payor added services.
Property methods: addItemBuildValueArray(), addItemCollectionToDisplay(), addItemCollectionToOdbc(), addItemDisplayToCollection(), addItemGet(), addItemGetObject(), addItemGetObjectId(), addItemGetSwizzled(), addItemIsValid(), addItemOdbcToCollection(), addItemSet(), addItemSetObject(), addItemSetObjectId()
property communicationRequest as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "communicationRequest", XMLPROJECTION = "ELEMENT");
Request for additional supporting or authorizing information, such as: documents, images or resources.
Property methods: communicationRequestBuildValueArray(), communicationRequestCollectionToDisplay(), communicationRequestCollectionToOdbc(), communicationRequestDisplayToCollection(), communicationRequestGet(), communicationRequestGetObject(), communicationRequestGetObjectId(), communicationRequestGetSwizzled(), communicationRequestIsValid(), communicationRequestOdbcToCollection(), communicationRequestSet(), communicationRequestSetObject(), communicationRequestSetObjectId()
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 disposition as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "disposition", XMLPROJECTION = "ELEMENT");
A description of the status of the adjudication.
Property methods: dispositionGet(), dispositionGetSwizzled(), dispositionIsValid(), dispositionNewObject(), dispositionSet()
property error as list of HS.FHIR.vSTU3.Model.Resource.ClaimResponse.Error (XMLNAME = "error", XMLPROJECTION = "ELEMENT");
Mutually exclusive with Services Provided (Item).
Property methods: errorBuildValueArray(), errorCollectionToDisplay(), errorCollectionToOdbc(), errorDisplayToCollection(), errorGet(), errorGetObject(), errorGetObjectId(), errorGetSwizzled(), errorIsValid(), errorOdbcToCollection(), errorSet(), errorSetObject(), errorSetObjectId()
property form as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "form", XMLPROJECTION = "ELEMENT");
The form to be used for printing the content.
Property methods: formGet(), formGetSwizzled(), formIsValid(), formNewObject(), formSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
The Response business identifier.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property insurance as list of HS.FHIR.vSTU3.Model.Resource.ClaimResponse.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 produced this adjudicated response.
Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
property item as list of HS.FHIR.vSTU3.Model.Resource.ClaimResponse.Item (XMLNAME = "item", XMLPROJECTION = "ELEMENT");
The first tier service adjudications for submitted services.
Property methods: itemBuildValueArray(), itemCollectionToDisplay(), itemCollectionToOdbc(), itemDisplayToCollection(), itemGet(), itemGetObject(), itemGetObjectId(), itemGetSwizzled(), itemIsValid(), itemOdbcToCollection(), itemSet(), itemSetObject(), itemSetObjectId()
property outcome as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
Processing outcome errror, partial or complete processing.
Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");
Patient Resource.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property payeeType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "payeeType", XMLPROJECTION = "ELEMENT");
Party to be reimbursed: Subscriber, provider, other.
Property methods: payeeTypeGet(), payeeTypeGetSwizzled(), payeeTypeIsValid(), payeeTypeNewObject(), payeeTypeSet()
property payment as HS.FHIR.vSTU3.Model.Resource.ClaimResponse.Payment (XMLNAME = "payment", XMLPROJECTION = "ELEMENT");
Payment details for the claim if the claim has been paid.
Property methods: paymentGet(), paymentGetSwizzled(), paymentIsValid(), paymentNewObject(), paymentSet()
property processNote as list of HS.FHIR.vSTU3.Model.Resource.ClaimResponse.ProcessNote (XMLNAME = "processNote", XMLPROJECTION = "ELEMENT");
Note text.
Property methods: processNoteBuildValueArray(), processNoteCollectionToDisplay(), processNoteCollectionToOdbc(), processNoteDisplayToCollection(), processNoteGet(), processNoteGetObject(), processNoteGetObjectId(), processNoteGetSwizzled(), processNoteIsValid(), processNoteOdbcToCollection(), processNoteSet(), processNoteSetObject(), processNoteSetObjectId()
property request as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");
Original request resource referrence.
Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestOrganizationGet(), requestOrganizationGetSwizzled(), requestOrganizationIsValid(), requestOrganizationNewObject(), requestOrganizationSet(), requestProviderGet(), requestProviderGetSwizzled(), requestProviderIsValid(), requestProviderNewObject(), requestProviderSet(), requestSet()
property requestOrganization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "requestOrganization", XMLPROJECTION = "ELEMENT");
The organization which is responsible for the services rendered to the patient.
Property methods: requestOrganizationGet(), requestOrganizationGetSwizzled(), requestOrganizationIsValid(), requestOrganizationNewObject(), requestOrganizationSet()
property requestProvider as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "requestProvider", XMLPROJECTION = "ELEMENT");
The practitioner who is responsible for the services rendered to the patient.
Property methods: requestProviderGet(), requestProviderGetSwizzled(), requestProviderIsValid(), requestProviderNewObject(), requestProviderSet()
property reserved as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "reserved", XMLPROJECTION = "ELEMENT");
Status of funds reservation (For provider, for Patient, None).
Property methods: reservedGet(), reservedGetSwizzled(), reservedIsValid(), reservedNewObject(), reservedSet()
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 totalBenefit as HS.FHIR.vSTU3.Model.Base.Money (XMLNAME = "totalBenefit", XMLPROJECTION = "ELEMENT");
Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).
Property methods: totalBenefitGet(), totalBenefitGetSwizzled(), totalBenefitIsValid(), totalBenefitNewObject(), totalBenefitSet()
property totalCost as HS.FHIR.vSTU3.Model.Base.Money (XMLNAME = "totalCost", XMLPROJECTION = "ELEMENT");
The total cost of the services reported.
Property methods: totalCostGet(), totalCostGetSwizzled(), totalCostIsValid(), totalCostNewObject(), totalCostSet()
property unallocDeductable as HS.FHIR.vSTU3.Model.Base.Money (XMLNAME = "unallocDeductable", XMLPROJECTION = "ELEMENT");
The amount of deductible applied which was not allocated to any particular service line.
Property methods: unallocDeductableGet(), unallocDeductableGetSwizzled(), unallocDeductableIsValid(), unallocDeductableNewObject(), unallocDeductableSet()

Methods

deprecated method SetCommunicationRequest(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "communicationRequest" 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 SetDisposition(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 "disposition" property.
deprecated method SetForm(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 "form" 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 SetOutcome(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 "outcome" 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 SetPayeeType(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 "payeeType" property.
deprecated method SetRequest(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 "request" property.
deprecated method SetRequestOrganization(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 "requestOrganization" property.
deprecated method SetRequestProvider(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 "requestProvider" property.
deprecated method SetReserved(pCode As %String = "", pDisplay As %String = "", pSystem 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 "reserved" 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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab