
Class 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
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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClaimResponse.AddItem
Block class for child element: ClaimResponse.addItem ()static class
ClaimResponse.AddItemAdjudication
Block class for child element: ClaimResponse.addItem.adjudication ()static class
ClaimResponse.AddItemDetail
Block class for child element: ClaimResponse.addItem.detail ()static class
ClaimResponse.AddItemDetailAdjudication
Block class for child element: ClaimResponse.addItem.detail.adjudication ()static class
ClaimResponse.Coverage
Block class for child element: ClaimResponse.coverage ()static class
ClaimResponse.Error
Block class for child element: ClaimResponse.error ()static class
ClaimResponse.Item
Block class for child element: ClaimResponse.item ()static class
ClaimResponse.ItemAdjudication
Block class for child element: ClaimResponse.item.adjudication ()static class
ClaimResponse.ItemDetail
Block class for child element: ClaimResponse.item.detail ()static class
ClaimResponse.ItemDetailAdjudication
Block class for child element: ClaimResponse.item.detail.adjudication ()static class
ClaimResponse.ItemDetailSubDetail
Block class for child element: ClaimResponse.item.detail.subDetail ()static class
ClaimResponse.ItemDetailSubDetailAdjudication
Block class for child element: ClaimResponse.item.detail.subDetail.adjudication ()static class
ClaimResponse.Note
Block class for child element: ClaimResponse.note () -
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic String
SP_IDENTIFIER
Search parameter constant for identifierFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors Constructor Description ClaimResponse()
-
Method Summary
Modifier and Type Method Description ClaimResponse.AddItem
addAddItem()
Adds and returns a new value for addItem ()ClaimResponse
addAddItem(ClaimResponse.AddItem theValue)
Adds a given new value for addItem ()ClaimResponse.Coverage
addCoverage()
Adds and returns a new value for coverage ()ClaimResponse
addCoverage(ClaimResponse.Coverage theValue)
Adds a given new value for coverage ()ClaimResponse.Error
addError()
Adds and returns a new value for error ()ClaimResponse
addError(ClaimResponse.Error theValue)
Adds a given new value for error ()IdentifierDt
addIdentifier()
Adds and returns a new value for identifier ()ClaimResponse
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier ()ClaimResponse.Item
addItem()
Adds and returns a new value for item ()ClaimResponse
addItem(ClaimResponse.Item theValue)
Adds a given new value for item ()ClaimResponse.Note
addNote()
Adds and returns a new value for note ()ClaimResponse
addNote(ClaimResponse.Note theValue)
Adds a given new value for note ()List<ClaimResponse.AddItem>
getAddItem()
Gets the value(s) for addItem ().ClaimResponse.AddItem
getAddItemFirstRep()
Gets the first repetition for addItem (), creating it if it does not already exist.<T extends ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
List<ClaimResponse.Coverage>
getCoverage()
Gets the value(s) for coverage ().ClaimResponse.Coverage
getCoverageFirstRep()
Gets the first repetition for coverage (), creating it if it does not already exist.Date
getCreated()
Gets the value(s) for created ().ca.uhn.fhir.model.primitive.DateTimeDt
getCreatedElement()
Gets the value(s) for created ().String
getDisposition()
Gets the value(s) for disposition ().ca.uhn.fhir.model.primitive.StringDt
getDispositionElement()
Gets the value(s) for disposition ().List<ClaimResponse.Error>
getError()
Gets the value(s) for error ().ClaimResponse.Error
getErrorFirstRep()
Gets the first repetition for error (), creating it if it does not already exist.CodingDt
getForm()
Gets the value(s) for form ().List<IdentifierDt>
getIdentifier()
Gets the value(s) for identifier ().IdentifierDt
getIdentifierFirstRep()
Gets the first repetition for identifier (), creating it if it does not already exist.List<ClaimResponse.Item>
getItem()
Gets the value(s) for item ().ClaimResponse.Item
getItemFirstRep()
Gets the first repetition for item (), creating it if it does not already exist.List<ClaimResponse.Note>
getNote()
Gets the value(s) for note ().ClaimResponse.Note
getNoteFirstRep()
Gets the first repetition for note (), creating it if it does not already exist.ResourceReferenceDt
getOrganization()
Gets the value(s) for organization ().CodingDt
getOriginalRuleset()
Gets the value(s) for originalRuleset ().String
getOutcome()
Gets the value(s) for outcome ().ca.uhn.fhir.model.primitive.BoundCodeDt<RemittanceOutcomeEnum>
getOutcomeElement()
Gets the value(s) for outcome ().CodingDt
getPayeeType()
Gets the value(s) for payeeType ().MoneyDt
getPaymentAdjustment()
Gets the value(s) for paymentAdjustment ().CodingDt
getPaymentAdjustmentReason()
Gets the value(s) for paymentAdjustmentReason ().MoneyDt
getPaymentAmount()
Gets the value(s) for paymentAmount ().Date
getPaymentDate()
Gets the value(s) for paymentDate ().ca.uhn.fhir.model.primitive.DateDt
getPaymentDateElement()
Gets the value(s) for paymentDate ().IdentifierDt
getPaymentRef()
Gets the value(s) for paymentRef ().ResourceReferenceDt
getRequest()
Gets the value(s) for request ().ResourceReferenceDt
getRequestOrganization()
Gets the value(s) for requestOrganization ().ResourceReferenceDt
getRequestProvider()
Gets the value(s) for requestProvider ().CodingDt
getReserved()
Gets the value(s) for reserved ().String
getResourceName()
CodingDt
getRuleset()
Gets the value(s) for ruleset ().ca.uhn.fhir.context.FhirVersionEnum
getStructureFhirVersionEnum()
MoneyDt
getTotalBenefit()
Gets the value(s) for totalBenefit ().MoneyDt
getTotalCost()
Gets the value(s) for totalCost ().MoneyDt
getUnallocDeductable()
Gets the value(s) for unallocDeductable ().boolean
isEmpty()
ClaimResponse
setAddItem(List<ClaimResponse.AddItem> theValue)
Sets the value(s) for addItem ()ClaimResponse
setCoverage(List<ClaimResponse.Coverage> theValue)
Sets the value(s) for coverage ()ClaimResponse
setCreated(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
Sets the value(s) for created ()ClaimResponse
setCreated(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for created ()ClaimResponse
setCreatedWithSecondsPrecision(Date theDate)
Sets the value for created ()ClaimResponse
setDisposition(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for disposition ()ClaimResponse
setDisposition(String theString)
Sets the value for disposition ()ClaimResponse
setError(List<ClaimResponse.Error> theValue)
Sets the value(s) for error ()ClaimResponse
setForm(CodingDt theValue)
Sets the value(s) for form ()ClaimResponse
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier ()ClaimResponse
setItem(List<ClaimResponse.Item> theValue)
Sets the value(s) for item ()ClaimResponse
setNote(List<ClaimResponse.Note> theValue)
Sets the value(s) for note ()ClaimResponse
setOrganization(ResourceReferenceDt theValue)
Sets the value(s) for organization ()ClaimResponse
setOriginalRuleset(CodingDt theValue)
Sets the value(s) for originalRuleset ()ClaimResponse
setOutcome(RemittanceOutcomeEnum theValue)
Sets the value(s) for outcome ()ClaimResponse
setOutcome(ca.uhn.fhir.model.primitive.BoundCodeDt<RemittanceOutcomeEnum> theValue)
Sets the value(s) for outcome ()ClaimResponse
setPayeeType(CodingDt theValue)
Sets the value(s) for payeeType ()ClaimResponse
setPaymentAdjustment(MoneyDt theValue)
Sets the value(s) for paymentAdjustment ()ClaimResponse
setPaymentAdjustmentReason(CodingDt theValue)
Sets the value(s) for paymentAdjustmentReason ()ClaimResponse
setPaymentAmount(MoneyDt theValue)
Sets the value(s) for paymentAmount ()ClaimResponse
setPaymentDate(ca.uhn.fhir.model.primitive.DateDt theValue)
Sets the value(s) for paymentDate ()ClaimResponse
setPaymentDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for paymentDate ()ClaimResponse
setPaymentDateWithDayPrecision(Date theDate)
Sets the value for paymentDate ()ClaimResponse
setPaymentRef(IdentifierDt theValue)
Sets the value(s) for paymentRef ()ClaimResponse
setRequest(ResourceReferenceDt theValue)
Sets the value(s) for request ()ClaimResponse
setRequestOrganization(ResourceReferenceDt theValue)
Sets the value(s) for requestOrganization ()ClaimResponse
setRequestProvider(ResourceReferenceDt theValue)
Sets the value(s) for requestProvider ()ClaimResponse
setReserved(CodingDt theValue)
Sets the value(s) for reserved ()ClaimResponse
setRuleset(CodingDt theValue)
Sets the value(s) for ruleset ()ClaimResponse
setTotalBenefit(MoneyDt theValue)
Sets the value(s) for totalBenefit ()ClaimResponse
setTotalCost(MoneyDt theValue)
Sets the value(s) for totalCost ()ClaimResponse
setUnallocDeductable(MoneyDt theValue)
Sets the value(s) for unallocDeductable ()Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_IDENTIFIER
Search parameter constant for identifierDescription: The identity of the insurer
Type: token
Path: ClaimResponse.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identity of the insurer
Type: token
Path: ClaimResponse.identifier
-
-
Constructor Details
-
ClaimResponse
public ClaimResponse()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.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 interfaceca.uhn.fhir.model.api.ICompositeElement
-
getIdentifier
Gets the value(s) for identifier (). creating it if it does not exist. Will not returnnull
.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 benull
)
-
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 returnnull
.Definition: Original request resource referrence
-
setRequest
Sets the value(s) for request ()Definition: Original request resource referrence
-
getRuleset
Gets the value(s) for ruleset (). creating it if it does not exist. Will not returnnull
.Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
-
setRuleset
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 returnnull
.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
Gets the value(s) for created (). creating it if it does not exist. Will not returnnull
.Definition: The date when the enclosed suite of services were performed or completed
-
getCreated
Gets the value(s) for created (). creating it if it does not exist. This method may returnnull
.Definition: The date when the enclosed suite of services were performed or completed
-
setCreated
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 returnnull
.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 returnnull
.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 returnnull
.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
Gets the value(s) for outcome (). creating it if it does not exist. Will not returnnull
.Definition: Transaction status: error, complete
-
getOutcome
Gets the value(s) for outcome (). creating it if it does not exist. This method may returnnull
.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
Gets the value(s) for disposition (). creating it if it does not exist. Will not returnnull
.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 returnnull
.Definition: A description of the status of the adjudication.
-
setDisposition
Sets the value(s) for disposition ()Definition: A description of the status of the adjudication.
-
setDisposition
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 returnnull
.Definition: Party to be reimbursed: Subscriber, provider, other.
-
setPayeeType
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 returnnull
.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 benull
)
-
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 returnnull
.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 benull
)
-
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 returnnull
.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 benull
)
-
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 returnnull
.Definition: The total cost of the services reported.
-
setTotalCost
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 returnnull
.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 returnnull
.Definition: Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible)
-
setTotalBenefit
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 returnnull
.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 returnnull
.Definition: Reason for the payment adjustment.
-
setPaymentAdjustmentReason
Sets the value(s) for paymentAdjustmentReason ()Definition: Reason for the payment adjustment.
-
getPaymentDateElement
Gets the value(s) for paymentDate (). creating it if it does not exist. Will not returnnull
.Definition: Estimated payment data
-
getPaymentDate
Gets the value(s) for paymentDate (). creating it if it does not exist. This method may returnnull
.Definition: Estimated payment data
-
setPaymentDate
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 returnnull
.Definition: Payable less any payment adjustment.
-
setPaymentAmount
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 returnnull
.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 returnnull
.Definition: Status of funds reservation (For provider, for Patient, None).
-
setReserved
Sets the value(s) for reserved ()Definition: Status of funds reservation (For provider, for Patient, None).
-
getForm
Gets the value(s) for form (). creating it if it does not exist. Will not returnnull
.Definition: The form to be used for printing the content.
-
setForm
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 returnnull
.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 benull
)
-
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 returnnull
.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 benull
)
-
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 interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-