Class PaymentNotice
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.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 Modifier and Type Class Description static classPaymentNotice.PaymentNoticeStatusstatic classPaymentNotice.PaymentNoticeStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected MoneyamountThe amount sent to the payee.protected DateTimeTypecreatedThe date when this resource was created.static ca.uhn.fhir.rest.gclient.DateClientParamCREATEDFluent Client search parameter constant for createdprotected List<Identifier>identifierA unique identifier assigned to this payment notice.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_PROVIDERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REQUESTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RESPONSEConstant for fluent queries to be used to add include statements.protected ReferencepayeeThe party who will receive or has received payment that is the subject of this notification.protected ResourcepayeeTargetThe actual object that is the target of the reference (The party who will receive or has received payment that is the subject of this notification.)protected ReferencepaymentA reference to the payment which is the subject of this notice.static ca.uhn.fhir.rest.gclient.TokenClientParamPAYMENT_STATUSFluent Client search parameter constant for payment-statusprotected DateTypepaymentDateThe date when the above payment action occurred.protected CodeableConceptpaymentStatusA code indicating whether payment has been sent or cleared.protected PaymentReconciliationpaymentTargetThe actual object that is the target of the reference (A reference to the payment which is the subject of this notice.)protected ReferenceproviderThe practitioner who is responsible for the services rendered to the patient.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPROVIDERFluent Client search parameter constant for providerprotected ResourceproviderTargetThe actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)protected ReferencerecipientThe party who is notified of the payment status.protected OrganizationrecipientTargetThe actual object that is the target of the reference (The party who is notified of the payment status.)protected ReferencerequestReference of resource for which payment is being made.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREQUESTFluent Client search parameter constant for requestprotected ResourcerequestTargetThe actual object that is the target of the reference (Reference of resource for which payment is being made.)protected ReferenceresponseReference of response to resource for which payment is being made.static ca.uhn.fhir.rest.gclient.ReferenceClientParamRESPONSEFluent Client search parameter constant for responseprotected ResourceresponseTargetThe actual object that is the target of the reference (Reference of response to resource for which payment is being made.)static StringSP_CREATEDSearch parameter: createdstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_PAYMENT_STATUSSearch parameter: payment-statusstatic StringSP_PROVIDERSearch parameter: providerstatic StringSP_REQUESTSearch parameter: requeststatic StringSP_RESPONSESearch parameter: responsestatic StringSP_STATUSSearch parameter: statusprotected Enumeration<PaymentNotice.PaymentNoticeStatus>statusThe status of the resource instance.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for status-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description PaymentNotice()ConstructorPaymentNotice(Enumeration<PaymentNotice.PaymentNoticeStatus> status, DateTimeType created, Reference payment, Reference recipient, Money amount)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
A unique identifier assigned to this payment notice.
-
status
protected Enumeration<PaymentNotice.PaymentNoticeStatus> status
The status of the resource instance.
-
requestTarget
protected Resource requestTarget
The actual object that is the target of the reference (Reference of resource for which payment is being made.)
-
response
protected Reference response
Reference of response to resource for which payment is being made.
-
responseTarget
protected Resource responseTarget
The actual object that is the target of the reference (Reference of response to resource for which payment is being made.)
-
created
protected DateTimeType created
The date when this resource was created.
-
provider
protected Reference provider
The practitioner who is responsible for the services rendered to the patient.
-
providerTarget
protected Resource providerTarget
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
-
paymentTarget
protected PaymentReconciliation paymentTarget
The actual object that is the target of the reference (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.
-
payeeTarget
protected Resource payeeTarget
The actual object that is the target of the reference (The party who will receive or has received payment that is the subject of this notification.)
-
recipientTarget
protected Organization recipientTarget
The actual object that is the target of the reference (The party who is notified of the payment status.)
-
paymentStatus
protected CodeableConcept paymentStatus
A code indicating whether payment has been sent or cleared.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: The business identifier of the notice
Type: token
Path: PaymentNotice.identifier
-
SP_REQUEST
public static final String SP_REQUEST
Search parameter: requestDescription: 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 requestDescription: 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_PROVIDER
public static final String SP_PROVIDER
Search parameter: providerDescription: The reference to the provider
Type: reference
Path: PaymentNotice.provider
- See Also:
- Constant Field Values
-
PROVIDER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROVIDER
Fluent Client search parameter constant for providerDescription: The reference to the provider
Type: reference
Path: PaymentNotice.provider
-
INCLUDE_PROVIDER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PROVIDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:provider".
-
SP_CREATED
public static final String SP_CREATED
Search parameter: createdDescription: Creation date fro 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 createdDescription: Creation date fro the notice
Type: date
Path: PaymentNotice.created
-
SP_RESPONSE
public static final String SP_RESPONSE
Search parameter: responseDescription: 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 responseDescription: 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_PAYMENT_STATUS
public static final String SP_PAYMENT_STATUS
Search parameter: payment-statusDescription: 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-statusDescription: The type of payment notice
Type: token
Path: PaymentNotice.paymentStatus
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: The status of the payment notice
Type: token
Path: PaymentNotice.status
-
-
Constructor Detail
-
PaymentNotice
public PaymentNotice()
Constructor
-
PaymentNotice
public PaymentNotice(Enumeration<PaymentNotice.PaymentNoticeStatus> status, DateTimeType created, Reference payment, Reference recipient, Money amount)
Constructor
-
-
Method Detail
-
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
thisfor 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
-
getStatusElement
public Enumeration<PaymentNotice.PaymentNoticeStatus> 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<PaymentNotice.PaymentNoticeStatus> 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 PaymentNotice.PaymentNoticeStatus getStatus()
- Returns:
- The status of the resource instance.
-
setStatus
public PaymentNotice setStatus(PaymentNotice.PaymentNoticeStatus 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.)
-
getRequestTarget
public Resource getRequestTarget()
- Returns:
requestThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Reference of resource for which payment is being made.)
-
setRequestTarget
public PaymentNotice setRequestTarget(Resource value)
- Parameters:
value-requestThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
-
getResponseTarget
public Resource getResponseTarget()
- Returns:
responseThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Reference of response to resource for which payment is being made.)
-
setResponseTarget
public PaymentNotice setResponseTarget(Resource value)
- Parameters:
value-responseThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.
-
getProvider
public Reference getProvider()
- Returns:
provider(The practitioner who is responsible for the services rendered to the patient.)
-
hasProvider
public boolean hasProvider()
-
setProvider
public PaymentNotice setProvider(Reference value)
- Parameters:
value-provider(The practitioner who is responsible for the services rendered to the patient.)
-
getProviderTarget
public Resource getProviderTarget()
- Returns:
providerThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The practitioner who is responsible for the services rendered to the patient.)
-
setProviderTarget
public PaymentNotice setProviderTarget(Resource value)
- Parameters:
value-providerThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The practitioner who is responsible for the services rendered to the patient.)
-
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.)
-
getPaymentTarget
public PaymentReconciliation getPaymentTarget()
- Returns:
paymentThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A reference to the payment which is the subject of this notice.)
-
setPaymentTarget
public PaymentNotice setPaymentTarget(PaymentReconciliation value)
- Parameters:
value-paymentThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
-
getPayeeTarget
public Resource getPayeeTarget()
- Returns:
payeeThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The party who will receive or has received payment that is the subject of this notification.)
-
setPayeeTarget
public PaymentNotice setPayeeTarget(Resource value)
- Parameters:
value-payeeThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
-
getRecipientTarget
public Organization getRecipientTarget()
- Returns:
recipientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The party who is notified of the payment status.)
-
setRecipientTarget
public PaymentNotice setRecipientTarget(Organization value)
- Parameters:
value-recipientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The party who is notified of the payment status.)
-
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:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public PaymentNotice copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(PaymentNotice dst)
-
typedCopy
protected PaymentNotice typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-