
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
This resource provides the adjudication details from the processing of a
 Claim resource.
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected List<ClaimResponse.AddedItemComponent> The first tier service adjudications for payor added services.protected List<ClaimResponse.CoverageComponent> Financial instrument by which payment information for health care.protected DateTimeTypeThe date when the enclosed suite of services were performed or completed.protected StringTypeA description of the status of the adjudication.protected List<ClaimResponse.ErrorsComponent> Mutually exclusive with Services Provided (Item).protected CodingThe form to be used for printing the content.protected List<Identifier> The Response business identifier.protected List<ClaimResponse.ItemsComponent> The first tier service adjudications for submitted services.protected List<ClaimResponse.NotesComponent> Note text.protected ReferenceThe Insurer who produced this adjudicated response.protected OrganizationThe actual object that is the target of the reference (The Insurer who produced this adjudicated response.)protected CodingThe style (standard) and version of the original material which was converted into this resource.protected Enumeration<Enumerations.RemittanceOutcome> Transaction status: error, complete.protected CodingParty to be reimbursed: Subscriber, provider, other.protected MoneyAdjustment to the payment of this transaction which is not related to adjudication of this transaction.protected CodingReason for the payment adjustment.protected MoneyPayable less any payment adjustment.protected DateTypeEstimated payment data.protected IdentifierPayment identifier.protected ReferenceOriginal request resource referrence.protected ReferenceThe organization which is responsible for the services rendered to the patient.protected OrganizationThe actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)protected ReferenceThe practitioner who is responsible for the services rendered to the patient.protected PractitionerThe actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)protected ClaimThe actual object that is the target of the reference (Original request resource referrence.)protected CodingStatus of funds reservation (For provider, for Patient, None).protected CodingThe version of the style of resource contents.static final Stringprotected MoneyTotal amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).protected MoneyThe total cost of the services reported.protected MoneyThe amount of deductible applied which was not allocated to any particular service line.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResourcecontained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu2.model.Resourceid, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResourceRES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResourceINCLUDE_ALL, WILDCARD_ALL_SET
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionaddError()addItem()addNote()copy()booleanequalsDeep(Base other) booleanequalsShallow(Base other) fhirType()getError()getForm()getItem()getNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanhasError()booleanhasForm()booleanbooleanhasItem()booleanhasNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> childrenList) setCreated(Date value) setCreatedElement(DateTimeType value) setDisposition(String value) setDispositionElement(StringType value) setOrganization(Reference value) setOriginalRuleset(Coding value) setPayeeType(Coding value) setPaymentAdjustment(Money value) setPaymentAdjustmentReason(Coding value) setPaymentAmount(Money value) setPaymentDate(Date value) setPaymentDateElement(DateType value) setPaymentRef(Identifier value) voidsetProperty(String name, Base value) setRequest(Reference value) setRequestOrganization(Reference value) setRequestProvider(Reference value) setRequestTarget(Claim value) setReserved(Coding value) setRuleset(Coding value) setTotalBenefit(Money value) setTotalCost(Money value) setUnallocDeductable(Money value) protected ClaimResponseMethods inherited from class org.hl7.fhir.dstu2.model.DomainResourceaddContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setTextMethods inherited from class org.hl7.fhir.dstu2.model.ResourcecopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.dstu2.model.BaseResourcegetStructureFhirVersionEnum, setIdMethods inherited from class org.hl7.fhir.dstu2.model.BasecastToAddress, 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, setUserDataINNMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResourcegetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBasegetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResourcegetMeta, getStructureFhirVersionEnum, isDeleted, setId
- 
Field Details- 
identifierThe Response business identifier.
- 
requestOriginal request resource referrence.
- 
requestTargetThe actual object that is the target of the reference (Original request resource referrence.)
- 
rulesetThe version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
- 
originalRulesetThe style (standard) and version of the original material which was converted into this resource.
- 
createdThe date when the enclosed suite of services were performed or completed.
- 
organizationThe Insurer who produced this adjudicated response.
- 
organizationTargetThe actual object that is the target of the reference (The Insurer who produced this adjudicated response.)
- 
requestProviderThe practitioner who is responsible for the services rendered to the patient.
- 
requestProviderTargetThe actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
- 
requestOrganizationThe organization which is responsible for the services rendered to the patient.
- 
requestOrganizationTargetThe actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)
- 
outcomeTransaction status: error, complete.
- 
dispositionA description of the status of the adjudication.
- 
payeeTypeParty to be reimbursed: Subscriber, provider, other.
- 
itemThe first tier service adjudications for submitted services.
- 
addItemThe first tier service adjudications for payor added services.
- 
errorMutually exclusive with Services Provided (Item).
- 
totalCostThe total cost of the services reported.
- 
unallocDeductableThe amount of deductible applied which was not allocated to any particular service line.
- 
totalBenefitTotal amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).
- 
paymentAdjustmentAdjustment to the payment of this transaction which is not related to adjudication of this transaction.
- 
paymentAdjustmentReasonReason for the payment adjustment.
- 
paymentDateEstimated payment data.
- 
paymentAmountPayable less any payment adjustment.
- 
paymentRefPayment identifier.
- 
reservedStatus of funds reservation (For provider, for Patient, None).
- 
formThe form to be used for printing the content.
- 
noteNote text.
- 
coverageFinancial instrument by which payment information for health care.
- 
SP_IDENTIFIER- See Also:
 
 
- 
- 
Constructor Details- 
ClaimResponsepublic ClaimResponse()
 
