Skip to main content


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

This resource provides payment details and claim references supporting a bulk payment.

Property Inventory


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 = PaymentReconciliation;
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 = PaymentReconciliation;
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.


property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");

Creation date.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property detail as list of HS.FHIR.DTL.vSTU3.Model.Element.PaymentReconciliation.detail (XMLNAME = "detail", XMLPROJECTION = "ELEMENT");

List of settlements.

Property methods: detailBuildValueArray(), detailCollectionToDisplay(), detailCollectionToOdbc(), detailDisplayToCollection(), detailGet(), detailGetObject(), detailGetObjectId(), detailGetSwizzled(), detailIsValid(), detailOdbcToCollection(), detailSet(), detailSetObject(), detailSetObjectId()
property disposition as %String (MAXLEN = 1000000, XMLNAME = "disposition", XMLPROJECTION = "ATTRIBUTE");

Disposition Message.

Property methods: dispositionDisplayToLogical(), dispositionGet(), dispositionIsValid(), dispositionLogicalToDisplay(), dispositionLogicalToOdbc(), dispositionNormalize(), dispositionSet()
property form as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "form", XMLPROJECTION = "ELEMENT");

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");

Business Identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property organization as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");



Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()
property outcome as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");

complete | error | partial

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

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

Period covered.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property processNote as list of HS.FHIR.DTL.vSTU3.Model.Element.PaymentReconciliation.processNote (XMLNAME = "processNote", XMLPROJECTION = "ELEMENT");

Processing comments.

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");

Claim reference.


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");

Responsible organization.


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

Responsible practitioner.


Property methods: requestProviderGet(), requestProviderGetSwizzled(), requestProviderIsValid(), requestProviderNewObject(), requestProviderSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

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 total as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "total", XMLPROJECTION = "ELEMENT");

Total amount of Payment.

Property methods: totalGet(), totalGetSwizzled(), totalIsValid(), totalNewObject(), totalSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab