Skip to main content

Claim

Trial Use 2 Financial

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

Endpoints

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

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for claim
traceNumberIdentifier0..*Number for tracking
statuscode1..1active
typeCodeableConcept1..1Category or discipline
subTypeCodeableConcept0..1More granular claim type
usecode1..1claim
patientReference1..1The recipient of the products and services
billablePeriodPeriod0..1Relevant time frame for the claim
createddateTime1..1Resource creation date
entererReference0..1Author of the claim
insurerReference0..1Target
providerReference0..1Party responsible for the claim
priorityCodeableConcept0..1Desired processing urgency
fundsReserveCodeableConcept0..1For whom to reserve funds
relatedBackboneElement0..*Prior or corollary claims
prescriptionReference0..1Prescription authorizing services and products
originalPrescriptionReference0..1Original prescription if superseded by fulfiller
payeeBackboneElement0..1Recipient of benefits payable
referralReference0..1Treatment referral
encounterReference0..*Encounters associated with the listed treatments
facilityReference0..1Servicing facility
diagnosisRelatedGroupCodeableConcept0..1Package billing code
eventBackboneElement0..*Event information
careTeamBackboneElement0..*Members of the care team
supportingInfoBackboneElement0..*Supporting information
diagnosisBackboneElement0..*Pertinent diagnosis information
procedureBackboneElement0..*Clinical procedures performed
insuranceBackboneElement0..*Patient insurance information
accidentBackboneElement0..1Details of the event
patientPaidMoney0..1Paid by the patient
itemBackboneElement0..*Product or service provided
totalMoney0..1Total claim cost

Resource-specific search parameters

ParameterTypeDescription
care-teamreferenceMember of the CareTeam
createddateThe creation date for the Claim
detail-udireferenceUDI associated with a line item, detail product or service
encounterreferenceEncounter related to the activity recorded in the AuditEvent
entererreferenceThe party responsible for the entry of the Claim
facilityreferenceFacility where the products or services have been or will be provided
identifiertokenAccount number
insurerreferenceThe target payor/insurer for the Claim
item-udireferenceUDI associated with a line item product or service
patientreferenceThe entity that caused the expenses
payeereferenceThe party receiving any payment for the Claim
prioritytokenProcessing priority requested
procedure-udireferenceUDI associated with a procedure
providerreferenceProvider responsible for the Claim
statustokenThe status of the Claim instance.
subdetail-udireferenceUDI associated with a line item, detail, subdetail product or service
usetokenThe kind of financial resource

Reference

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