- 
- 
Method Details- 
getIdentifier- Returns:
- identifier(The Response business identifier.)
 
- 
hasIdentifier
- 
addIdentifier- Returns:
- identifier(The Response business identifier.)
 
- 
addIdentifier
- 
getRequest- Returns:
- request(Original request resource referrence.)
 
- 
hasRequest
- 
setRequest- Parameters:
- value-- request(Original request resource referrence.)
 
- 
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- 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- Returns:
- ruleset(The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)
 
- 
hasRuleset
- 
setRuleset- 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- Returns:
- originalRuleset(The style (standard) and version of the original material which was converted into this resource.)
 
- 
hasOriginalRuleset
- 
setOriginalRuleset- Parameters:
- value-- originalRuleset(The style (standard) and version of the original material which was converted into this resource.)
 
- 
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
- 
hasCreated
- 
setCreatedElement- 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- Returns:
- The date when the enclosed suite of services were performed or completed.
 
- 
setCreated- Parameters:
- value- The date when the enclosed suite of services were performed or completed.
 
- 
getOrganization- Returns:
- organization(The Insurer who produced this adjudicated response.)
 
- 
hasOrganization
- 
setOrganization- Parameters:
- value-- organization(The Insurer who produced this adjudicated response.)
 
- 
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- 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- Returns:
- requestProvider(The practitioner who is responsible for the services rendered to the patient.)
 
- 
hasRequestProvider
- 
setRequestProvider- Parameters:
- value-- requestProvider(The practitioner who is responsible for the services rendered to the patient.)
 
- 
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- 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- Returns:
- requestOrganization(The organization which is responsible for the services rendered to the patient.)
 
- 
hasRequestOrganization
- 
setRequestOrganization- Parameters:
- value-- requestOrganization(The organization which is responsible for the services rendered to the patient.)
 
- 
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- 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- 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
- 
hasOutcome
- 
setOutcomeElement- 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- Returns:
- Transaction status: error, complete.
 
- 
setOutcome- Parameters:
- value- Transaction status: error, complete.
 
- 
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
- 
hasDisposition
- 
setDispositionElement- 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- Returns:
- A description of the status of the adjudication.
 
- 
setDisposition- Parameters:
- value- A description of the status of the adjudication.
 
- 
getPayeeType- Returns:
- payeeType(Party to be reimbursed: Subscriber, provider, other.)
 
- 
hasPayeeType
- 
setPayeeType- Parameters:
- value-- payeeType(Party to be reimbursed: Subscriber, provider, other.)
 
