Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.PaymentNotice

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

PaymentNotice request.

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 = PaymentNotice;
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 = PaymentNotice;
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 amount as HS.FHIR.DTL.vR4.Model.Datatype.Money (XMLNAME = "amount", XMLPROJECTION = "ELEMENT") [ Required ];
Money

Monetary amount of the payment.

Property methods: amountGet(), amountGetSwizzled(), amountIsValid(), amountNewObject(), amountSet()
property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Creation date.

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

Business Identifier for the payment noctice.

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

Party being paid.

Practitioner | PractitionerRole | Organization

Property methods: payeeGet(), payeeGetSwizzled(), payeeIsValid(), payeeNewObject(), payeeSet()
property payment as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "payment", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Payment reference.

PaymentReconciliation

Property methods: paymentGet(), paymentGetSwizzled(), paymentIsValid(), paymentNewObject(), paymentSet()
property paymentDate as %String (MAXLEN = 1000000, XMLNAME = "paymentDate", XMLPROJECTION = "ATTRIBUTE");
date

Payment or clearing date.

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

Issued or cleared Status of the payment.

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

Property methods: paymentStatusGet(), paymentStatusGetSwizzled(), paymentStatusIsValid(), paymentStatusNewObject(), paymentStatusSet()
property provider as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "provider", XMLPROJECTION = "ELEMENT");
Reference

Responsible practitioner.

Practitioner | PractitionerRole | Organization

Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()
property recipient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Party being notified.

Organization

Property methods: recipientGet(), recipientGetSwizzled(), recipientIsValid(), recipientNewObject(), recipientSet()
property request as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");
Reference

Request reference.

Any FHIR4 Resource may be indicated by this Reference

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

Response reference.

Any FHIR4 Resource may be indicated by this Reference

Property methods: responseGet(), responseGetSwizzled(), responseIsValid(), responseNewObject(), responseSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

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