Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.ClaimResponse

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

This resource provides the adjudication details from the processing of a Claim resource.

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 = 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 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 = ClaimResponse;
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 addItem as list of HS.FHIR.DTL.vSTU3.Model.Element.ClaimResponse.addItem (XMLNAME = "addItem", XMLPROJECTION = "ELEMENT");
BackboneElement

Insurer added line items.

Property methods: addItemBuildValueArray(), addItemCollectionToDisplay(), addItemCollectionToOdbc(), addItemDisplayToCollection(), addItemGet(), addItemGetObject(), addItemGetObjectId(), addItemGetSwizzled(), addItemIsValid(), addItemOdbcToCollection(), addItemSet(), addItemSetObject(), addItemSetObjectId()
property communicationRequest as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "communicationRequest", XMLPROJECTION = "ELEMENT");
Reference

Request for additional information.

CommunicationRequest

Property methods: communicationRequestBuildValueArray(), communicationRequestCollectionToDisplay(), communicationRequestCollectionToOdbc(), communicationRequestDisplayToCollection(), communicationRequestGet(), communicationRequestGetObject(), communicationRequestGetObjectId(), communicationRequestGetSwizzled(), communicationRequestIsValid(), communicationRequestOdbcToCollection(), communicationRequestSet(), communicationRequestSetObject(), communicationRequestSetObjectId()
property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");
dateTime

Creation date.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property disposition as %String (MAXLEN = 1000000, XMLNAME = "disposition", XMLPROJECTION = "ATTRIBUTE");
string

Disposition Message.

Property methods: dispositionDisplayToLogical(), dispositionGet(), dispositionIsValid(), dispositionLogicalToDisplay(), dispositionLogicalToOdbc(), dispositionNormalize(), dispositionSet()
property error as list of HS.FHIR.DTL.vSTU3.Model.Element.ClaimResponse.error (XMLNAME = "error", XMLPROJECTION = "ELEMENT");
BackboneElement

Processing errors.

Property methods: errorBuildValueArray(), errorCollectionToDisplay(), errorCollectionToOdbc(), errorDisplayToCollection(), errorGet(), errorGetObject(), errorGetObjectId(), errorGetSwizzled(), errorIsValid(), errorOdbcToCollection(), errorSet(), errorSetObject(), errorSetObjectId()
property form as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "form", XMLPROJECTION = "ELEMENT");
CodeableConcept

Printed Form Identifier.

any FHIR3 code may be used; forms shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: formGet(), formGetSwizzled(), formIsValid(), formNewObject(), formSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Response number.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property insurance as list of HS.FHIR.DTL.vSTU3.Model.Element.ClaimResponse.insurance (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
BackboneElement

Insurance or medical plan.

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property insurer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "insurer", XMLPROJECTION = "ELEMENT");
Reference

Insurance issuing organization.

Organization

Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
property item as list of HS.FHIR.DTL.vSTU3.Model.Element.ClaimResponse.item (XMLNAME = "item", XMLPROJECTION = "ELEMENT");
BackboneElement

Line items.

Property methods: itemBuildValueArray(), itemCollectionToDisplay(), itemCollectionToOdbc(), itemDisplayToCollection(), itemGet(), itemGetObject(), itemGetObjectId(), itemGetSwizzled(), itemIsValid(), itemOdbcToCollection(), itemSet(), itemSetObject(), itemSetObjectId()
property outcome as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
CodeableConcept

complete | error | partial

any FHIR3 code may be used; remittance-outcome shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");
Reference

The subject of the Products and Services.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property payeeType as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "payeeType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Party to be paid any benefits payable.

any FHIR3 code may be used; payeetype shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: payeeTypeGet(), payeeTypeGetSwizzled(), payeeTypeIsValid(), payeeTypeNewObject(), payeeTypeSet()
property payment as HS.FHIR.DTL.vSTU3.Model.Element.ClaimResponse.payment (XMLNAME = "payment", XMLPROJECTION = "ELEMENT");
BackboneElement

Payment details, if paid.

Property methods: paymentGet(), paymentGetSwizzled(), paymentIsValid(), paymentNewObject(), paymentSet()
property processNote as list of HS.FHIR.DTL.vSTU3.Model.Element.ClaimResponse.processNote (XMLNAME = "processNote", XMLPROJECTION = "ELEMENT");
BackboneElement

Processing notes.

Property methods: processNoteBuildValueArray(), processNoteCollectionToDisplay(), processNoteCollectionToOdbc(), processNoteDisplayToCollection(), processNoteGet(), processNoteGetObject(), processNoteGetObjectId(), processNoteGetSwizzled(), processNoteIsValid(), processNoteOdbcToCollection(), processNoteSet(), processNoteSetObject(), processNoteSetObjectId()
property request as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");
Reference

Id of resource triggering adjudication.

Claim

Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestOrganizationGet(), requestOrganizationGetSwizzled(), requestOrganizationIsValid(), requestOrganizationNewObject(), requestOrganizationSet(), requestProviderGet(), requestProviderGetSwizzled(), requestProviderIsValid(), requestProviderNewObject(), requestProviderSet(), requestSet()
property requestOrganization as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "requestOrganization", XMLPROJECTION = "ELEMENT");
Reference

Responsible organization.

Organization

Property methods: requestOrganizationGet(), requestOrganizationGetSwizzled(), requestOrganizationIsValid(), requestOrganizationNewObject(), requestOrganizationSet()
property requestProvider as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "requestProvider", XMLPROJECTION = "ELEMENT");
Reference

Responsible practitioner.

Practitioner

Property methods: requestProviderGet(), requestProviderGetSwizzled(), requestProviderIsValid(), requestProviderNewObject(), requestProviderSet()
property reserved as HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "reserved", XMLPROJECTION = "ELEMENT");
Coding

Funds reserved status.

any FHIR3 code may be used; fundsreserve shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reservedGet(), reservedGetSwizzled(), reservedIsValid(), reservedNewObject(), reservedSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

active | cancelled | draft | entered-in-error

fm-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend fm-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property totalBenefit as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "totalBenefit", XMLPROJECTION = "ELEMENT");
Money

Total benefit payable for the Claim.

Property methods: totalBenefitGet(), totalBenefitGetSwizzled(), totalBenefitIsValid(), totalBenefitNewObject(), totalBenefitSet()
property totalCost as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "totalCost", XMLPROJECTION = "ELEMENT");
Money

Total Cost of service from the Claim.

Property methods: totalCostGet(), totalCostGetSwizzled(), totalCostIsValid(), totalCostNewObject(), totalCostSet()
property unallocDeductable as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "unallocDeductable", XMLPROJECTION = "ELEMENT");
Money

Unallocated deductible.

Property methods: unallocDeductableGet(), unallocDeductableGetSwizzled(), unallocDeductableIsValid(), unallocDeductableNewObject(), unallocDeductableSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab