This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Detailed Descriptions for the elements in the Claim resource.
Claim | |
Definition | A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery. |
Control | 1..1 |
Claim.identifier | |
Definition | The business identifier for the instance: claim number, pre-determination or pre-authorization number. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Claim.status | |
Definition | The status of the resource instance. |
Control | 0..1 |
Terminology Binding | Financial Resource Status Codes (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Claim.type | |
Definition | The category of claim, eg, oral, pharmacy, vision, insitutional, professional. |
Control | 0..1 |
Terminology Binding | Example Claim Type Codes (Required) |
Type | CodeableConcept |
Comments | Affects which fields and value sets are used. |
Claim.subType | |
Definition | A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType. |
Control | 0..* |
Terminology Binding | Example Claim SubType Codes (Example) |
Type | CodeableConcept |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Claim.use | |
Definition | Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination). |
Control | 0..1 |
Terminology Binding | Use (Required) |
Type | code |
Claim.patient | |
Definition | Patient Resource. |
Control | 0..1 |
Type | Reference(Patient) |
Claim.billablePeriod | |
Definition | The billable period for which charges are being submitted. |
Control | 0..1 |
Type | Period |
Claim.created | |
Definition | The date when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | dateTime |
Claim.enterer | |
Definition | Person who created the invoice/claim/pre-determination or pre-authorization. |
Control | 0..1 |
Type | Reference(Practitioner) |
Claim.insurer | |
Definition | The Insurer who is target of the request. |
Control | 0..1 |
Type | Reference(Organization) |
Claim.provider | |
Definition | The provider which is responsible for the bill, claim pre-determination, pre-authorization. |
Control | 0..1 |
Type | Reference(Practitioner) |
Claim.organization | |
Definition | The organization which is responsible for the bill, claim pre-determination, pre-authorization. |
Control | 0..1 |
Type | Reference(Organization) |
Claim.priority | |
Definition | Immediate (STAT), best effort (NORMAL), deferred (DEFER). |
Control | 0..1 |
Terminology Binding | Priority Codes (Example) |
Type | CodeableConcept |
Claim.fundsReserve | |
Definition | In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested. |
Control | 0..1 |
Terminology Binding | Funds Reservation Codes (Example) |
Type | CodeableConcept |
Claim.related | |
Definition | Other claims which are related to this claim such as prior claim versions or for related services. |
Control | 0..* |
Claim.related.claim | |
Definition | Other claims which are related to this claim such as prior claim versions or for related services. |
Control | 0..1 |
Type | Reference(Claim) |
Comments | Do we need a relationship code? |
Claim.related.relationship | |
Definition | For example prior or umbrella. |
Control | 0..1 |
Terminology Binding | Example Related Claim Relationship Codes (Example) |
Type | CodeableConcept |
Claim.related.reference | |
Definition | An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # . |
Control | 0..1 |
Type | Identifier |
Claim.prescription | |
Definition | Prescription to support the dispensing of Pharmacy or Vision products. |
Control | 0..1 |
Type | Reference(MedicationRequest | VisionPrescription) |
Requirements | For type=Pharmacy and Vision only. |
Comments | Should we create a group to hold multiple prescriptions and add a sequence number and on the line items a link to the sequence. |
Claim.originalPrescription | |
Definition | Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. |
Control | 0..1 |
Type | Reference(MedicationRequest) |
Comments | as above. |
Claim.payee | |
Definition | The party to be reimbursed for the services. |
Control | 0..1 |
Claim.payee.type | |
Definition | Type of Party to be reimbursed: Subscriber, provider, other. |
Control | 1..1 |
Terminology Binding | Payee Type Codes (Example) |
Type | CodeableConcept |
Claim.payee.resourceType | |
Definition | organization | patient | practitioner | relatedperson. |
Control | 0..1 |
Terminology Binding | PayeeResourceType (Example) |
Type | Coding |
Claim.payee.party | |
Definition | Party to be reimbursed: Subscriber, provider, other. |
Control | 0..1 |
Type | Reference(Practitioner | Organization | Patient | RelatedPerson) |
Claim.referral | |
Definition | The referral resource which lists the date, practitioner, reason and other supporting information. |
Control | 0..1 |
Type | Reference(ReferralRequest) |
Claim.facility | |
Definition | Facility where the services were provided. |
Control | 0..1 |
Type | Reference(Location) |
Claim.careTeam | |
Definition | The members of the team who provided the overall service as well as their role and whether responsible and qualifications. |
Control | 0..* |
Requirements | Role and Responsible may not be required when there is only a single provider listed. |
Claim.careTeam.sequence | |
Definition | Sequence of the careTeam which serves to order and provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to maintain order of the careTeam. |
Claim.careTeam.provider | |
Definition | Member of the team who provided the overall service. |
Control | 1..1 |
Type | Reference(Practitioner | Organization) |
Claim.careTeam.responsible | |
Definition | The party who is billing and responsible for the claimed good or service rendered to the patient. |
Control | 0..1 |
Type | boolean |
Claim.careTeam.role | |
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team. |
Control | 0..1 |
Terminology Binding | Claim Care Team Role Codes (Example) |
Type | CodeableConcept |
Claim.careTeam.qualification | |
Definition | The qualification which is applicable for this service. |
Control | 0..1 |
Terminology Binding | Example Provider Qualification Codes (Example) |
Type | CodeableConcept |
Claim.information | |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required. |
Control | 0..* |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Claim.information.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Terminology Binding | Claim Information Category Codes (Example) |
Type | CodeableConcept |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Claim.information.code | |
Definition | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication. |
Control | 0..1 |
Terminology Binding | Exception Codes (Example) |
Type | CodeableConcept |
Comments | This may contain the local bill type codes such as the US UB-04 bill type code. |
Claim.information.timing[x] | |
Definition | The date when or period to which this information refers. |
Control | 0..1 |
Type | date|Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Claim.information.value[x] | |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Control | 0..1 |
Type | string|Quantity|Attachment|Reference(Any) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Claim.information.reason | |
Definition | For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content. |
Control | 0..1 |
Terminology Binding | Missing Tooth Reason Codes (Example) |
Type | CodeableConcept |
Claim.diagnosis | |
Definition | Ordered list of patient diagnosis for which care is sought. |
Control | 0..* |
Claim.diagnosis.sequence | |
Definition | Sequence of diagnosis which serves to order and provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to maintain order of the diagnoses. |
Claim.diagnosis.diagnosis[x] | |
Definition | The diagnosis. |
Control | 1..1 |
Terminology Binding | ICD-10 Codes (Example) |
Type | CodeableConcept|Reference(Condition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Required to adjudicate services rendered to condition presented. |
Claim.diagnosis.type | |
Definition | The type of the Diagnosis, for example: admitting,. |
Control | 0..* |
Terminology Binding | Example Diagnosis Type Codes (Example) |
Type | CodeableConcept |
Requirements | Required to adjudicate services rendered to the mandated diagnosis grouping system. |
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. |
Claim.diagnosis.packageCode | |
Definition | The package billing code, for example DRG, based on the assigned grouping code system. |
Control | 0..1 |
Terminology Binding | Example Diagnosis Related Group Codes (Example) |
Type | CodeableConcept |
Requirements | Required to adjudicate services rendered to the mandated grouping system. |
Claim.procedure | |
Definition | Ordered list of patient procedures performed to support the adjudication. |
Control | 0..* |
Claim.procedure.sequence | |
Definition | Sequence of procedures which serves to order and provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to maintain order of the procudures. |
Claim.procedure.date | |
Definition | Date and optionally time the procedure was performed . |
Control | 0..1 |
Type | dateTime |
Requirements | Required to adjudicate services rendered. |
Comments | SB DateTime?? |
Claim.procedure.procedure[x] | |
Definition | The procedure code. |
Control | 1..1 |
Terminology Binding | ICD-10 Procedure Codes (Example) |
Type | CodeableConcept|Reference(Procedure) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Required to adjudicate services rendered. |
Claim.insurance | |
Definition | Financial instrument by which payment information for health care. |
Control | 0..* |
Requirements | Health care programs and insurers are significant payors of health service costs. |
Claim.insurance.sequence | |
Definition | A service line item. |
Control | 1..1 |
Type | positiveInt |
Requirements | To maintain order of the coverages. |
Claim.insurance.focal | |
Definition | A flag to indicate that this Coverage is the focus for adjudication. The Coverage against which the claim is to be adjudicated. |
Control | 1..1 |
Type | boolean |
Requirements | To identify which coverage is being adjudicated. |
Claim.insurance.coverage | |
Definition | Reference to the program or plan identification, underwriter or payor. |
Control | 1..1 |
Type | Reference(Coverage) |
Requirements | Need to identify the issuer to target for processing and for coordination of benefit processing. |
Claim.insurance.businessArrangement | |
Definition | The contract number of a business agreement which describes the terms and conditions. |
Control | 0..1 |
Type | string |
Claim.insurance.preAuthRef | |
Definition | A list of references from the Insurer to which these services pertain. |
Control | 0..* |
Type | string |
Requirements | To provide any pre=determination or prior authorization reference. |
Claim.insurance.claimResponse | |
Definition | The Coverages adjudication details. |
Control | 0..1 |
Type | Reference(ClaimResponse) |
Requirements | Used by downstream payers to determine what balance remains and the net payable. |
Claim.accident | |
Definition | An accident which resulted in the need for healthcare services. |
Control | 0..1 |
Claim.accident.date | |
Definition | Date of an accident which these services are addressing. |
Control | 1..1 |
Type | date |
Requirements | Coverage may be dependant on accidents. |
Claim.accident.type | |
Definition | Type of accident: work, auto, etc. |
Control | 0..1 |
Terminology Binding | ActIncidentCode (Required) |
Type | CodeableConcept |
Requirements | Coverage may be dependant on the type of accident. |
Claim.accident.location[x] | |
Definition | Accident Place. |
Control | 0..1 |
Type | Address|Reference(Location) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Claim.employmentImpacted | |
Definition | The start and optional end dates of when the patient was precluded from working due to the treatable condition(s). |
Control | 0..1 |
Type | Period |
Claim.hospitalization | |
Definition | The start and optional end dates of when the patient was confined to a treatment center. |
Control | 0..1 |
Type | Period |
Claim.item | |
Definition | First tier of goods and services. |
Control | 0..* |
Claim.item.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
Claim.item.careTeamLinkId | |
Definition | CareTeam applicable for this service or product line. |
Control | 0..* |
Type | positiveInt |
Claim.item.diagnosisLinkId | |
Definition | Diagnosis applicable for this service or product line. |
Control | 0..* |
Type | positiveInt |
Claim.item.procedureLinkId | |
Definition | Procedures applicable for this service or product line. |
Control | 0..* |
Type | positiveInt |
Claim.item.informationLinkId | |
Definition | Exceptions, special conditions and supporting information pplicable for this service or product line. |
Control | 0..* |
Type | positiveInt |
Claim.item.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Terminology Binding | Example Revenue Center Codes (Example) |
Type | CodeableConcept |
Claim.item.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Terminology Binding | Benefit SubCategory Codes (Example) |
Type | CodeableConcept |
Claim.item.service | |
Definition | If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. |
Control | 0..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
Claim.item.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Claim.item.programCode | |
Definition | For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program. |
Control | 0..* |
Terminology Binding | Example Program Reason Codes (Example) |
Type | CodeableConcept |
Claim.item.serviced[x] | |
Definition | The date or dates when the enclosed suite of services were performed or completed. |
Control | 0..1 |
Type | date|Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Claim.item.location[x] | |
Definition | Where the service was provided. |
Control | 0..1 |
Terminology Binding | Example Service Place Codes (Example) |
Type | CodeableConcept|Address|Reference(Location) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Claim.item.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | SimpleQuantity |
Claim.item.unitPrice | |
Definition | If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group. |
Control | 0..1 |
Type | Money |
Claim.item.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.net | |
Definition | The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..* |
Type | Reference(Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Claim.item.bodySite | |
Definition | Physical service site on the patient (limb, tooth, etc). |
Control | 0..1 |
Terminology Binding | Oral Site Codes (Example) |
Type | CodeableConcept |
Claim.item.subSite | |
Definition | A region or surface of the site, eg. limb region or tooth surface(s). |
Control | 0..* |
Terminology Binding | Surface Codes (Example) |
Type | CodeableConcept |
Claim.item.detail | |
Definition | Second tier of goods and services. |
Control | 0..* |
Claim.item.detail.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
Claim.item.detail.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Terminology Binding | Example Revenue Center Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Terminology Binding | Benefit SubCategory Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.service | |
Definition | If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. |
Control | 0..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Claim.item.detail.programCode | |
Definition | For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. |
Control | 0..* |
Terminology Binding | Example Program Reason Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | SimpleQuantity |
Claim.item.detail.unitPrice | |
Definition | If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.detail.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.detail.net | |
Definition | The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.detail.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..* |
Type | Reference(Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Claim.item.detail.subDetail | |
Definition | Third tier of goods and services. |
Control | 0..* |
Claim.item.detail.subDetail.sequence | |
Definition | A service line number. |
Control | 1..1 |
Type | positiveInt |
Claim.item.detail.subDetail.revenue | |
Definition | The type of reveneu or cost center providing the product and/or service. |
Control | 0..1 |
Terminology Binding | Example Revenue Center Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.subDetail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Terminology Binding | Benefit SubCategory Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.subDetail.service | |
Definition | A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). |
Control | 0..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.subDetail.modifier | |
Definition | Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. |
Control | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Claim.item.detail.subDetail.programCode | |
Definition | For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. |
Control | 0..* |
Terminology Binding | Example Program Reason Codes (Example) |
Type | CodeableConcept |
Claim.item.detail.subDetail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | SimpleQuantity |
Claim.item.detail.subDetail.unitPrice | |
Definition | The fee for an addittional service or product or charge. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.detail.subDetail.factor | |
Definition | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. |
Control | 0..1 |
Type | decimal |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.detail.subDetail.net | |
Definition | The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied. |
Control | 0..1 |
Type | Money |
Requirements | If a fee is present the associated product/service code must be present. |
Claim.item.detail.subDetail.udi | |
Definition | List of Unique Device Identifiers associated with this line item. |
Control | 0..* |
Type | Reference(Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Claim.item.prosthesis | |
Definition | The materials and placement date of prior fixed prosthesis. |
Control | 0..1 |
Claim.item.prosthesis.initial | |
Definition | Indicates whether this is the initial placement of a fixed prosthesis. |
Control | 0..1 |
Type | boolean |
Requirements | May impact on adjudication. |
Claim.item.prosthesis.priorDate | |
Definition | Date of the initial placement. |
Control | 0..1 |
Type | date |
Requirements | May impact on adjudication. |
Claim.item.prosthesis.priorMaterial | |
Definition | Material of the prior denture or bridge prosthesis. (Oral). |
Control | 0..1 |
Terminology Binding | Oral Prostho Material type Codes (Example) |
Type | CodeableConcept |
Requirements | May impact on adjudication. |
Claim.total | |
Definition | The total value of the claim. |
Control | 0..1 |
Type | Money |