Package org.hl7.fhir.r5.model

Class PaymentNotice

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.PaymentNotice

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class PaymentNotice
extends DomainResource

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Money	amount	The amount sent to the payee.
protected DateTimeType	created	The date when this resource was created.
static final ca.uhn.fhir.rest.gclient.DateClientParam	CREATED	Fluent Client search parameter constant for created
protected List<Identifier>	identifier	A unique identifier assigned to this payment notice.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_REPORTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUEST	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RESPONSE	Constant for fluent queries to be used to add include statements.
protected Reference	payee	The party who will receive or has received payment that is the subject of this notification.
protected Reference	payment	A reference to the payment which is the subject of this notice.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PAYMENT_STATUS	Fluent Client search parameter constant for payment-status
protected DateType	paymentDate	The date when the above payment action occurred.
protected CodeableConcept	paymentStatus	A code indicating whether payment has been sent or cleared.
protected Reference	recipient	The party who is notified of the payment status.
protected Reference	reporter	The party who reports the payment notice.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REPORTER	Fluent Client search parameter constant for reporter
protected Reference	request	Reference of resource for which payment is being made.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUEST	Fluent Client search parameter constant for request
protected Reference	response	Reference of response to resource for which payment is being made.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RESPONSE	Fluent Client search parameter constant for response
static final String	SP_CREATED	Search parameter: created
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_PAYMENT_STATUS	Search parameter: payment-status
static final String	SP_REPORTER	Search parameter: reporter
static final String	SP_REQUEST	Search parameter: request
static final String	SP_RESPONSE	Search parameter: response
static final String	SP_STATUS	Search parameter: status
protected Enumeration<Enumerations.FinancialResourceStatusCodes>	status	The status of the resource instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
PaymentNotice()	Constructor
PaymentNotice(Enumerations.FinancialResourceStatusCodes status, Date created, Reference recipient, Money amount)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
PaymentNotice	addIdentifier(Identifier t)
PaymentNotice	copy()
void	copyValues(PaymentNotice dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Money	getAmount()
Date	getCreated()
DateTimeType	getCreatedElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Reference	getPayee()
Reference	getPayment()
Date	getPaymentDate()
DateType	getPaymentDateElement()
CodeableConcept	getPaymentStatus()
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getRecipient()
Reference	getReporter()
Reference	getRequest()
ResourceType	getResourceType()
Reference	getResponse()
Enumerations.FinancialResourceStatusCodes	getStatus()
Enumeration<Enumerations.FinancialResourceStatusCodes>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAmount()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasIdentifier()
boolean	hasPayee()
boolean	hasPayment()
boolean	hasPaymentDate()
boolean	hasPaymentDateElement()
boolean	hasPaymentStatus()
boolean	hasRecipient()
boolean	hasReporter()
boolean	hasRequest()
boolean	hasResponse()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
PaymentNotice	setAmount(Money value)
PaymentNotice	setCreated(Date value)
PaymentNotice	setCreatedElement(DateTimeType value)
PaymentNotice	setIdentifier(List<Identifier> theIdentifier)
PaymentNotice	setPayee(Reference value)
PaymentNotice	setPayment(Reference value)
PaymentNotice	setPaymentDate(Date value)
PaymentNotice	setPaymentDateElement(DateType value)
PaymentNotice	setPaymentStatus(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
PaymentNotice	setRecipient(Reference value)
PaymentNotice	setReporter(Reference value)
PaymentNotice	setRequest(Reference value)
PaymentNotice	setResponse(Reference value)
PaymentNotice	setStatus(Enumerations.FinancialResourceStatusCodes value)
PaymentNotice	setStatusElement(Enumeration<Enumerations.FinancialResourceStatusCodes> value)
protected PaymentNotice	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A unique identifier assigned to this payment notice.

status

protected Enumeration<Enumerations.FinancialResourceStatusCodes> status

The status of the resource instance.

request

protected Reference request

Reference of resource for which payment is being made.

response

protected Reference response

Reference of response to resource for which payment is being made.

created

protected DateTimeType created

The date when this resource was created.

reporter

protected Reference reporter

The party who reports the payment notice.

payment

protected Reference payment

A reference to the payment which is the subject of this notice.

paymentDate

protected DateType paymentDate

The date when the above payment action occurred.

payee

protected Reference payee

The party who will receive or has received payment that is the subject of this notification.

recipient

protected Reference recipient

The party who is notified of the payment status.

amount

protected Money amount

The amount sent to the payee.

paymentStatus

protected CodeableConcept paymentStatus

A code indicating whether payment has been sent or cleared.

SP_CREATED

public static final String SP_CREATED

Search parameter: created

Description: Creation date for the notice
Type: date
Path: PaymentNotice.created

See Also:

• Constant Field Values

CREATED

public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED

Fluent Client search parameter constant for created

Description: Creation date for the notice
Type: date
Path: PaymentNotice.created

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The business identifier of the notice
Type: token
Path: PaymentNotice.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: The business identifier of the notice
Type: token
Path: PaymentNotice.identifier

SP_PAYMENT_STATUS

public static final String SP_PAYMENT_STATUS

Search parameter: payment-status

Description: The type of payment notice
Type: token
Path: PaymentNotice.paymentStatus

See Also:

• Constant Field Values

PAYMENT_STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PAYMENT_STATUS

Fluent Client search parameter constant for payment-status

Description: The type of payment notice
Type: token
Path: PaymentNotice.paymentStatus

SP_REPORTER

public static final String SP_REPORTER

Search parameter: reporter

Description: The reference to the reporter
Type: reference
Path: PaymentNotice.reporter

See Also:

• Constant Field Values

REPORTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPORTER

Fluent Client search parameter constant for reporter

Description: The reference to the reporter
Type: reference
Path: PaymentNotice.reporter

INCLUDE_REPORTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_REPORTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:reporter".

SP_REQUEST

public static final String SP_REQUEST

Search parameter: request

Description: The Claim
Type: reference
Path: PaymentNotice.request

See Also:

• Constant Field Values

REQUEST

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUEST

Fluent Client search parameter constant for request

Description: The Claim
Type: reference
Path: PaymentNotice.request

INCLUDE_REQUEST

public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:request".

SP_RESPONSE

public static final String SP_RESPONSE

Search parameter: response

Description: The ClaimResponse
Type: reference
Path: PaymentNotice.response

See Also:

• Constant Field Values

RESPONSE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESPONSE

Fluent Client search parameter constant for response

Description: The ClaimResponse
Type: reference
Path: PaymentNotice.response

INCLUDE_RESPONSE

public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSE

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:response".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the payment notice
Type: token
Path: PaymentNotice.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The status of the payment notice
Type: token
Path: PaymentNotice.status

Constructor Details

PaymentNotice

public PaymentNotice()

Constructor

PaymentNotice

public PaymentNotice(Enumerations.FinancialResourceStatusCodes status,
 Date created,
 Reference recipient,
 Money amount)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A unique identifier assigned to this payment notice.)

setIdentifier

public PaymentNotice setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public PaymentNotice addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getStatusElement

public Enumeration<Enumerations.FinancialResourceStatusCodes> getStatusElement()

Returns:

status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public PaymentNotice setStatusElement(Enumeration<Enumerations.FinancialResourceStatusCodes> value)

Parameters:

value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.FinancialResourceStatusCodes getStatus()

Returns:

The status of the resource instance.

setStatus

public PaymentNotice setStatus(Enumerations.FinancialResourceStatusCodes value)

Parameters:

value - The status of the resource instance.

getRequest

public Reference getRequest()

Returns:

request (Reference of resource for which payment is being made.)

hasRequest

public boolean hasRequest()

setRequest

public PaymentNotice setRequest(Reference value)

Parameters:

value - request (Reference of resource for which payment is being made.)

getResponse

public Reference getResponse()

Returns:

response (Reference of response to resource for which payment is being made.)

hasResponse

public boolean hasResponse()

setResponse

public PaymentNotice setResponse(Reference value)

Parameters:

value - response (Reference of response to resource for which payment is being made.)

getCreatedElement

public DateTimeType getCreatedElement()

Returns:

created (The date when this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public PaymentNotice setCreatedElement(DateTimeType value)

Parameters:

value - created (The date when this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

getCreated

public Date getCreated()

Returns:

The date when this resource was created.

setCreated

public PaymentNotice setCreated(Date value)

Parameters:

value - The date when this resource was created.

getReporter

public Reference getReporter()

Returns:

reporter (The party who reports the payment notice.)

hasReporter

public boolean hasReporter()

setReporter

public PaymentNotice setReporter(Reference value)

Parameters:

value - reporter (The party who reports the payment notice.)

getPayment

public Reference getPayment()

Returns:

payment (A reference to the payment which is the subject of this notice.)

hasPayment

public boolean hasPayment()

setPayment

public PaymentNotice setPayment(Reference value)

Parameters:

value - payment (A reference to the payment which is the subject of this notice.)

getPaymentDateElement

public DateType getPaymentDateElement()

Returns:

paymentDate (The date when the above payment action occurred.). This is the underlying object with id, value and extensions. The accessor "getPaymentDate" gives direct access to the value

hasPaymentDateElement

public boolean hasPaymentDateElement()

hasPaymentDate

public boolean hasPaymentDate()

setPaymentDateElement

public PaymentNotice setPaymentDateElement(DateType value)

Parameters:

value - paymentDate (The date when the above payment action occurred.). This is the underlying object with id, value and extensions. The accessor "getPaymentDate" gives direct access to the value

getPaymentDate

public Date getPaymentDate()

Returns:

The date when the above payment action occurred.

setPaymentDate

public PaymentNotice setPaymentDate(Date value)

Parameters:

value - The date when the above payment action occurred.

getPayee

public Reference getPayee()

Returns:

payee (The party who will receive or has received payment that is the subject of this notification.)

hasPayee

public boolean hasPayee()

setPayee

public PaymentNotice setPayee(Reference value)

Parameters:

value - payee (The party who will receive or has received payment that is the subject of this notification.)

getRecipient

public Reference getRecipient()

Returns:

recipient (The party who is notified of the payment status.)

hasRecipient

public boolean hasRecipient()

setRecipient

public PaymentNotice setRecipient(Reference value)

Parameters:

value - recipient (The party who is notified of the payment status.)

getAmount

public Money getAmount()

Returns:

amount (The amount sent to the payee.)

hasAmount

public boolean hasAmount()

setAmount

public PaymentNotice setAmount(Money value)

Parameters:

value - amount (The amount sent to the payee.)

getPaymentStatus

public CodeableConcept getPaymentStatus()

Returns:

paymentStatus (A code indicating whether payment has been sent or cleared.)

hasPaymentStatus

public boolean hasPaymentStatus()

setPaymentStatus

public PaymentNotice setPaymentStatus(CodeableConcept value)

Parameters:

value - paymentStatus (A code indicating whether payment has been sent or cleared.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public PaymentNotice copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(PaymentNotice dst)

typedCopy

protected PaymentNotice typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource