Skip to main content


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

PaymentReconciliation resource.

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") [ Required ];

Creation date.

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

Settlement particulars.

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

Printed form identifier.

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

Property methods: formCodeGet(), formCodeGetSwizzled(), formCodeIsValid(), formCodeNewObject(), formCodeSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for a payment reconciliation.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property outcome as %String (MAXLEN = 1000000, XMLNAME = "outcome", XMLPROJECTION = "ATTRIBUTE");

queued | complete | error | partial

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

Property methods: outcomeDisplayToLogical(), outcomeGet(), outcomeIsValid(), outcomeLogicalToDisplay(), outcomeLogicalToOdbc(), outcomeNormalize(), outcomeSet()
property paymentAmount as HS.FHIR.DTL.vR4.Model.Datatype.Money (XMLNAME = "paymentAmount", XMLPROJECTION = "ELEMENT") [ Required ];

Total amount of Payment.

Property methods: paymentAmountGet(), paymentAmountGetSwizzled(), paymentAmountIsValid(), paymentAmountNewObject(), paymentAmountSet()
property paymentDate as %String (MAXLEN = 1000000, XMLNAME = "paymentDate", XMLPROJECTION = "ATTRIBUTE") [ Required ];

When payment issued.

Property methods: paymentDateDisplayToLogical(), paymentDateGet(), paymentDateIsValid(), paymentDateLogicalToDisplay(), paymentDateLogicalToOdbc(), paymentDateNormalize(), paymentDateSet()
property paymentIdentifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "paymentIdentifier", XMLPROJECTION = "ELEMENT");

Business identifier for the payment.

Property methods: paymentIdentifierGet(), paymentIdentifierGetSwizzled(), paymentIdentifierIsValid(), paymentIdentifierNewObject(), paymentIdentifierSet()
property paymentIssuer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "paymentIssuer", XMLPROJECTION = "ELEMENT");

Party generating payment.


Property methods: paymentIssuerGet(), paymentIssuerGetSwizzled(), paymentIssuerIsValid(), paymentIssuerNewObject(), paymentIssuerSet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Period covered.

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

Note concerning processing.

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

Reference to requesting resource.


Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestSet()
property requestor as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requestor", XMLPROJECTION = "ELEMENT");

Responsible practitioner.

Practitioner | PractitionerRole | Organization

Property methods: requestorGet(), requestorGetSwizzled(), requestorIsValid(), requestorNewObject(), requestorSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

active | cancelled | draft | entered-in-error

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab