This page is part of the Quality Improvement Core Framework (v3.1.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-qicore-claim Profile.
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 | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
Claim.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Claim.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Claim.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Claim.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Claim.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
Claim.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Claim.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 |
Binding | A code specifying the state of the resource instance. The codes SHALL be taken from Financial Resource Status Codes |
Type | code |
Is Modifier | true |
Comments | This element is labeled as a modifier because the status contains the code entered-in-error that marks the claim as not currently valid. |
Claim.type | |
Definition | The category of claim, eg, oral, pharmacy, vision, insitutional, professional. |
Control | 0..1 |
Binding | The type or discipline-style of the claim The codes SHALL be taken from Example Claim Type Codes |
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..* |
Binding | A more granular claim typecode For example codes, see Example Claim SubType Codes |
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 |
Binding | Complete, proposed, exploratory, other The codes SHALL be taken from Use |
Type | code |
Claim.patient | |
Definition | Patient Resource. |
Control | 1..1 |
Type | Reference(QICore-Patient) |
Must Support | true |
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 | 1..1 |
Type | dateTime |
Must Support | true |
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 | 1..1 |
Type | Reference(QICore-Practitioner) |
Must Support | true |
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 |
Binding | The timeliness with which processing is required: STAT, normal, Deferred For example codes, see Process Priority Codes |
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 |
Binding | For whom funds are to be reserved: (Patient, Provider, None). For example codes, see Funds Reservation Codes |
Type | CodeableConcept |
Claim.related | |
Definition | Other claims which are related to this claim such as prior claim versions or for related services. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.related.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.related.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.related.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 |
Binding | Relationship of this claim to a related Claim For example codes, see Example Related Claim Relationship Codes |
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 | 1..1 |
Type | Reference(QICore-MedicationRequest | VisionPrescription) |
Must Support | true |
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 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.payee.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.payee.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.payee.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.payee.type | |
Definition | Type of Party to be reimbursed: Subscriber, provider, other. |
Control | 1..1 |
Binding | A code for the party to be reimbursed. For example codes, see Claim Payee Type Codes |
Type | CodeableConcept |
Claim.payee.resourceType | |
Definition | organization | patient | practitioner | relatedperson. |
Control | 0..1 |
Binding | The type of Claim payee Resource For example codes, see ClaimPayeeResourceType |
Type | Coding |
Claim.payee.party | |
Definition | Party to be reimbursed: Subscriber, provider, other. |
Control | 0..1 |
Type | Reference(QICore-Practitioner | QICore-Organization | QICore-Patient | QICore-RelatedPerson) |
Claim.referral | |
Definition | The referral resource which lists the date, practitioner, reason and other supporting information. |
Control | 0..1 |
Type | Reference(QICore-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..* |
Type | BackboneElement |
Requirements | Role and Responsible may not be required when there is only a single provider listed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.careTeam.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.careTeam.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.careTeam.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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(QICore-Practitioner | QICore-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 |
Binding | The role codes for the care team members. For example codes, see Claim Care Team Role Codes |
Type | CodeableConcept |
Claim.careTeam.qualification | |
Definition | The qualification which is applicable for this service. |
Control | 0..1 |
Binding | Provider professional qualifications For example codes, see Example Provider Qualification Codes |
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..* |
Type | BackboneElement |
Requirements | Typically these information codes are required to support the services rendered or the adjudication of the services rendered. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.information.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.information.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.information.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.information.sequence | |
Definition | Sequence of the information element which serves to provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | To provide a reference link. |
Claim.information.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Control | 1..1 |
Binding | This value set includes sample Information Category codes. For example codes, see Claim Information Category Codes |
Type | CodeableConcept |
Must Support | true |
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 |
Binding | This value set includes sample Exception codes. For example codes, see Exception Codes |
Type | CodeableConcept |
Must Support | true |
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 | Choice of: 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 | Choice of: string, Quantity, Attachment, Reference(Resource) |
[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 |
Binding | Reason codes for the missing teeth For example codes, see Missing Tooth Reason Codes |
Type | CodeableConcept |
Claim.diagnosis | |
Definition | List of patient diagnosis for which care is sought. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.diagnosis.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.diagnosis.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.diagnosis.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.diagnosis.sequence | |
Definition | Sequence of diagnosis which serves to provide a link. |
Control | 1..1 |
Type | positiveInt |
Requirements | Required to allow line items to reference the diagnoses. |
Claim.diagnosis.diagnosis[x] | |
Definition | The diagnosis. |
Control | 1..1 |
Binding | ICD10 Diagnostic codes For example codes, see ICD-10 Codes |
Type | Choice of: 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, primary, secondary, discharge. |
Control | 0..* |
Binding | This value set includes example Diagnosis Type codes. For example codes, see Example Diagnosis Type Codes |
Type | CodeableConcept |
Requirements | May be required to adjudicate services rendered. |
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 |
Binding | The DRG codes associated with the diagnosis For example codes, see Example Diagnosis Related Group Codes |
Type | CodeableConcept |
Requirements | May be required to adjudicate services rendered to the mandated grouping system. |
Claim.procedure | |
Definition | Procedures performed. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.procedure.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.procedure.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.procedure.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.procedure.sequence | |
Definition | Procedure sequence for reference. |
Control | 1..1 |
Type | positiveInt |
Must Support | true |
Requirements | Required to maintain order of the procudures. |
Claim.procedure.date | |
Definition | When the procedure was performed. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Requirements | Required to adjudicate services rendered. |
Comments | SB DateTime?? |
Claim.procedure.procedure[x] | |
Definition | When the procedure was performed. |
Control | 1..1 |
Binding | ICD10 Procedure codes For example codes, see ICD-10 Procedure Codes |
Type | Choice of: CodeableConcept, Reference(Procedure) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | Required to adjudicate services rendered. |
Claim.insurance | |
Definition | Financial instrument by which payment information for health care. |
Control | 0..* |
Type | BackboneElement |
Requirements | Health care programs and insurers are significant payors of health service costs. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.insurance.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.insurance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.insurance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.insurance.sequence | |
Definition | Sequence of coverage which serves to provide a link and convey coordination of benefit order. |
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 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.accident.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.accident.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.accident.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 |
Binding | Type of accident: work place, auto, etc. The codes SHALL be taken from ActIncidentCode |
Type | CodeableConcept |
Requirements | Coverage may be dependant on the type of accident. |
Claim.accident.location[x] | |
Definition | Accident Place. |
Control | 0..1 |
Type | Choice of: 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 | Period in hospital. |
Control | 0..1 |
Type | Period |
Must Support | true |
Claim.item | |
Definition | First tier of goods and services. |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.item.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.item.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.item.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Claim.item.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
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 | 1..1 |
Binding | This value set includes a smattering of USCLS codes. For example codes, see USCLS Codes |
Type | CodeableConcept |
Must Support | true |
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..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
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..* |
Binding | Program specific reason codes For example codes, see Example Program Reason Codes |
Type | CodeableConcept |
Claim.item.serviced[x] | |
Definition | The date or dates when the enclosed suite of services were performed or completed. |
Control | 1..1 |
Type | Choice of: date, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Claim.item.locationReference | |
Definition | Where the service was provided. |
Control | 0..1 |
Type | Reference(QICore-Location) |
Claim.item.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(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(QICore-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 |
Binding | The code for the teeth, quadrant, sextant and arch For example codes, see Oral Site Codes |
Type | CodeableConcept |
Claim.item.subSite | |
Definition | A region or surface of the site, eg. limb region or tooth surface(s). |
Control | 0..* |
Binding | The code for the tooth surface and surface combinations For example codes, see Surface Codes |
Type | CodeableConcept |
Claim.item.encounter | |
Definition | Encounters related to this billed item. |
Control | 0..* |
Type | Reference(QICore-Encounter) |
Must Support | true |
Claim.item.detail | |
Definition | Second tier of goods and services. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.item.detail.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.item.detail.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.item.detail.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Claim.item.detail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
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 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
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..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
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..* |
Binding | Program specific reason codes For example codes, see Example Program Reason Codes |
Type | CodeableConcept |
Claim.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(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(QICore-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..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Claim.item.detail.subDetail.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Claim.item.detail.subDetail.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Claim.item.detail.subDetail.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 |
Binding | Codes for the revenue or cost centers supplying the service and/or products. For example codes, see Example Revenue Center Codes |
Type | CodeableConcept |
Claim.item.detail.subDetail.category | |
Definition | Health Care Service Type Codes to identify the classification of service or benefits. |
Control | 0..1 |
Binding | Benefit subcategories such as: oral-basic, major, glasses For example codes, see Benefit SubCategory Codes |
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 |
Binding | Allowable service and product codes For example codes, see USCLS Codes |
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..* |
Binding | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. For example codes, see Modifier type Codes |
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..* |
Binding | Program specific reason codes For example codes, see Example Program Reason Codes |
Type | CodeableConcept |
Claim.item.detail.subDetail.quantity | |
Definition | The number of repetitions of a service or product. |
Control | 0..1 |
Type | Quantity(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..1 |
Type | Reference(QICore-Device) |
Requirements | The UDI code and issuer if applicable for the supplied product. |
Claim.total | |
Definition | The total value of the claim. |
Control | 0..1 |
Type | Money |