Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.PaymentNotice

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

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

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 created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");
dateTime

Creation date.

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

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

Responsible organization.

Organization

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

Whether payment has been sent or cleared.

any FHIR3 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.vSTU3.Model.Base.Reference (XMLNAME = "provider", XMLPROJECTION = "ELEMENT");
Reference

Responsible practitioner.

Practitioner

Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()
property request as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");
Reference

Request reference.

Any FHIR3 Resource may be indicated by this Reference

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

Response reference.

Any FHIR3 Resource may be indicated by this Reference

Property methods: responseGet(), responseGetSwizzled(), responseIsValid(), responseNewObject(), responseSet()
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: statusDateDisplayToLogical(), statusDateGet(), statusDateIsValid(), statusDateLogicalToDisplay(), statusDateLogicalToOdbc(), statusDateNormalize(), statusDateSet(), statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusDate as %String (MAXLEN = 1000000, XMLNAME = "statusDate", XMLPROJECTION = "ATTRIBUTE");
date

Payment or clearing date.

Property methods: statusDateDisplayToLogical(), statusDateGet(), statusDateIsValid(), statusDateLogicalToDisplay(), statusDateLogicalToOdbc(), statusDateNormalize(), statusDateSet()
property target as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "target", XMLPROJECTION = "ELEMENT");
Reference

Insurer or Regulatory body.

Organization

Property methods: targetGet(), targetGetSwizzled(), targetIsValid(), targetNewObject(), targetSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab