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​

alphahttps://api.dev.ovok.com/fhir/R4/Claim
InteractionMethodPath
ReadGET/fhir/R4/Claim/[id]
VreadGET/fhir/R4/Claim/[id]/_history/[vid]
UpdatePUT/fhir/R4/Claim/[id]
PatchPATCH/fhir/R4/Claim/[id]
DeleteDELETE/fhir/R4/Claim/[id]
CreatePOST/fhir/R4/Claim
SearchGET/fhir/R4/Claim
HistoryGET/fhir/R4/Claim/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for claim
statuscode1..1active | cancelled | draft | entered-in-error modifier
typeCodeableConcept1..1Category or discipline
subTypeCodeableConcept0..1More granular claim type
usecode1..1claim | preauthorization | predetermination
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
providerReference1..1Party responsible for the claim
priorityCodeableConcept1..1Desired processing ugency
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
facilityReference0..1Servicing facility
careTeamBackboneElement0..*Members of the care team
supportingInfoBackboneElement0..*Supporting information
diagnosisBackboneElement0..*Pertinent diagnosis information
procedureBackboneElement0..*Clinical procedures performed
insuranceBackboneElement1..*Patient insurance information
accidentBackboneElement0..1Details of the event
itemBackboneElement0..*Product or service provided
totalMoney0..1Total claim cost

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
care-teamstringhttp://hl7.org/fhir/SearchParameter/Claim-care-team
createdstringhttp://hl7.org/fhir/SearchParameter/Claim-created
detail-udistringhttp://hl7.org/fhir/SearchParameter/Claim-detail-udi
encounterstringhttp://hl7.org/fhir/SearchParameter/Claim-encounter
entererstringhttp://hl7.org/fhir/SearchParameter/Claim-enterer
facilitystringhttp://hl7.org/fhir/SearchParameter/Claim-facility
identifierstringhttp://hl7.org/fhir/SearchParameter/Claim-identifier
insurerstringhttp://hl7.org/fhir/SearchParameter/Claim-insurer
item-udistringhttp://hl7.org/fhir/SearchParameter/Claim-item-udi
patientstringhttp://hl7.org/fhir/SearchParameter/Claim-patient
payeestringhttp://hl7.org/fhir/SearchParameter/Claim-payee
prioritystringhttp://hl7.org/fhir/SearchParameter/Claim-priority
procedure-udistringhttp://hl7.org/fhir/SearchParameter/Claim-procedure-udi
providerstringhttp://hl7.org/fhir/SearchParameter/Claim-provider
statusstringhttp://hl7.org/fhir/SearchParameter/Claim-status
subdetail-udistringhttp://hl7.org/fhir/SearchParameter/Claim-subdetail-udi
usestringhttp://hl7.org/fhir/SearchParameter/Claim-use

Reference​

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