Skip to main content

Claim

ResourceFinancial · BillingTrial useMaturity 2

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.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
17 of 17 parameters tested

Structure​

ElementCard.TypeDescription
identifier
0..*IdentifierBusiness Identifier for claim
statusRequired?!Σ
1..1codeactive | cancelled | draft | entered-in-errorBinding (required): fm-status
typeRequiredΣ
1..1CodeableConceptCategory or disciplineBinding (extensible): claim-type
subType
0..1CodeableConceptMore granular claim typeBinding (example): claim-subtype
useRequiredΣ
1..1codeclaim | preauthorization | predeterminationBinding (required): claim-use
patientRequiredΣ
1..1Reference(Patient)The recipient of the products and services
billablePeriodΣ
0..1PeriodRelevant time frame for the claim
createdRequiredΣ
1..1dateTimeResource creation date
enterer
0..1Reference(Practitioner | PractitionerRole)Author of the claim
insurerΣ
0..1Reference(Organization)Target
providerRequiredΣ
1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the claim
priorityRequiredΣ
1..1CodeableConceptDesired processing ugencyBinding (example): process-priority
fundsReserve
0..1CodeableConceptFor whom to reserve fundsBinding (example): fundsreserve
related
0..*BackboneElementPrior or corollary claims
claim
0..1Reference(Claim)Reference to the related claim
relationship
0..1CodeableConceptHow the reference claim is relatedBinding (example): related-claim-relationship
reference
0..1IdentifierFile or case reference
prescription
0..1Reference(DeviceRequest | MedicationRequest | VisionPrescription)Prescription authorizing services and products
originalPrescription
0..1Reference(DeviceRequest | MedicationRequest | VisionPrescription)Original prescription if superseded by fulfiller
payee
0..1BackboneElementRecipient of benefits payable
typeRequired
1..1CodeableConceptCategory of recipientBinding (example): payeetype
party
0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson)Recipient reference
referral
0..1Reference(ServiceRequest)Treatment referral
facility
0..1Reference(Location)Servicing facility
careTeam
0..*BackboneElementMembers of the care team
sequenceRequired
1..1positiveIntOrder of care team
providerRequired
1..1Reference(Practitioner | PractitionerRole | Organization)Practitioner or organization
responsible
0..1booleanIndicator of the lead practitioner
role
0..1CodeableConceptFunction within the teamBinding (example): claim-careteamrole
qualification
0..1CodeableConceptPractitioner credential or specializationBinding (example): provider-qualification
supportingInfo
0..*BackboneElementSupporting information
sequenceRequired
1..1positiveIntInformation instance identifier
categoryRequired
1..1CodeableConceptClassification of the supplied informationBinding (example): claim-informationcategory
code
0..1CodeableConceptType of informationBinding (example): claim-exception
timing[x]
0..1date | PeriodWhen it occurred
value[x]
0..1boolean | string | Quantity | Attachment | Reference(Resource)Data to be provided
reason
0..1CodeableConceptExplanation for the informationBinding (example): missing-tooth-reason
diagnosis
0..*BackboneElementPertinent diagnosis information
sequenceRequired
1..1positiveIntDiagnosis instance identifier
diagnosis[x]Required
1..1CodeableConcept | Reference(Condition)Nature of illness or problemBinding (example): icd-10
type
0..*CodeableConceptTiming or nature of the diagnosisBinding (example): ex-diagnosistype
onAdmission
0..1CodeableConceptPresent on admissionBinding (example): ex-diagnosis-on-admission
packageCode
0..1CodeableConceptPackage billing codeBinding (example): ex-diagnosisrelatedgroup
procedure
0..*BackboneElementClinical procedures performed
sequenceRequired
1..1positiveIntProcedure instance identifier
type
0..*CodeableConceptCategory of ProcedureBinding (example): ex-procedure-type
date
0..1dateTimeWhen the procedure was performed
procedure[x]Required
1..1CodeableConcept | Reference(Procedure)Specific clinical procedureBinding (example): icd-10-procedures
udi
0..*Reference(Device)Unique device identifier
insuranceRequiredΣ
1..*BackboneElementPatient insurance information
sequenceRequiredΣ
1..1positiveIntInsurance instance identifier
focalRequiredΣ
1..1booleanCoverage to be used for adjudication
identifier
0..1IdentifierPre-assigned Claim number
coverageRequiredΣ
1..1Reference(Coverage)Insurance information
businessArrangement
0..1stringAdditional provider contract number
preAuthRef
0..*stringPrior authorization reference number
claimResponse
0..1Reference(ClaimResponse)Adjudication results
accident
0..1BackboneElementDetails of the event
dateRequired
1..1dateWhen the incident occurred
type
0..1CodeableConceptThe nature of the accidentBinding (extensible): v3-ActIncidentCode
location[x]
0..1Address | Reference(Location)Where the event occurred
item
0..*BackboneElementProduct or service provided
sequenceRequired
1..1positiveIntItem instance identifier
careTeamSequence
0..*positiveIntApplicable careTeam members
diagnosisSequence
0..*positiveIntApplicable diagnoses
procedureSequence
0..*positiveIntApplicable procedures
informationSequence
0..*positiveIntApplicable exception and supporting information
revenue
0..1CodeableConceptRevenue or cost center codeBinding (example): ex-revenue-center
category
0..1CodeableConceptBenefit classificationBinding (example): ex-benefitcategory
productOrServiceRequired
1..1CodeableConceptBilling, service, product, or drug codeBinding (example): service-uscls
modifier
0..*CodeableConceptProduct or service billing modifiersBinding (example): claim-modifiers
programCode
0..*CodeableConceptProgram the product or service is provided underBinding (example): ex-program-code
serviced[x]
0..1date | PeriodDate or dates of service or product delivery
location[x]
0..1CodeableConcept | Address | Reference(Location)Place of service or where product was suppliedBinding (example): service-place
quantity
0..1QuantityCount of products or services
unitPrice
0..1MoneyFee, charge or cost per item
factor
0..1decimalPrice scaling factor
net
0..1MoneyTotal item cost
udi
0..*Reference(Device)Unique device identifier
bodySite
0..1CodeableConceptAnatomical locationBinding (example): tooth
subSite
0..*CodeableConceptAnatomical sub-locationBinding (example): surface
encounter
0..*Reference(Encounter)Encounters related to this billed item
detail
0..*BackboneElementProduct or service provided
sequenceRequired
1..1positiveIntItem instance identifier
revenue
0..1CodeableConceptRevenue or cost center codeBinding (example): ex-revenue-center
category
0..1CodeableConceptBenefit classificationBinding (example): ex-benefitcategory
productOrServiceRequired
1..1CodeableConceptBilling, service, product, or drug codeBinding (example): service-uscls
modifier
0..*CodeableConceptService/Product billing modifiersBinding (example): claim-modifiers
programCode
0..*CodeableConceptProgram the product or service is provided underBinding (example): ex-program-code
quantity
0..1QuantityCount of products or services
unitPrice
0..1MoneyFee, charge or cost per item
factor
0..1decimalPrice scaling factor
net
0..1MoneyTotal item cost
udi
0..*Reference(Device)Unique device identifier
subDetail
0..*BackboneElementProduct or service provided
sequenceRequired
1..1positiveIntItem instance identifier
revenue
0..1CodeableConceptRevenue or cost center codeBinding (example): ex-revenue-center
category
0..1CodeableConceptBenefit classificationBinding (example): ex-benefitcategory
productOrServiceRequired
1..1CodeableConceptBilling, service, product, or drug codeBinding (example): service-uscls
modifier
0..*CodeableConceptService/Product billing modifiersBinding (example): claim-modifiers
programCode
0..*CodeableConceptProgram the product or service is provided underBinding (example): ex-program-code
quantity
0..1QuantityCount of products or services
unitPrice
0..1MoneyFee, charge or cost per item
factor
0..1decimalPrice scaling factor
net
0..1MoneyTotal item cost
udi
0..*Reference(Device)Unique device identifier
total
0..1MoneyTotal claim cost

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/Claim?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
care-teamreference

Member of the CareTeam

Claim.careTeam.provider
createddate

The creation date for the Claim

Claim.created
detail-udireference

UDI associated with a line item, detail product or service

Claim.item.detail.udi
encounterreference

Encounters associated with a billed line item

Claim.item.encounter
entererreference

The party responsible for the entry of the Claim

Claim.enterer
facilityreference

Facility where the products or services have been or will be provided

Claim.facility
identifiertoken

The primary identifier of the financial resource

Claim.identifier
insurerreference

The target payor/insurer for the Claim

Claim.insurer
item-udireference

UDI associated with a line item product or service

Claim.item.udi
patientreference

Patient receiving the products or services

Claim.patient
payeereference

The party receiving any payment for the Claim

Claim.payee.party
prioritytoken

Processing priority requested

Claim.priority
procedure-udireference

UDI associated with a procedure

Claim.procedure.udi
providerreference

Provider responsible for the Claim

Claim.provider
statustoken

The status of the Claim instance.

Claim.status
subdetail-udireference

UDI associated with a line item, detail, subdetail product or service

Claim.item.detail.subDetail.udi
usetoken

The kind of financial resource

Claim.use

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition