Class PaymentReconciliation

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.PaymentReconciliation
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class PaymentReconciliation
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR PaymentReconciliation Resource ()

Definition: This resource provides payment details and claim references supporting a bulk payment.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/PaymentReconciliation

See Also:
Serialized Form
  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: The business identifier of the Explanation of Benefit
      Type: token
      Path: PaymentReconciliation.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 Explanation of Benefit
      Type: token
      Path: PaymentReconciliation.identifier

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

      Definition: The Response business identifier

    • setIdentifier

      Sets the value(s) for identifier ()

      Definition: The Response business identifier

    • addIdentifier

      Adds and returns a new value for identifier ()

      Definition: The Response business identifier

    • addIdentifier

      Adds a given new value for identifier ()

      Definition: The Response business identifier

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (), creating it if it does not already exist.

      Definition: The Response business identifier

    • getRequest

      Gets the value(s) for request (). creating it if it does not exist. Will not return null.

      Definition: Original request resource reference

    • setRequest

      Sets the value(s) for request ()

      Definition: Original request resource reference

    • getOutcomeElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<RemittanceOutcomeEnum> getOutcomeElement()
      Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.

      Definition: Transaction status: error, complete

    • getOutcome

      public String getOutcome()
      Gets the value(s) for outcome (). creating it if it does not exist. This method may return null.

      Definition: Transaction status: error, complete

    • setOutcome

      public PaymentReconciliation setOutcome​(ca.uhn.fhir.model.primitive.BoundCodeDt<RemittanceOutcomeEnum> theValue)
      Sets the value(s) for outcome ()

      Definition: Transaction status: error, complete

    • setOutcome

      Sets the value(s) for outcome ()

      Definition: Transaction status: error, complete

    • getDispositionElement

      public ca.uhn.fhir.model.primitive.StringDt getDispositionElement()
      Gets the value(s) for disposition (). creating it if it does not exist. Will not return null.

      Definition: A description of the status of the adjudication.

    • getDisposition

      Gets the value(s) for disposition (). creating it if it does not exist. This method may return null.

      Definition: A description of the status of the adjudication.

    • setDisposition

      public PaymentReconciliation setDisposition​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for disposition ()

      Definition: A description of the status of the adjudication.

    • setDisposition

      Sets the value for disposition ()

      Definition: A description of the status of the adjudication.

    • getRuleset

      public CodingDt getRuleset()
      Gets the value(s) for ruleset (). creating it if it does not exist. Will not return null.

      Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.

    • setRuleset

      Sets the value(s) for ruleset ()

      Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.

    • getOriginalRuleset

      Gets the value(s) for originalRuleset (). creating it if it does not exist. Will not return null.

      Definition: The style (standard) and version of the original material which was converted into this resource.

    • setOriginalRuleset

      Sets the value(s) for originalRuleset ()

      Definition: The style (standard) and version of the original material which was converted into this resource.

    • getCreatedElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getCreatedElement()
      Gets the value(s) for created (). creating it if it does not exist. Will not return null.

      Definition: The date when the enclosed suite of services were performed or completed

    • getCreated

      public Date getCreated()
      Gets the value(s) for created (). creating it if it does not exist. This method may return null.

      Definition: The date when the enclosed suite of services were performed or completed

    • setCreated

      public PaymentReconciliation setCreated​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for created ()

      Definition: The date when the enclosed suite of services were performed or completed

    • setCreated

      public PaymentReconciliation setCreated​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for created ()

      Definition: The date when the enclosed suite of services were performed or completed

    • setCreatedWithSecondsPrecision

      Sets the value for created ()

      Definition: The date when the enclosed suite of services were performed or completed

    • getPeriod

      public PeriodDt getPeriod()
      Gets the value(s) for period (). creating it if it does not exist. Will not return null.

      Definition: The period of time for which payments have been gathered into this bulk payment for settlement.

    • setPeriod

      Sets the value(s) for period ()

      Definition: The period of time for which payments have been gathered into this bulk payment for settlement.

    • getOrganization

      Gets the value(s) for organization (). creating it if it does not exist. Will not return null.

      Definition: The Insurer who produced this adjudicated response.

    • setOrganization

      Sets the value(s) for organization ()

      Definition: The Insurer who produced this adjudicated response.

    • getRequestProvider

      Gets the value(s) for requestProvider (). creating it if it does not exist. Will not return null.

      Definition: The practitioner who is responsible for the services rendered to the patient.

    • setRequestProvider

      Sets the value(s) for requestProvider ()

      Definition: The practitioner who is responsible for the services rendered to the patient.

    • getRequestOrganization

      Gets the value(s) for requestOrganization (). creating it if it does not exist. Will not return null.

      Definition: The organization which is responsible for the services rendered to the patient.

    • setRequestOrganization

      Sets the value(s) for requestOrganization ()

      Definition: The organization which is responsible for the services rendered to the patient.

    • getDetail

      Gets the value(s) for detail (). creating it if it does not exist. Will not return null.

      Definition: List of individual settlement amounts and the corresponding transaction.

    • setDetail

      Sets the value(s) for detail ()

      Definition: List of individual settlement amounts and the corresponding transaction.

    • addDetail

      Adds and returns a new value for detail ()

      Definition: List of individual settlement amounts and the corresponding transaction.

    • addDetail

      Adds a given new value for detail ()

      Definition: List of individual settlement amounts and the corresponding transaction.

      Parameters:
      theValue - The detail to add (must not be null)
    • getDetailFirstRep

      Gets the first repetition for detail (), creating it if it does not already exist.

      Definition: List of individual settlement amounts and the corresponding transaction.

    • getForm

      public CodingDt getForm()
      Gets the value(s) for form (). creating it if it does not exist. Will not return null.

      Definition: The form to be used for printing the content.

    • setForm

      public PaymentReconciliation setForm​(CodingDt theValue)
      Sets the value(s) for form ()

      Definition: The form to be used for printing the content.

    • getTotal

      public MoneyDt getTotal()
      Gets the value(s) for total (). creating it if it does not exist. Will not return null.

      Definition: Total payment amount.

    • setTotal

      public PaymentReconciliation setTotal​(MoneyDt theValue)
      Sets the value(s) for total ()

      Definition: Total payment amount.

    • getNote

      Gets the value(s) for note (). creating it if it does not exist. Will not return null.

      Definition: Suite of notes

    • setNote

      Sets the value(s) for note ()

      Definition: Suite of notes

    • addNote

      Adds and returns a new value for note ()

      Definition: Suite of notes

    • addNote

      Adds a given new value for note ()

      Definition: Suite of notes

      Parameters:
      theValue - The note to add (must not be null)
    • getNoteFirstRep

      Gets the first repetition for note (), creating it if it does not already exist.

      Definition: Suite of notes

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource