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 Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
-
Field Summary
Modifier 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 DateTimeType
The date when the enclosed suite of services were performed or completed.protected StringType
A description of the status of the adjudication.protected List
<ClaimResponse.ErrorsComponent> Mutually exclusive with Services Provided (Item).protected Coding
The 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 Reference
The Insurer who produced this adjudicated response.protected Organization
The actual object that is the target of the reference (The Insurer who produced this adjudicated response.)protected Coding
The style (standard) and version of the original material which was converted into this resource.protected Enumeration
<Enumerations.RemittanceOutcome> Transaction status: error, complete.protected Coding
Party to be reimbursed: Subscriber, provider, other.protected Money
Adjustment to the payment of this transaction which is not related to adjudication of this transaction.protected Coding
Reason for the payment adjustment.protected Money
Payable less any payment adjustment.protected DateType
Estimated payment data.protected Identifier
Payment identifier.protected Reference
Original request resource referrence.protected Reference
The organization which is responsible for the services rendered to the patient.protected Organization
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)protected Reference
The practitioner who is responsible for the services rendered to the patient.protected Practitioner
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)protected Claim
The actual object that is the target of the reference (Original request resource referrence.)protected Coding
Status of funds reservation (For provider, for Patient, None).protected Coding
The version of the style of resource contents.static final String
protected Money
Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).protected Money
The total cost of the services reported.protected Money
The 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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_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_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddError()
addItem()
addNote()
copy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getError()
getForm()
getItem()
getNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasError()
boolean
hasForm()
boolean
boolean
hasItem()
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(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) void
setProperty
(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 ClaimResponse
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
The Response business identifier. -
request
Original request resource referrence. -
requestTarget
The actual object that is the target of the reference (Original request resource referrence.) -
ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
created
The date when the enclosed suite of services were performed or completed. -
organization
The Insurer who produced this adjudicated response. -
organizationTarget
The actual object that is the target of the reference (The Insurer who produced this adjudicated response.) -
requestProvider
The practitioner who is responsible for the services rendered to the patient. -
requestProviderTarget
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.) -
requestOrganization
The organization which is responsible for the services rendered to the patient. -
requestOrganizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.) -
outcome
Transaction status: error, complete. -
disposition
A description of the status of the adjudication. -
payeeType
Party to be reimbursed: Subscriber, provider, other. -
item
The first tier service adjudications for submitted services. -
addItem
The first tier service adjudications for payor added services. -
error
Mutually exclusive with Services Provided (Item). -
totalCost
The total cost of the services reported. -
unallocDeductable
The amount of deductible applied which was not allocated to any particular service line. -
totalBenefit
Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible). -
paymentAdjustment
Adjustment to the payment of this transaction which is not related to adjudication of this transaction. -
paymentAdjustmentReason
Reason for the payment adjustment. -
paymentDate
Estimated payment data. -
paymentAmount
Payable less any payment adjustment. -
paymentRef
Payment identifier. -
reserved
Status of funds reservation (For provider, for Patient, None). -
form
The form to be used for printing the content. -
note
Note text. -
coverage
Financial instrument by which payment information for health care. -
SP_IDENTIFIER
- See Also:
-
-
Constructor Details
-
ClaimResponse
public 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:
request
The 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
-request
The 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:
organization
The 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
-organization
The 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:
requestProvider
The 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
-requestProvider
The 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:
requestOrganization
The 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
-requestOrganization
The 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:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-