This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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
Financial Management Work Group | Maturity Level: 2 | Trial Use | Security Category: Patient | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the Claim resource.
Claim | |
Element Id | Claim |
Definition | 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. |
Cardinality | 0..* |
Type | DomainResource |
Requirements | The Claim resource is used by providers to exchange services and products rendered to patients or planned to be rendered with insurers for reimbuserment. It is also used by insurers to exchange claims information with statutory reporting and data analytics firms. |
Alternate Names | Adjudication Request; Preauthorization Request; Predetermination Request |
Comments | The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services. |
Claim.identifier | |
Element Id | Claim.identifier |
Definition | A unique identifier assigned to this claim. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Allows claims to be distinguished and referenced. |
Alternate Names | Claim Number |
Claim.status | |
Element Id | Claim.status |
Definition | The status of the resource instance. |
Cardinality | 1..1 |
Terminology Binding | Financial Resource Status Codes (Required) |
Type | code |
Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. |
Summary | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Claim.type | |
Element Id | Claim.type |
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
Cardinality | 1..1 |
Terminology Binding | Claim Type Codes (Extensible) |
Type | CodeableConcept |
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication. |
Summary | true |
Comments | The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements. |
Claim.subType | |
Element Id | Claim.subType |
Definition | A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
Cardinality | 0..1 |
Terminology Binding | Example Claim SubType Codes (Example) |
Type | CodeableConcept |
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. |
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. |
Claim.use | |
Element Id | Claim.use |
Definition | A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. |
Cardinality | 1..1 |
Terminology Binding | Use (Required) |
Type | code |
Requirements | This element is required to understand the nature of the request for adjudication. |
Summary | true |
Claim.patient | |
Element Id | Claim.patient |
Definition | The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought. |
Cardinality | 1..1 |
Type | Reference(Patient) |
Requirements | The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction. |
Summary | true |
Claim.billablePeriod | |
Element Id | Claim.billablePeriod |
Definition | The period for which charges are being submitted. |
Cardinality | 0..1 |
Type | Period |
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care. |
Summary | true |
Comments | Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified. |
Claim.created | |
Element Id | Claim.created |
Definition | The date this resource was created. |
Cardinality | 1..1 |
Type | dateTime |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Summary | true |
Comments | This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date. |
Claim.enterer | |
Element Id | Claim.enterer |
Definition | Individual who created the claim, predetermination or preauthorization. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole) |
Patterns | Reference(Practitioner,PractitionerRole): Common patterns = Participant |
Requirements | Some jurisdictions require the contact information for personnel completing claims. |
Claim.insurer | |
Element Id | Claim.insurer |
Definition | The Insurer who is target of the request. |
Cardinality | 0..1 |
Type | Reference(Organization) |
Summary | true |
Claim.provider | |
Element Id | Claim.provider |
Definition | The provider which is responsible for the claim, predetermination or preauthorization. |
Cardinality | 1..1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant |
Summary | true |
Comments | Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below. |
Claim.priority | |
Element Id | Claim.priority |
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
Cardinality | 1..1 |
Terminology Binding | Process Priority Codes (Example) |
Type | CodeableConcept |
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply. |
Summary | true |
Comments | If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request. |
Claim.fundsReserve | |
Element Id | Claim.fundsReserve |
Definition | A code to indicate whether and for whom funds are to be reserved for future claims. |
Cardinality | 0..1 |
Terminology Binding | FundsReserve (Example) |
Type | CodeableConcept |
Requirements | 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. |
Alternate Names | Fund pre-allocation |
Comments | This field is only used for preauthorizations. |
Claim.related | |
Element Id | Claim.related |
Definition | Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. |
Cardinality | 0..* |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Comments | For example, for the original treatment and follow-up exams. |
Claim.related.claim | |
Element Id | Claim.related.claim |
Definition | Reference to a related claim. |
Cardinality | 0..1 |
Type | Reference(Claim) |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Claim.related.relationship | |
Element Id | Claim.related.relationship |
Definition | A code to convey how the claims are related. |
Cardinality | 0..1 |
Terminology Binding | Example Related Claim Relationship Codes (Example) |
Type | CodeableConcept |
Requirements | Some insurers need a declaration of the type of relationship. |
Comments | For example, prior claim or umbrella. |
Claim.related.reference | |
Element Id | Claim.related.reference |
Definition | An alternate organizational reference to the case or file to which this particular claim pertains. |
Cardinality | 0..1 |
Type | Identifier |
Requirements | In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges. |
Comments | For example, Property/Casualty insurer claim # or Workers Compensation case # . |
Claim.prescription | |
Element Id | Claim.prescription |
Definition | Prescription to support the dispensing of pharmacy, device or vision products. |
Cardinality | 0..1 |
Type | Reference(DeviceRequest | MedicationRequest | VisionPrescription) |
Patterns | Reference(DeviceRequest,MedicationRequest,VisionPrescription): Common patterns = Request |
Requirements | Required to authorize the dispensing of controlled substances and devices. |
Claim.originalPrescription | |
Element Id | Claim.originalPrescription |
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
Cardinality | 0..1 |
Type | Reference(DeviceRequest | MedicationRequest | VisionPrescription) |
Patterns | Reference(DeviceRequest,MedicationRequest,VisionPrescription): Common patterns = Request |
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription. |
Comments | For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. |
Claim.payee | |
Element Id | Claim.payee |
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy. |
Cardinality | 0..1 |
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse. |
Comments | Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead. |
Claim.payee.type | |
Element Id | Claim.payee.type |
Definition | Type of Party to be reimbursed: subscriber, provider, other. |
Cardinality | 1..1 |
Terminology Binding | PayeeType (Example) |
Type | CodeableConcept |
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. |
Claim.payee.party | |
Element Id | Claim.payee.party |
Definition | Reference to the individual or organization to whom any payment will be made. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) |
Patterns | Reference(Practitioner,PractitionerRole,Organization,Patient,RelatedPerson): Common patterns = Participant |
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'. |
Comments | Not required if the payee is 'subscriber' or 'provider'. |
Claim.referral | |
Element Id | Claim.referral |
Definition | A reference to a referral resource. |
Cardinality | 0..1 |
Type | Reference(ServiceRequest) |
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services. |
Comments | The referral resource which lists the date, practitioner, reason and other supporting information. |
Claim.facility | |
Element Id | Claim.facility |
Definition | Facility where the services were provided. |
Cardinality | 0..1 |
Type | Reference(Location) |
Requirements | Insurance adjudication can be dependant on where services were delivered. |
Claim.careTeam | |
Element Id | Claim.careTeam |
Definition | The members of the team who provided the products and services. |
Cardinality | 0..* |
Requirements | Common to identify the responsible and supporting practitioners. |
Claim.careTeam.sequence | |
Element Id | Claim.careTeam.sequence |
Definition | A number to uniquely identify care team entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details. |
Claim.careTeam.provider | |
Element Id | Claim.careTeam.provider |
Definition | Member of the team who provided the product or service. |
Cardinality | 1..1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant |
Requirements | Often a regulatory requirement to specify the responsible provider. |
Claim.careTeam.responsible | |
Element Id | Claim.careTeam.responsible |
Definition | The party who is billing and/or responsible for the claimed products or services. |
Cardinality | 0..1 |
Type | boolean |
Requirements | When multiple parties are present it is required to distinguish the lead or responsible individual. |
Comments | Responsible might not be required when there is only a single provider listed. |
Claim.careTeam.role | |
Element Id | Claim.careTeam.role |
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
Cardinality | 0..1 |
Terminology Binding | Claim Care Team Role Codes (Example) |
Type | CodeableConcept |
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member. |
Comments | Role might not be required when there is only a single provider listed. |
Claim.careTeam.qualification | |
Element Id | Claim.careTeam.qualification |
Definition | The qualification of the practitioner which is applicable for this service. |
Cardinality | 0..1 |
Terminology Binding | Example Provider Qualification Codes (Example) |
Type | CodeableConcept |
Requirements | Need to specify which qualification a provider is delivering the product or service under. |
Claim.supportingInfo | |
Element Id | Claim.supportingInfo |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Cardinality | 0..* |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Alternate Names | Attachments Exception Codes Occurrence Codes Value codes |
Comments | Often there are multiple jurisdiction specific valuesets which are required. |
Claim.supportingInfo.sequence | |
Element Id | Claim.supportingInfo.sequence |
Definition | A number to uniquely identify supporting information entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Claim.supportingInfo.category | |
Element Id | Claim.supportingInfo.category |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Cardinality | 1..1 |
Terminology Binding | Claim Information Category Codes (Example) |
Type | CodeableConcept |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Comments | This may contain a category for the local bill type codes. |
Claim.supportingInfo.code | |
Element Id | Claim.supportingInfo.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. |
Cardinality | 0..1 |
Terminology Binding | Exception Codes (Example) |
Type | CodeableConcept |
Requirements | Required to identify the kind of additional information. |
Claim.supportingInfo.timing[x] | |
Element Id | Claim.supportingInfo.timing[x] |
Definition | The date when or period to which this information refers. |
Cardinality | 0..1 |
Type | date|Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Claim.supportingInfo.value[x] | |
Element Id | Claim.supportingInfo.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. |
Cardinality | 0..1 |
Type | boolean|string|Quantity|Attachment|Reference(Any) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Comments | Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident. |
Claim.supportingInfo.reason | |
Element Id | Claim.supportingInfo.reason |
Definition | Provides the reason in the situation where a reason code is required in addition to the content. |
Cardinality | 0..1 |
Terminology Binding | Missing Tooth Reason Codes (Example) |
Type | CodeableConcept |
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. |
Comments | For example: the reason for the additional stay, or why a tooth is missing. |
Claim.diagnosis | |
Element Id | Claim.diagnosis |
Definition | Information about diagnoses relevant to the claim items. |
Cardinality | 0..* |
Requirements | Required for the adjudication by provided context for the services and product listed. |
Claim.diagnosis.sequence | |
Element Id | Claim.diagnosis.sequence |
Definition | A number to uniquely identify diagnosis entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details. |
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. |
Claim.diagnosis.diagnosis[x] | |
Element Id | Claim.diagnosis.diagnosis[x] |
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
Cardinality | 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 | Provides health context for the evaluation of the products and/or services. |
Claim.diagnosis.type | |
Element Id | Claim.diagnosis.type |
Definition | When the condition was observed or the relative ranking. |
Cardinality | 0..* |
Terminology Binding | Example Diagnosis Type Codes (Example) |
Type | CodeableConcept |
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. |
Comments | For example: admitting, primary, secondary, discharge. |
Claim.diagnosis.onAdmission | |
Element Id | Claim.diagnosis.onAdmission |
Definition | Indication of whether the diagnosis was present on admission to a facility. |
Cardinality | 0..1 |
Terminology Binding | Example Diagnosis on Admission Codes (Example) |
Type | CodeableConcept |
Requirements | Many systems need to understand for adjudication if the diagnosis was present a time of admission. |
Claim.diagnosis.packageCode | |
Element Id | Claim.diagnosis.packageCode |
Definition | A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system. |
Cardinality | 0..1 |
Terminology Binding | Example Diagnosis Related Group Codes (Example) |
Type | CodeableConcept |
Requirements | Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code. |
Comments | For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event. |
Claim.procedure | |
Element Id | Claim.procedure |
Definition | Procedures performed on the patient relevant to the billing items with the claim. |
Cardinality | 0..* |
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service. |
Claim.procedure.sequence | |
Element Id | Claim.procedure.sequence |
Definition | A number to uniquely identify procedure entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to claim details. |
Claim.procedure.type | |
Element Id | Claim.procedure.type |
Definition | When the condition was observed or the relative ranking. |
Cardinality | 0..* |
Terminology Binding | Example Procedure Type Codes (Example) |
Type | CodeableConcept |
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. |
Comments | For example: primary, secondary. |
Claim.procedure.date | |
Element Id | Claim.procedure.date |
Definition | Date and optionally time the procedure was performed. |
Cardinality | 0..1 |
Type | dateTime |
Requirements | Required for auditing purposes. |
Claim.procedure.procedure[x] | |
Element Id | Claim.procedure.procedure[x] |
Definition | The code or reference to a Procedure resource which identifies the clinical intervention performed. |
Cardinality | 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 | This identifies the actual clinical procedure. |
Claim.procedure.udi | |
Element Id | Claim.procedure.udi |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0..* |
Type | Reference(Device) |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Claim.insurance | |
Element Id | Claim.insurance |
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. |
Cardinality | 1..* |
Requirements | At least one insurer is required for a claim to be a claim. |
Summary | true |
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim. |
Claim.insurance.sequence | |
Element Id | Claim.insurance.sequence |
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | To maintain order of the coverages. |
Summary | true |
Claim.insurance.focal | |
Element Id | Claim.insurance.focal |
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
Cardinality | 1..1 |
Type | boolean |
Requirements | To identify which coverage in the list is being used to adjudicate this claim. |
Summary | true |
Comments | A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies. |
Claim.insurance.identifier | |
Element Id | Claim.insurance.identifier |
Definition | The business identifier to be used when the claim is sent for adjudication against this insurance policy. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..1 |
Type | Identifier |
Requirements | This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication. |
Comments | Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'. |
Claim.insurance.coverage | |
Element Id | Claim.insurance.coverage |
Definition | Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
Cardinality | 1..1 |
Type | Reference(Coverage) |
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. |
Summary | true |
Claim.insurance.businessArrangement | |
Element Id | Claim.insurance.businessArrangement |
Definition | A business agreement number established between the provider and the insurer for special business processing purposes. |
Cardinality | 0..1 |
Type | string |
Requirements | Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication. |
Claim.insurance.preAuthRef | |
Element Id | Claim.insurance.preAuthRef |
Definition | Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization. |
Cardinality | 0..* |
Type | string |
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization. |
Comments | This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier. |
Claim.insurance.claimResponse | |
Element Id | Claim.insurance.claimResponse |
Definition | The result of the adjudication of the line items for the Coverage specified in this insurance. |
Cardinality | 0..1 |
Type | Reference(ClaimResponse) |
Requirements | An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim. |
Comments | Must not be specified when 'focal=true' for this insurance. |
Claim.accident | |
Element Id | Claim.accident |
Definition | Details of an accident which resulted in injuries which required the products and services listed in the claim. |
Cardinality | 0..1 |
Requirements | When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance. |
Claim.accident.date | |
Element Id | Claim.accident.date |
Definition | Date of an accident event related to the products and services contained in the claim. |
Cardinality | 1..1 |
Type | date |
Requirements | Required for audit purposes and adjudication. |
Comments | The date of the accident has to precede the dates of the products and services but within a reasonable timeframe. |
Claim.accident.type | |
Element Id | Claim.accident.type |
Definition | The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. |
Cardinality | 0..1 |
Terminology Binding | V3 Value SetActIncidentCode (Extensible) |
Type | CodeableConcept |
Requirements | Coverage may be dependant on the type of accident. |
Claim.accident.location[x] | |
Element Id | Claim.accident.location[x] |
Definition | The physical location of the accident event. |
Cardinality | 0..1 |
Type | Address|Reference(Location) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Required for audit purposes and determination of applicable insurance liability. |
Claim.item | |
Element Id | Claim.item |
Definition | A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details. |
Cardinality | 0..* |
Requirements | The items to be processed for adjudication. |
Claim.item.sequence | |
Element Id | Claim.item.sequence |
Definition | A number to uniquely identify item entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Claim.item.careTeamSequence | |
Element Id | Claim.item.careTeamSequence |
Definition | CareTeam members related to this service or product. |
Cardinality | 0..* |
Type | positiveInt |
Requirements | Need to identify the individuals and their roles in the provision of the product or service. |
Claim.item.diagnosisSequence | |
Element Id | Claim.item.diagnosisSequence |
Definition | Diagnosis applicable for this service or product. |
Cardinality | 0..* |
Type | positiveInt |
Requirements | Need to related the product or service to the associated diagnoses. |
Claim.item.procedureSequence | |
Element Id | Claim.item.procedureSequence |
Definition | Procedures applicable for this service or product. |
Cardinality | 0..* |
Type | positiveInt |
Requirements | Need to provide any listed specific procedures to support the product or service being claimed. |
Claim.item.informationSequence | |
Element Id | Claim.item.informationSequence |
Definition | Exceptions, special conditions and supporting information applicable for this service or product. |
Cardinality | 0..* |
Type | positiveInt |
Requirements | Need to reference the supporting information items that relate directly to this product or service. |
Claim.item.revenue | |
Element Id | Claim.item.revenue |
Definition | The type of revenue or cost center providing the product and/or service. |
Cardinality | 0..1 |
Terminology Binding | Example Revenue Center Codes (Example) |
Type | CodeableConcept |
Requirements | Needed in the processing of institutional claims. |
Claim.item.category | |
Element Id | Claim.item.category |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Cardinality | 0..1 |
Terminology Binding | Benefit Category Codes (Example) |
Type | CodeableConcept |
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Claim.item.productOrService | |
Element Id | Claim.item.productOrService |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Cardinality | 1..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
Requirements | Necessary to state what was provided or done. |
Alternate Names | Drug Code; Bill Code; Service Code |
Comments | If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. 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 e.g. 'glasses' or 'compound'. |
Claim.item.modifier | |
Element Id | Claim.item.modifier |
Definition | Item typification or modifiers codes to convey additional context for the product or service. |
Cardinality | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. |
Comments | For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours. |
Claim.item.programCode | |
Element Id | Claim.item.programCode |
Definition | Identifies the program under which this may be recovered. |
Cardinality | 0..* |
Terminology Binding | Example Program Reason Codes (Example) |
Type | CodeableConcept |
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. |
Comments | For example: Neonatal program, child dental program or drug users recovery program. |
Claim.item.serviced[x] | |
Element Id | Claim.item.serviced[x] |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Cardinality | 0..1 |
Type | date|Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Claim.item.location[x] | |
Element Id | Claim.item.location[x] |
Definition | Where the product or service was provided. |
Cardinality | 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] |
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount. |
Claim.item.quantity | |
Element Id | Claim.item.quantity |
Definition | The number of repetitions of a service or product. |
Cardinality | 0..1 |
Type | SimpleQuantity |
Requirements | Required when the product or service code does not convey the quantity provided. |
Claim.item.unitPrice | |
Element Id | Claim.item.unitPrice |
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
Cardinality | 0..1 |
Type | Money |
Requirements | The amount charged to the patient by the provider for a single unit. |
Claim.item.factor | |
Element Id | 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. |
Cardinality | 0..1 |
Type | decimal |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Claim.item.net | |
Element Id | Claim.item.net |
Definition | The quantity times the unit price for an additional service or product or charge. |
Cardinality | 0..1 |
Type | Money |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Claim.item.udi | |
Element Id | Claim.item.udi |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0..* |
Type | Reference(Device) |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Claim.item.bodySite | |
Element Id | Claim.item.bodySite |
Definition | Physical service site on the patient (limb, tooth, etc.). |
Cardinality | 0..1 |
Terminology Binding | Oral Site Codes (Example) |
Type | CodeableConcept |
Requirements | Allows insurer to validate specific procedures. |
Comments | For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. |
Claim.item.subSite | |
Element Id | Claim.item.subSite |
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
Cardinality | 0..* |
Terminology Binding | Surface Codes (Example) |
Type | CodeableConcept |
Requirements | Allows insurer to validate specific procedures. |
Claim.item.encounter | |
Element Id | Claim.item.encounter |
Definition | The Encounters during which this Claim was created or to which the creation of this record is tightly associated. |
Cardinality | 0..* |
Type | Reference(Encounter) |
Requirements | Used in some jurisdictions to link clinical events to claim items. |
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. |
Claim.item.detail | |
Element Id | Claim.item.detail |
Definition | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
Cardinality | 0..* |
Requirements | The items to be processed for adjudication. |
Claim.item.detail.sequence | |
Element Id | Claim.item.detail.sequence |
Definition | A number to uniquely identify item entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Claim.item.detail.revenue | |
Element Id | Claim.item.detail.revenue |
Definition | The type of revenue or cost center providing the product and/or service. |
Cardinality | 0..1 |
Terminology Binding | Example Revenue Center Codes (Example) |
Type | CodeableConcept |
Requirements | Needed in the processing of institutional claims. |
Claim.item.detail.category | |
Element Id | Claim.item.detail.category |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Cardinality | 0..1 |
Terminology Binding | Benefit Category Codes (Example) |
Type | CodeableConcept |
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Claim.item.detail.productOrService | |
Element Id | Claim.item.detail.productOrService |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Cardinality | 1..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
Requirements | Necessary to state what was provided or done. |
Alternate Names | Drug Code; Bill Code; Service Code |
Comments | If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. 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 e.g. 'glasses' or 'compound'. |
Claim.item.detail.modifier | |
Element Id | Claim.item.detail.modifier |
Definition | Item typification or modifiers codes to convey additional context for the product or service. |
Cardinality | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. |
Comments | For example in 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. |
Claim.item.detail.programCode | |
Element Id | Claim.item.detail.programCode |
Definition | Identifies the program under which this may be recovered. |
Cardinality | 0..* |
Terminology Binding | Example Program Reason Codes (Example) |
Type | CodeableConcept |
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. |
Comments | For example: Neonatal program, child dental program or drug users recovery program. |
Claim.item.detail.quantity | |
Element Id | Claim.item.detail.quantity |
Definition | The number of repetitions of a service or product. |
Cardinality | 0..1 |
Type | SimpleQuantity |
Requirements | Required when the product or service code does not convey the quantity provided. |
Claim.item.detail.unitPrice | |
Element Id | Claim.item.detail.unitPrice |
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
Cardinality | 0..1 |
Type | Money |
Requirements | The amount charged to the patient by the provider for a single unit. |
Claim.item.detail.factor | |
Element Id | 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. |
Cardinality | 0..1 |
Type | decimal |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Claim.item.detail.net | |
Element Id | Claim.item.detail.net |
Definition | The quantity times the unit price for an additional service or product or charge. |
Cardinality | 0..1 |
Type | Money |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Claim.item.detail.udi | |
Element Id | Claim.item.detail.udi |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0..* |
Type | Reference(Device) |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Claim.item.detail.subDetail | |
Element Id | Claim.item.detail.subDetail |
Definition | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
Cardinality | 0..* |
Requirements | The items to be processed for adjudication. |
Claim.item.detail.subDetail.sequence | |
Element Id | Claim.item.detail.subDetail.sequence |
Definition | A number to uniquely identify item entries. |
Cardinality | 1..1 |
Type | positiveInt |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Claim.item.detail.subDetail.revenue | |
Element Id | Claim.item.detail.subDetail.revenue |
Definition | The type of revenue or cost center providing the product and/or service. |
Cardinality | 0..1 |
Terminology Binding | Example Revenue Center Codes (Example) |
Type | CodeableConcept |
Requirements | Needed in the processing of institutional claims. |
Claim.item.detail.subDetail.category | |
Element Id | Claim.item.detail.subDetail.category |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Cardinality | 0..1 |
Terminology Binding | Benefit Category Codes (Example) |
Type | CodeableConcept |
Requirements | Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes. |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Claim.item.detail.subDetail.productOrService | |
Element Id | Claim.item.detail.subDetail.productOrService |
Definition | When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. |
Cardinality | 1..1 |
Terminology Binding | USCLS Codes (Example) |
Type | CodeableConcept |
Requirements | Necessary to state what was provided or done. |
Comments | If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. 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 e.g. 'glasses' or 'compound'. |
Claim.item.detail.subDetail.modifier | |
Element Id | Claim.item.detail.subDetail.modifier |
Definition | Item typification or modifiers codes to convey additional context for the product or service. |
Cardinality | 0..* |
Terminology Binding | Modifier type Codes (Example) |
Type | CodeableConcept |
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. |
Comments | For example in 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. |
Claim.item.detail.subDetail.programCode | |
Element Id | Claim.item.detail.subDetail.programCode |
Definition | Identifies the program under which this may be recovered. |
Cardinality | 0..* |
Terminology Binding | Example Program Reason Codes (Example) |
Type | CodeableConcept |
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. |
Comments | For example: Neonatal program, child dental program or drug users recovery program. |
Claim.item.detail.subDetail.quantity | |
Element Id | Claim.item.detail.subDetail.quantity |
Definition | The number of repetitions of a service or product. |
Cardinality | 0..1 |
Type | SimpleQuantity |
Requirements | Required when the product or service code does not convey the quantity provided. |
Claim.item.detail.subDetail.unitPrice | |
Element Id | Claim.item.detail.subDetail.unitPrice |
Definition | If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group. |
Cardinality | 0..1 |
Type | Money |
Requirements | The amount charged to the patient by the provider for a single unit. |
Claim.item.detail.subDetail.factor | |
Element Id | 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. |
Cardinality | 0..1 |
Type | decimal |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Claim.item.detail.subDetail.net | |
Element Id | Claim.item.detail.subDetail.net |
Definition | The quantity times the unit price for an additional service or product or charge. |
Cardinality | 0..1 |
Type | Money |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Claim.item.detail.subDetail.udi | |
Element Id | Claim.item.detail.subDetail.udi |
Definition | Unique Device Identifiers associated with this line item. |
Cardinality | 0..* |
Type | Reference(Device) |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Claim.total | |
Element Id | Claim.total |
Definition | The total value of the all the items in the claim. |
Cardinality | 0..1 |
Type | Money |
Requirements | Used for control total purposes. |