Class ClaimResponse

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.ClaimResponse
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 ClaimResponse extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR ClaimResponse Resource ()

Definition: This resource provides the adjudication details from the processing of a Claim resource.

Requirements:

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

See Also:
Serialized Form
  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: The identity of the insurer
      Type: token
      Path: ClaimResponse.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 identity of the insurer
      Type: token
      Path: ClaimResponse.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 referrence

    • setRequest

      Sets the value(s) for request ()

      Definition: Original request resource referrence

    • 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

      public ClaimResponse setRuleset(CodingDt theValue)
      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 ClaimResponse 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 ClaimResponse 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

    • 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.

    • 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 ClaimResponse 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 ClaimResponse setDisposition(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for disposition ()

      Definition: A description of the status of the adjudication.

    • setDisposition

      public ClaimResponse setDisposition(String theString)
      Sets the value for disposition ()

      Definition: A description of the status of the adjudication.

    • getPayeeType

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

      Definition: Party to be reimbursed: Subscriber, provider, other.

    • setPayeeType

      public ClaimResponse setPayeeType(CodingDt theValue)
      Sets the value(s) for payeeType ()

      Definition: Party to be reimbursed: Subscriber, provider, other.

    • getItem

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

      Definition: The first tier service adjudications for submitted services.

    • setItem

      Sets the value(s) for item ()

      Definition: The first tier service adjudications for submitted services.

    • addItem

      Adds and returns a new value for item ()

      Definition: The first tier service adjudications for submitted services.

    • addItem

      Adds a given new value for item ()

      Definition: The first tier service adjudications for submitted services.

      Parameters:
      theValue - The item to add (must not be null)
    • getItemFirstRep

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

      Definition: The first tier service adjudications for submitted services.

    • getAddItem

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

      Definition: The first tier service adjudications for payor added services.

    • setAddItem

      Sets the value(s) for addItem ()

      Definition: The first tier service adjudications for payor added services.

    • addAddItem

      Adds and returns a new value for addItem ()

      Definition: The first tier service adjudications for payor added services.

    • addAddItem

      Adds a given new value for addItem ()

      Definition: The first tier service adjudications for payor added services.

      Parameters:
      theValue - The addItem to add (must not be null)
    • getAddItemFirstRep

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

      Definition: The first tier service adjudications for payor added services.

    • getError

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

      Definition: Mutually exclusive with Services Provided (Item).

    • setError

      Sets the value(s) for error ()

      Definition: Mutually exclusive with Services Provided (Item).

    • addError

      Adds and returns a new value for error ()

      Definition: Mutually exclusive with Services Provided (Item).

    • addError

      Adds a given new value for error ()

      Definition: Mutually exclusive with Services Provided (Item).

      Parameters:
      theValue - The error to add (must not be null)
    • getErrorFirstRep

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

      Definition: Mutually exclusive with Services Provided (Item).

    • getTotalCost

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

      Definition: The total cost of the services reported.

    • setTotalCost

      public ClaimResponse setTotalCost(MoneyDt theValue)
      Sets the value(s) for totalCost ()

      Definition: The total cost of the services reported.

    • getUnallocDeductable

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

      Definition: The amount of deductible applied which was not allocated to any particular service line.

    • setUnallocDeductable

      Sets the value(s) for unallocDeductable ()

      Definition: The amount of deductible applied which was not allocated to any particular service line.

    • getTotalBenefit

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

      Definition: Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible)

    • setTotalBenefit

      public ClaimResponse setTotalBenefit(MoneyDt theValue)
      Sets the value(s) for totalBenefit ()

      Definition: Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible)

    • getPaymentAdjustment

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

      Definition: Adjustment to the payment of this transaction which is not related to adjudication of this transaction.

    • setPaymentAdjustment

      Sets the value(s) for paymentAdjustment ()

      Definition: Adjustment to the payment of this transaction which is not related to adjudication of this transaction.

    • getPaymentAdjustmentReason

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

      Definition: Reason for the payment adjustment.

    • setPaymentAdjustmentReason

      Sets the value(s) for paymentAdjustmentReason ()

      Definition: Reason for the payment adjustment.

    • getPaymentDateElement

      public ca.uhn.fhir.model.primitive.DateDt getPaymentDateElement()
      Gets the value(s) for paymentDate (). creating it if it does not exist. Will not return null.

      Definition: Estimated payment data

    • getPaymentDate

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

      Definition: Estimated payment data

    • setPaymentDate

      public ClaimResponse setPaymentDate(ca.uhn.fhir.model.primitive.DateDt theValue)
      Sets the value(s) for paymentDate ()

      Definition: Estimated payment data

    • setPaymentDate

      public ClaimResponse setPaymentDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for paymentDate ()

      Definition: Estimated payment data

    • setPaymentDateWithDayPrecision

      Sets the value for paymentDate ()

      Definition: Estimated payment data

    • getPaymentAmount

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

      Definition: Payable less any payment adjustment.

    • setPaymentAmount

      public ClaimResponse setPaymentAmount(MoneyDt theValue)
      Sets the value(s) for paymentAmount ()

      Definition: Payable less any payment adjustment.

    • getPaymentRef

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

      Definition: Payment identifier

    • setPaymentRef

      Sets the value(s) for paymentRef ()

      Definition: Payment identifier

    • getReserved

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

      Definition: Status of funds reservation (For provider, for Patient, None).

    • setReserved

      public ClaimResponse setReserved(CodingDt theValue)
      Sets the value(s) for reserved ()

      Definition: Status of funds reservation (For provider, for Patient, None).

    • 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 ClaimResponse setForm(CodingDt theValue)
      Sets the value(s) for form ()

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

    • getNote

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

      Definition: Note text

    • setNote

      Sets the value(s) for note ()

      Definition: Note text

    • addNote

      Adds and returns a new value for note ()

      Definition: Note text

    • addNote

      Adds a given new value for note ()

      Definition: Note text

      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: Note text

    • getCoverage

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

      Definition: Financial instrument by which payment information for health care

    • setCoverage

      Sets the value(s) for coverage ()

      Definition: Financial instrument by which payment information for health care

    • addCoverage

      Adds and returns a new value for coverage ()

      Definition: Financial instrument by which payment information for health care

    • addCoverage

      Adds a given new value for coverage ()

      Definition: Financial instrument by which payment information for health care

      Parameters:
      theValue - The coverage to add (must not be null)
    • getCoverageFirstRep

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

      Definition: Financial instrument by which payment information for health care

    • 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