Package org.hl7.fhir.dstu2.model
Class ClaimResponse
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.ClaimResponse
-
- 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 ClaimResponse extends DomainResource
This resource provides the adjudication details from the processing of a Claim resource.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classClaimResponse.AddedItemAdjudicationComponentstatic classClaimResponse.AddedItemComponentstatic classClaimResponse.AddedItemDetailAdjudicationComponentstatic classClaimResponse.AddedItemsDetailComponentstatic classClaimResponse.CoverageComponentstatic classClaimResponse.DetailAdjudicationComponentstatic classClaimResponse.ErrorsComponentstatic classClaimResponse.ItemAdjudicationComponentstatic classClaimResponse.ItemDetailComponentstatic classClaimResponse.ItemsComponentstatic classClaimResponse.NotesComponentstatic classClaimResponse.SubdetailAdjudicationComponentstatic classClaimResponse.SubDetailComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<ClaimResponse.AddedItemComponent>addItemThe first tier service adjudications for payor added services.protected List<ClaimResponse.CoverageComponent>coverageFinancial instrument by which payment information for health care.protected DateTimeTypecreatedThe date when the enclosed suite of services were performed or completed.protected StringTypedispositionA description of the status of the adjudication.protected List<ClaimResponse.ErrorsComponent>errorMutually exclusive with Services Provided (Item).protected CodingformThe form to be used for printing the content.protected List<Identifier>identifierThe Response business identifier.protected List<ClaimResponse.ItemsComponent>itemThe first tier service adjudications for submitted services.protected List<ClaimResponse.NotesComponent>noteNote text.protected ReferenceorganizationThe Insurer who produced this adjudicated response.protected OrganizationorganizationTargetThe actual object that is the target of the reference (The Insurer who produced this adjudicated response.)protected CodingoriginalRulesetThe style (standard) and version of the original material which was converted into this resource.protected Enumeration<Enumerations.RemittanceOutcome>outcomeTransaction status: error, complete.protected CodingpayeeTypeParty to be reimbursed: Subscriber, provider, other.protected MoneypaymentAdjustmentAdjustment to the payment of this transaction which is not related to adjudication of this transaction.protected CodingpaymentAdjustmentReasonReason for the payment adjustment.protected MoneypaymentAmountPayable less any payment adjustment.protected DateTypepaymentDateEstimated payment data.protected IdentifierpaymentRefPayment identifier.protected ReferencerequestOriginal request resource referrence.protected ReferencerequestOrganizationThe organization which is responsible for the services rendered to the patient.protected OrganizationrequestOrganizationTargetThe actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)protected ReferencerequestProviderThe practitioner who is responsible for the services rendered to the patient.protected PractitionerrequestProviderTargetThe actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)protected ClaimrequestTargetThe actual object that is the target of the reference (Original request resource referrence.)protected CodingreservedStatus of funds reservation (For provider, for Patient, None).protected CodingrulesetThe version of the style of resource contents.static StringSP_IDENTIFIERprotected MoneytotalBenefitTotal amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).protected MoneytotalCostThe total cost of the services reported.protected MoneyunallocDeductableThe amount of deductible applied which was not allocated to any particular service line.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ClaimResponse()
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
The Response business identifier.
-
requestTarget
protected Claim requestTarget
The actual object that is the target of the reference (Original request resource referrence.)
-
ruleset
protected Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
-
originalRuleset
protected Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource.
-
created
protected DateTimeType created
The date when the enclosed suite of services were performed or completed.
-
organization
protected Reference organization
The Insurer who produced this adjudicated response.
-
organizationTarget
protected Organization organizationTarget
The actual object that is the target of the reference (The Insurer who produced this adjudicated response.)
-
requestProvider
protected Reference requestProvider
The practitioner who is responsible for the services rendered to the patient.
-
requestProviderTarget
protected Practitioner requestProviderTarget
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
-
requestOrganization
protected Reference requestOrganization
The organization which is responsible for the services rendered to the patient.
-
requestOrganizationTarget
protected Organization requestOrganizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)
-
outcome
protected Enumeration<Enumerations.RemittanceOutcome> outcome
Transaction status: error, complete.
-
disposition
protected StringType disposition
A description of the status of the adjudication.
-
item
protected List<ClaimResponse.ItemsComponent> item
The first tier service adjudications for submitted services.
-
addItem
protected List<ClaimResponse.AddedItemComponent> addItem
The first tier service adjudications for payor added services.
-
error
protected List<ClaimResponse.ErrorsComponent> error
Mutually exclusive with Services Provided (Item).
-
unallocDeductable
protected Money unallocDeductable
The amount of deductible applied which was not allocated to any particular service line.
-
totalBenefit
protected Money totalBenefit
Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).
-
paymentAdjustment
protected Money paymentAdjustment
Adjustment to the payment of this transaction which is not related to adjudication of this transaction.
-
paymentAdjustmentReason
protected Coding paymentAdjustmentReason
Reason for the payment adjustment.
-
paymentDate
protected DateType paymentDate
Estimated payment data.
-
paymentAmount
protected Money paymentAmount
Payable less any payment adjustment.
-
paymentRef
protected Identifier paymentRef
Payment identifier.
-
note
protected List<ClaimResponse.NotesComponent> note
Note text.
-
coverage
protected List<ClaimResponse.CoverageComponent> coverage
Financial instrument by which payment information for health care.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ClaimResponse
public ClaimResponse()
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(The Response business identifier.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(The Response business identifier.)
-
addIdentifier
public ClaimResponse addIdentifier(Identifier t)
-
getRequest
public Reference getRequest()
- Returns:
request(Original request resource referrence.)
-
hasRequest
public boolean hasRequest()
-
setRequest
public ClaimResponse setRequest(Reference value)
- Parameters:
value-request(Original request resource referrence.)
-
getRequestTarget
public Claim 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. (Original request resource referrence.)
-
setRequestTarget
public ClaimResponse setRequestTarget(Claim 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. (Original request resource referrence.)
-
getRuleset
public Coding getRuleset()
- Returns:
ruleset(The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)
-
hasRuleset
public boolean hasRuleset()
-
setRuleset
public ClaimResponse setRuleset(Coding value)
- Parameters:
value-ruleset(The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)
-
getOriginalRuleset
public Coding getOriginalRuleset()
- Returns:
originalRuleset(The style (standard) and version of the original material which was converted into this resource.)
-
hasOriginalRuleset
public boolean hasOriginalRuleset()
-
setOriginalRuleset
public ClaimResponse setOriginalRuleset(Coding value)
- Parameters:
value-originalRuleset(The style (standard) and version of the original material which was converted into this resource.)
-
getCreatedElement
public DateTimeType getCreatedElement()
- Returns:
created(The date when the enclosed suite of services were performed or completed.). 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 ClaimResponse setCreatedElement(DateTimeType value)
- Parameters:
value-created(The date when the enclosed suite of services were performed or completed.). 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 the enclosed suite of services were performed or completed.
-
setCreated
public ClaimResponse setCreated(Date value)
- Parameters:
value- The date when the enclosed suite of services were performed or completed.
-
getOrganization
public Reference getOrganization()
- Returns:
organization(The Insurer who produced this adjudicated response.)
-
hasOrganization
public boolean hasOrganization()
-
setOrganization
public ClaimResponse setOrganization(Reference value)
- Parameters:
value-organization(The Insurer who produced this adjudicated response.)
-
getOrganizationTarget
public Organization getOrganizationTarget()
- Returns:
organizationThe 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 Insurer who produced this adjudicated response.)
-
setOrganizationTarget
public ClaimResponse setOrganizationTarget(Organization value)
- Parameters:
value-organizationThe 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 Insurer who produced this adjudicated response.)
-
getRequestProvider
public Reference getRequestProvider()
- Returns:
requestProvider(The practitioner who is responsible for the services rendered to the patient.)
-
hasRequestProvider
public boolean hasRequestProvider()
-
setRequestProvider
public ClaimResponse setRequestProvider(Reference value)
- Parameters:
value-requestProvider(The practitioner who is responsible for the services rendered to the patient.)
-
getRequestProviderTarget
public Practitioner getRequestProviderTarget()
- Returns:
requestProviderThe 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.)
-
setRequestProviderTarget
public ClaimResponse setRequestProviderTarget(Practitioner value)
- Parameters:
value-requestProviderThe 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.)
-
getRequestOrganization
public Reference getRequestOrganization()
- Returns:
requestOrganization(The organization which is responsible for the services rendered to the patient.)
-
hasRequestOrganization
public boolean hasRequestOrganization()
-
setRequestOrganization
public ClaimResponse setRequestOrganization(Reference value)
- Parameters:
value-requestOrganization(The organization which is responsible for the services rendered to the patient.)
-
getRequestOrganizationTarget
public Organization getRequestOrganizationTarget()
- Returns:
requestOrganizationThe 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 organization which is responsible for the services rendered to the patient.)
-
setRequestOrganizationTarget
public ClaimResponse setRequestOrganizationTarget(Organization value)
- Parameters:
value-requestOrganizationThe 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 organization which is responsible for the services rendered to the patient.)
-
getOutcomeElement
public Enumeration<Enumerations.RemittanceOutcome> getOutcomeElement()
- Returns:
outcome(Transaction status: error, complete.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value
-
hasOutcomeElement
public boolean hasOutcomeElement()
-
hasOutcome
public boolean hasOutcome()
-
setOutcomeElement
public ClaimResponse setOutcomeElement(Enumeration<Enumerations.RemittanceOutcome> value)
- Parameters:
value-outcome(Transaction status: error, complete.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value
-
getOutcome
public Enumerations.RemittanceOutcome getOutcome()
- Returns:
- Transaction status: error, complete.
-
setOutcome
public ClaimResponse setOutcome(Enumerations.RemittanceOutcome value)
- Parameters:
value- Transaction status: error, complete.
-
getDispositionElement
public StringType getDispositionElement()
- Returns:
disposition(A description of the status of the adjudication.). This is the underlying object with id, value and extensions. The accessor "getDisposition" gives direct access to the value
-
hasDispositionElement
public boolean hasDispositionElement()
-
hasDisposition
public boolean hasDisposition()
-
setDispositionElement
public ClaimResponse setDispositionElement(StringType value)
- Parameters:
value-disposition(A description of the status of the adjudication.). This is the underlying object with id, value and extensions. The accessor "getDisposition" gives direct access to the value
-
getDisposition
public String getDisposition()
- Returns:
- A description of the status of the adjudication.
-
setDisposition
public ClaimResponse setDisposition(String value)
- Parameters:
value- A description of the status of the adjudication.
-
getPayeeType
public Coding getPayeeType()
- Returns:
payeeType(Party to be reimbursed: Subscriber, provider, other.)
-
hasPayeeType
public boolean hasPayeeType()
-
setPayeeType
public ClaimResponse setPayeeType(Coding value)
- Parameters:
value-payeeType(Party to be reimbursed: Subscriber, provider, other.)
-
getItem
public List<ClaimResponse.ItemsComponent> getItem()
- Returns:
item(The first tier service adjudications for submitted services.)
-
hasItem
public boolean hasItem()
-
addItem
public ClaimResponse.ItemsComponent addItem()
- Returns:
item(The first tier service adjudications for submitted services.)
-
addItem
public ClaimResponse addItem(ClaimResponse.ItemsComponent t)
-
getAddItem
public List<ClaimResponse.AddedItemComponent> getAddItem()
- Returns:
addItem(The first tier service adjudications for payor added services.)
-
hasAddItem
public boolean hasAddItem()
-
addAddItem
public ClaimResponse.AddedItemComponent addAddItem()
- Returns:
addItem(The first tier service adjudications for payor added services.)
-
addAddItem
public ClaimResponse addAddItem(ClaimResponse.AddedItemComponent t)
-
getError
public List<ClaimResponse.ErrorsComponent> getError()
- Returns:
error(Mutually exclusive with Services Provided (Item).)
-
hasError
public boolean hasError()
-
addError
public ClaimResponse.ErrorsComponent addError()
- Returns:
error(Mutually exclusive with Services Provided (Item).)
-
addError
public ClaimResponse addError(ClaimResponse.ErrorsComponent t)
-
getTotalCost
public Money getTotalCost()
- Returns:
totalCost(The total cost of the services reported.)
-
hasTotalCost
public boolean hasTotalCost()
-
setTotalCost
public ClaimResponse setTotalCost(Money value)
- Parameters:
value-totalCost(The total cost of the services reported.)
-
getUnallocDeductable
public Money getUnallocDeductable()
- Returns:
unallocDeductable(The amount of deductible applied which was not allocated to any particular service line.)
-
hasUnallocDeductable
public boolean hasUnallocDeductable()
-
setUnallocDeductable
public ClaimResponse setUnallocDeductable(Money value)
- Parameters:
value-unallocDeductable(The amount of deductible applied which was not allocated to any particular service line.)
-
getTotalBenefit
public Money getTotalBenefit()
- Returns:
totalBenefit(Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).)
-
hasTotalBenefit
public boolean hasTotalBenefit()
-
setTotalBenefit
public ClaimResponse setTotalBenefit(Money value)
- Parameters:
value-totalBenefit(Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).)
-
getPaymentAdjustment
public Money getPaymentAdjustment()
- Returns:
paymentAdjustment(Adjustment to the payment of this transaction which is not related to adjudication of this transaction.)
-
hasPaymentAdjustment
public boolean hasPaymentAdjustment()
-
setPaymentAdjustment
public ClaimResponse setPaymentAdjustment(Money value)
- Parameters:
value-paymentAdjustment(Adjustment to the payment of this transaction which is not related to adjudication of this transaction.)
-
getPaymentAdjustmentReason
public Coding getPaymentAdjustmentReason()
- Returns:
paymentAdjustmentReason(Reason for the payment adjustment.)
-
hasPaymentAdjustmentReason
public boolean hasPaymentAdjustmentReason()
-
setPaymentAdjustmentReason
public ClaimResponse setPaymentAdjustmentReason(Coding value)
- Parameters:
value-paymentAdjustmentReason(Reason for the payment adjustment.)
-
getPaymentDateElement
public DateType getPaymentDateElement()
- Returns:
paymentDate(Estimated payment data.). 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 ClaimResponse setPaymentDateElement(DateType value)
- Parameters:
value-paymentDate(Estimated payment data.). This is the underlying object with id, value and extensions. The accessor "getPaymentDate" gives direct access to the value
-
getPaymentDate
public Date getPaymentDate()
- Returns:
- Estimated payment data.
-
setPaymentDate
public ClaimResponse setPaymentDate(Date value)
- Parameters:
value- Estimated payment data.
-
getPaymentAmount
public Money getPaymentAmount()
- Returns:
paymentAmount(Payable less any payment adjustment.)
-
hasPaymentAmount
public boolean hasPaymentAmount()
-
setPaymentAmount
public ClaimResponse setPaymentAmount(Money value)
- Parameters:
value-paymentAmount(Payable less any payment adjustment.)
-
getPaymentRef
public Identifier getPaymentRef()
- Returns:
paymentRef(Payment identifier.)
-
hasPaymentRef
public boolean hasPaymentRef()
-
setPaymentRef
public ClaimResponse setPaymentRef(Identifier value)
- Parameters:
value-paymentRef(Payment identifier.)
-
getReserved
public Coding getReserved()
- Returns:
reserved(Status of funds reservation (For provider, for Patient, None).)
-
hasReserved
public boolean hasReserved()
-
setReserved
public ClaimResponse setReserved(Coding value)
- Parameters:
value-reserved(Status of funds reservation (For provider, for Patient, None).)
-
hasForm
public boolean hasForm()
-
setForm
public ClaimResponse setForm(Coding value)
- Parameters:
value-form(The form to be used for printing the content.)
-
getNote
public List<ClaimResponse.NotesComponent> getNote()
- Returns:
note(Note text.)
-
hasNote
public boolean hasNote()
-
addNote
public ClaimResponse.NotesComponent addNote()
- Returns:
note(Note text.)
-
addNote
public ClaimResponse addNote(ClaimResponse.NotesComponent t)
-
getCoverage
public List<ClaimResponse.CoverageComponent> getCoverage()
- Returns:
coverage(Financial instrument by which payment information for health care.)
-
hasCoverage
public boolean hasCoverage()
-
addCoverage
public ClaimResponse.CoverageComponent addCoverage()
- Returns:
coverage(Financial instrument by which payment information for health care.)
-
addCoverage
public ClaimResponse addCoverage(ClaimResponse.CoverageComponent t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin 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 ClaimResponse copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected ClaimResponse 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
-
-