Skip to main content

ClaimResponse

Trial Use 2 Financial

This resource provides the adjudication details from the processing of a Claim resource.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/ClaimResponse
InteractionMethodPath
ReadGET/fhir/R5/ClaimResponse/[id]
VreadGET/fhir/R5/ClaimResponse/[id]/_history/[vid]
UpdatePUT/fhir/R5/ClaimResponse/[id]
PatchPATCH/fhir/R5/ClaimResponse/[id]
DeleteDELETE/fhir/R5/ClaimResponse/[id]
CreatePOST/fhir/R5/ClaimResponse
SearchGET/fhir/R5/ClaimResponse?...
HistoryGET/fhir/R5/ClaimResponse/[id]/_history
Type-historyGET/fhir/R5/ClaimResponse/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for a claim response
traceNumberIdentifier0..*Number for tracking
statuscode1..1active
typeCodeableConcept1..1More granular claim type
subTypeCodeableConcept0..1More granular claim type
usecode1..1claim
patientReference1..1The recipient of the products and services
createddateTime1..1Response creation date
insurerReference0..1Party responsible for reimbursement
requestorReference0..1Party responsible for the claim
requestReference0..1Id of resource triggering adjudication
outcomecode1..1queued
decisionCodeableConcept0..1Result of the adjudication
dispositionstring0..1Disposition Message
preAuthRefstring0..1Preauthorization reference
preAuthPeriodPeriod0..1Preauthorization reference effective period
eventBackboneElement0..*Event information
payeeTypeCodeableConcept0..1Party to be paid any benefits payable
encounterReference0..*Encounters associated with the listed treatments
diagnosisRelatedGroupCodeableConcept0..1Package billing code
itemBackboneElement0..*Adjudication for claim line items
addItemBackboneElement0..*Insurer added line items
adjudication0..*Header-level adjudication
totalBackboneElement0..*Adjudication totals
paymentBackboneElement0..1Payment Details
fundsReserveCodeableConcept0..1Funds reserved status
formCodeCodeableConcept0..1Printed form identifier
formAttachment0..1Printed reference or actual form
processNoteBackboneElement0..*Note concerning adjudication
communicationRequestReference0..*Request for additional information
insuranceBackboneElement0..*Patient insurance information
errorBackboneElement0..*Processing errors

Resource-specific search parameters

ParameterTypeDescription
createddateThe creation date
dispositionstringThe contents of the disposition message
identifiertokenAccount number
insurerreferenceThe organization which generated this resource
outcometokenThe processing outcome
patientreferenceThe entity that caused the expenses
payment-datedateThe expected payment date
requestreferenceThe claim reference
requestorreferenceThe Provider of the claim
statustokenThe status of the ClaimResponse
usetokenThe type of claim

Reference

  • Official FHIR R5 spec: ClaimResponse
  • Maturity: Trial Use 2 (FMM 2).