Class ClaimResponse
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.ClaimResponse
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class ClaimResponse extends DomainResource
This resource provides the adjudication details from the processing of a Claim resource.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClaimResponse.AddItem
The first-tier service adjudications for payor added product or service lines.static class
ClaimResponse.Builder
static class
ClaimResponse.Error
Errors encountered during the processing of the adjudication.static class
ClaimResponse.Insurance
Financial instruments for reimbursement for the health care products and services specified on the claim.static class
ClaimResponse.Item
A claim line.static class
ClaimResponse.Payment
Payment details for the adjudication of the claim.static class
ClaimResponse.ProcessNote
A note that describes or explains adjudication results in a human readable form.static class
ClaimResponse.Total
Categorized monetary totals for the adjudication.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ClaimResponse.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<ClaimResponse.AddItem>
getAddItem()
The first-tier service adjudications for payor added product or service lines.java.util.List<ClaimResponse.Item.Adjudication>
getAdjudication()
The adjudication results which are presented at the header level rather than at the line-item or add-item levels.java.util.List<Reference>
getCommunicationRequest()
Request for additional supporting or authorizing information.DateTime
getCreated()
The date this resource was created.String
getDisposition()
A human readable description of the status of the adjudication.java.util.List<ClaimResponse.Error>
getError()
Errors encountered during the processing of the adjudication.Attachment
getForm()
The actual form, by reference or inclusion, for printing the content or an EOB.CodeableConcept
getFormCode()
A code for the form to be used for printing the content.CodeableConcept
getFundsReserve()
A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.java.util.List<Identifier>
getIdentifier()
A unique identifier assigned to this claim response.java.util.List<ClaimResponse.Insurance>
getInsurance()
Financial instruments for reimbursement for the health care products and services specified on the claim.Reference
getInsurer()
The party responsible for authorization, adjudication and reimbursement.java.util.List<ClaimResponse.Item>
getItem()
A claim line.RemittanceOutcome
getOutcome()
The outcome of the claim, predetermination, or preauthorization processing.Reference
getPatient()
The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.CodeableConcept
getPayeeType()
Type of Party to be reimbursed: subscriber, provider, other.ClaimResponse.Payment
getPayment()
Payment details for the adjudication of the claim.Period
getPreAuthPeriod()
The time frame during which this authorization is effective.String
getPreAuthRef()
Reference from the Insurer which is used in later communications which refers to this adjudication.java.util.List<ClaimResponse.ProcessNote>
getProcessNote()
A note that describes or explains adjudication results in a human readable form.Reference
getRequest()
Original request resource reference.Reference
getRequestor()
The provider which is responsible for the claim, predetermination or preauthorization.ClaimResponseStatus
getStatus()
The status of the resource instance.CodeableConcept
getSubType()
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.java.util.List<ClaimResponse.Total>
getTotal()
Categorized monetary totals for the adjudication.CodeableConcept
getType()
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.Use
getUse()
A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.boolean
hasChildren()
int
hashCode()
ClaimResponse.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
A unique identifier assigned to this claim response.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public ClaimResponseStatus getStatus()
The status of the resource instance.- Returns:
- An immutable object of type
ClaimResponseStatus
that is non-null.
-
getType
public CodeableConcept getType()
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.- Returns:
- An immutable object of type
CodeableConcept
that is non-null.
-
getSubType
public CodeableConcept getSubType()
A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getUse
public Use getUse()
A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.- Returns:
- An immutable object of type
Use
that is non-null.
-
getPatient
public Reference getPatient()
The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getCreated
public DateTime getCreated()
The date this resource was created.- Returns:
- An immutable object of type
DateTime
that is non-null.
-
getInsurer
public Reference getInsurer()
The party responsible for authorization, adjudication and reimbursement.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getRequestor
public Reference getRequestor()
The provider which is responsible for the claim, predetermination or preauthorization.- Returns:
- An immutable object of type
Reference
that may be null.
-
getRequest
public Reference getRequest()
Original request resource reference.- Returns:
- An immutable object of type
Reference
that may be null.
-
getOutcome
public RemittanceOutcome getOutcome()
The outcome of the claim, predetermination, or preauthorization processing.- Returns:
- An immutable object of type
RemittanceOutcome
that is non-null.
-
getDisposition
public String getDisposition()
A human readable description of the status of the adjudication.- Returns:
- An immutable object of type
String
that may be null.
-
getPreAuthRef
public String getPreAuthRef()
Reference from the Insurer which is used in later communications which refers to this adjudication.- Returns:
- An immutable object of type
String
that may be null.
-
getPreAuthPeriod
public Period getPreAuthPeriod()
The time frame during which this authorization is effective.- Returns:
- An immutable object of type
Period
that may be null.
-
getPayeeType
public CodeableConcept getPayeeType()
Type of Party to be reimbursed: subscriber, provider, other.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getItem
public java.util.List<ClaimResponse.Item> getItem()
A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.- Returns:
- An unmodifiable list containing immutable objects of type
ClaimResponse.Item
that may be empty.
-
getAddItem
public java.util.List<ClaimResponse.AddItem> getAddItem()
The first-tier service adjudications for payor added product or service lines.- Returns:
- An unmodifiable list containing immutable objects of type
ClaimResponse.AddItem
that may be empty.
-
getAdjudication
public java.util.List<ClaimResponse.Item.Adjudication> getAdjudication()
The adjudication results which are presented at the header level rather than at the line-item or add-item levels.- Returns:
- An unmodifiable list containing immutable objects of type
Adjudication
that may be empty.
-
getTotal
public java.util.List<ClaimResponse.Total> getTotal()
Categorized monetary totals for the adjudication.- Returns:
- An unmodifiable list containing immutable objects of type
ClaimResponse.Total
that may be empty.
-
getPayment
public ClaimResponse.Payment getPayment()
Payment details for the adjudication of the claim.- Returns:
- An immutable object of type
ClaimResponse.Payment
that may be null.
-
getFundsReserve
public CodeableConcept getFundsReserve()
A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getFormCode
public CodeableConcept getFormCode()
A code for the form to be used for printing the content.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getForm
public Attachment getForm()
The actual form, by reference or inclusion, for printing the content or an EOB.- Returns:
- An immutable object of type
Attachment
that may be null.
-
getProcessNote
public java.util.List<ClaimResponse.ProcessNote> getProcessNote()
A note that describes or explains adjudication results in a human readable form.- Returns:
- An unmodifiable list containing immutable objects of type
ClaimResponse.ProcessNote
that may be empty.
-
getCommunicationRequest
public java.util.List<Reference> getCommunicationRequest()
Request for additional supporting or authorizing information.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getInsurance
public java.util.List<ClaimResponse.Insurance> getInsurance()
Financial instruments for reimbursement for the health care products and services specified on the claim.- Returns:
- An unmodifiable list containing immutable objects of type
ClaimResponse.Insurance
that may be empty.
-
getError
public java.util.List<ClaimResponse.Error> getError()
Errors encountered during the processing of the adjudication.- Returns:
- An unmodifiable list containing immutable objects of type
ClaimResponse.Error
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ClaimResponse.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static ClaimResponse.Builder builder()
-
-