- 
getItem- Returns:
- item(The first tier service adjudications for submitted services.)
 
- 
hasItem
- 
addItem- Returns:
- item(The first tier service adjudications for submitted services.)
 
- 
addItem
- 
getAddItem- Returns:
- addItem(The first tier service adjudications for payor added services.)
 
- 
hasAddItem
- 
addAddItem- Returns:
- addItem(The first tier service adjudications for payor added services.)
 
- 
addAddItem
- 
getError- Returns:
- error(Mutually exclusive with Services Provided (Item).)
 
- 
hasError
- 
addError- Returns:
- error(Mutually exclusive with Services Provided (Item).)
 
- 
addError
- 
getTotalCost- Returns:
- totalCost(The total cost of the services reported.)
 
- 
hasTotalCost
- 
setTotalCost- Parameters:
- value-- totalCost(The total cost of the services reported.)
 
- 
getUnallocDeductable- Returns:
- unallocDeductable(The amount of deductible applied which was not allocated to any particular service line.)
 
- 
hasUnallocDeductable
- 
setUnallocDeductable- Parameters:
- value-- unallocDeductable(The amount of deductible applied which was not allocated to any particular service line.)
 
- 
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
- 
setTotalBenefit- 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- Returns:
- paymentAdjustment(Adjustment to the payment of this transaction which is not related to adjudication of this transaction.)
 
- 
hasPaymentAdjustment
- 
setPaymentAdjustment- Parameters:
- value-- paymentAdjustment(Adjustment to the payment of this transaction which is not related to adjudication of this transaction.)
 
- 
getPaymentAdjustmentReason- Returns:
- paymentAdjustmentReason(Reason for the payment adjustment.)
 
- 
hasPaymentAdjustmentReason
- 
setPaymentAdjustmentReason- Parameters:
- value-- paymentAdjustmentReason(Reason for the payment adjustment.)
 
- 
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
- 
hasPaymentDate
- 
setPaymentDateElement- 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- Returns:
- Estimated payment data.
 
- 
setPaymentDate- Parameters:
- value- Estimated payment data.
 
- 
getPaymentAmount- Returns:
- paymentAmount(Payable less any payment adjustment.)
 
- 
hasPaymentAmount
- 
setPaymentAmount- Parameters:
- value-- paymentAmount(Payable less any payment adjustment.)
 
- 
getPaymentRef- Returns:
- paymentRef(Payment identifier.)
 
- 
hasPaymentRef
- 
setPaymentRef- Parameters:
- value-- paymentRef(Payment identifier.)
 
- 
getReserved- Returns:
- reserved(Status of funds reservation (For provider, for Patient, None).)
 
- 
hasReserved
- 
setReserved- Parameters:
- value-- reserved(Status of funds reservation (For provider, for Patient, None).)
 
- 
getForm- Returns:
- form(The form to be used for printing the content.)
 
- 
hasForm
- 
setForm- Parameters:
- value-- form(The form to be used for printing the content.)
 
- 
getNote- Returns:
- note(Note text.)
 
- 
hasNote
- 
addNote- Returns:
- note(Note text.)
 
- 
addNote
- 
getCoverage- Returns:
- coverage(Financial instrument by which payment information for health care.)
 
- 
hasCoverage
- 
addCoverage- Returns:
- coverage(Financial instrument by which payment information for health care.)
 
- 
addCoverage
- 
listChildren- Overrides:
- listChildrenin class- DomainResource
 
- 
setProperty- Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
addChild- Overrides:
- addChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
fhirType- Specified by:
- fhirTypein interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- fhirTypein class- DomainResource
 
- 
copy- Specified by:
- copyin class- DomainResource
 
- 
typedCopy
- 
equalsDeep- Overrides:
- equalsDeepin class- DomainResource
 
- 
equalsShallow- Overrides:
- equalsShallowin class- DomainResource
 
- 
isEmpty- Specified by:
- isEmptyin interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- isEmptyin class- DomainResource
 
- 
getResourceType- Specified by:
- getResourceTypein class- Resource
 
 
-