0.1.0 - ci-build
kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2024-09-06 |
Definitions for the ClaimInstitutionalProfile resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Claim | |
2. Claim.id | |
Short | Unique string for reference purposes |
Control | 1..? |
4. Claim.meta | |
Short | Metadata about a resource |
Control | 1..? |
6. Claim.meta.profile | |
Control | 1..? |
8. Claim.extension | |
Short | Optional Extensions Element |
Slicing | This element introduces a set of slices on Claim.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. Claim.extension:batchIdentifier | |
Slice Name | batchIdentifier |
Control | 0..1 |
Type | Extension(Extension for Batch Identifier ) (Extension Type: Identifier) |
12. Claim.extension:batchNumber | |
Slice Name | batchNumber |
Control | 0..1 |
Type | Extension(Extension for Batch Number) (Extension Type: string) |
14. Claim.extension:batchPeriod | |
Slice Name | batchPeriod |
Control | 0..1 |
Type | Extension(Extension for Batch Period ) (Extension Type: string) |
16. Claim.extension:diagnosisRelatedGroup | |
Slice Name | diagnosisRelatedGroup |
Control | 0..1 |
Type | Extension(Extension for Diagnosis Related Group) (Extension Type: CodeableConcept) |
18. Claim.extension:encounter | |
Slice Name | encounter |
Control | 0..1 |
Type | Extension(ClaimAuthorizationInstitutionalProfileEncounter) (Extension Type: Reference(Encounter)) |
20. Claim.extension:eligibilityResponse | |
Slice Name | eligibilityResponse |
Control | 0..1 |
Type | Extension(EligibilityResponse) (Extension Type: Reference(SHACoverageEligibilityResponse)) |
22. Claim.extension:EligibilityOffline | |
Slice Name | EligibilityOffline |
Control | 0..1 |
Type | Extension(Extension for EligibilityOffline ) (Extension Type: string) |
24. Claim.extension:EligibilityOfflineDate | |
Slice Name | EligibilityOfflineDate |
Control | 0..1 |
Type | Extension(Extension for Eligibility OffLineDate ) (Extension Type: date) |
26. Claim.extension:authorizationOffLineDate | |
Slice Name | authorizationOffLineDate |
Control | 0..1 |
Type | Extension(Extension for authorization OffLineDate ) (Extension Type: date) |
28. Claim.extension:priorAuthResponse | |
Slice Name | priorAuthResponse |
Control | 0..1 |
Type | Extension(PriorAuthResponse) (Extension Type: Reference(ClaimResponse, ClaimResponseAuthorizationResponseProfile)) |
30. Claim.extension:episode | |
Slice Name | episode |
Control | 0..1 |
Type | Extension(Extension for Episode) (Extension Type: Identifier) |
32. Claim.extension:newborn | |
Slice Name | newborn |
Control | 0..1 |
Type | Extension(Extension for Newborn ) (Extension Type: boolean) |
34. Claim.extension:package | |
Slice Name | package |
Control | 0..1 |
Type | Extension(Extension for Package) (Extension Type: boolean) |
36. Claim.identifier | |
Short | A unique identifier assigned to this claim. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
38. Claim.status | |
Short | The status of the resource instance. |
40. Claim.type | |
Short | The category of authorization |
42. Claim.subType | |
Short | A finer-grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. |
Control | 1..? |
44. Claim.use | |
Short | 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. |
46. Claim.patient | |
Short | 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. |
Type | Reference(SHAPatient) |
48. Claim.billablePeriod | |
Short | The period for which charges are being submitted. |
50. Claim.created | |
Short | The date this resource was created. |
52. Claim.insurer | |
Short | The Insurer who is target of the request. |
Control | 1..? |
54. Claim.provider | |
Short | The provider which is responsible for the claim, predetermination or preauthorization. |
Type | Reference(SHAOrganization, SHAPractitioner) |
56. Claim.priority | |
Short | The provider-required urgency of processing the request. Typical values include: stat, normal (routine), deferred. |
58. Claim.fundsReserve | |
Short | A code to indicate whether and for whom funds are to be reserved for future claims. |
60. Claim.related | |
Short | Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. |
62. Claim.related.claim | |
Short | Reference to a related claim. |
Control | 1..? |
64. Claim.related.relationship | |
Short | A code to convey how the claims are related. |
Control | 1..? |
66. Claim.prescription | |
Short | Prescription to support the dispensing of pharmacy, device or vision products. |
Type | Reference(MedicationRequest, DeviceRequest, VisionPrescription) |
68. Claim.originalPrescription | |
Short | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
Type | Reference(MedicationRequest) |
70. Claim.payee | |
Short | The party to be reimbursed for cost of the products and services according to the terms of the policy. |
Control | 1..? |
72. Claim.payee.type | |
Short | Type of Party to be reimbursed: subscriber, provider, other. |
74. Claim.payee.party | |
Short | Party to be reimbursed. |
Type | Reference(SHAOrganization, SHAPractitioner, SHAPatient) |
76. Claim.referral | |
Short | A reference to a referral resource. |
78. Claim.facility | |
Short | Facility where the services were provided. |
80. Claim.careTeam | |
Short | The members of the team who provided the products and services. |
Control | 1..? |
82. Claim.careTeam.sequence | |
Short | A number to uniquely identify care team entries. |
84. Claim.careTeam.provider | |
Short | Member of the team who provided the product or service. |
86. Claim.careTeam.role | |
Short | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
Control | 1..? |
88. Claim.careTeam.qualification | |
Short | The qualification of the practitioner which is applicable for this service. |
Control | 1..? |
90. Claim.supportingInfo | |
Short | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
92. Claim.supportingInfo.sequence | |
Short | A number to uniquely identify supporting information entries. |
94. Claim.supportingInfo.category | |
Short | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
96. Claim.supportingInfo.code | |
Short | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. |
98. Claim.supportingInfo.timing[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Claim.supportingInfo.timing[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
100. Claim.supportingInfo.timing[x]:timingDate | |
Slice Name | timingDate |
Short | The date when or period to which this information refers. |
Control | 0..1 |
Type | date |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
102. Claim.supportingInfo.timing[x]:timingPeriod | |
Slice Name | timingPeriod |
Short | The period when or period to which this information refers. |
Control | 0..1 |
Type | Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
104. Claim.supportingInfo.value[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Claim.supportingInfo.value[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
106. Claim.supportingInfo.value[x]:valueBoolean | |
Slice Name | valueBoolean |
Short | 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 | boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
108. Claim.supportingInfo.value[x]:valueString | |
Slice Name | valueString |
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Control | 0..1 |
Type | string |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
110. Claim.supportingInfo.value[x]:valueQuantity | |
Slice Name | valueQuantity |
Short | 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 | Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
112. Claim.supportingInfo.value[x]:valueAttachment | |
Slice Name | valueAttachment |
Short | 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 | Attachment |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
114. Claim.supportingInfo.value[x]:valueReference | |
Slice Name | valueReference |
Short | A reference, either FHIR resource reference or the business identifier of an information object, for example a document in an external repository. |
Control | 0..1 |
Type | Reference(Resource) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
116. Claim.supportingInfo.reason | |
Short | Provides the reason in the situation where a reason code is required in addition to the content. |
118. Claim.diagnosis | |
Short | Information about diagnoses relevant to the claim items. |
Control | 1..? |
120. Claim.diagnosis.sequence | |
Short | A number to uniquely identify diagnosis entries. |
122. Claim.diagnosis.diagnosis[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Claim.diagnosis.diagnosis[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
124. Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | |
Slice Name | diagnosisCodeableConcept |
Short | The diagnosis code. |
Control | 1..1 |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
126. Claim.diagnosis.type | |
Short | When the condition was observed or the relative ranking. |
Control | 1..1 |
128. Claim.diagnosis.onAdmission | |
Short | Indication of whether the diagnosis was present on admission to a facility. |
130. Claim.insurance | |
Short | Insurance information. |
132. Claim.insurance.sequence | |
Short | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. |
134. Claim.insurance.focal | |
Short | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
136. Claim.insurance.coverage | |
Short | Reference to the insurance card level information contained in the Coverage resource. |
138. Claim.insurance.preAuthRef | |
Short | 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. |
140. Claim.insurance.claimResponse | |
Short | The result of the adjudication of the line items for the Coverage specified in this insurance. |
142. Claim.accident | |
Short | Details of an accident which resulted in injuries which required the products and services listed in the claim. |
144. Claim.accident.date | |
Short | Date of an accident event related to the products and services contained in the claim. |
146. Claim.accident.type | |
Short | The type or context of the accident event for the purposes |
Control | 1..? |
148. Claim.accident.location[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Claim.accident.location[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
150. Claim.accident.location[x]:locationAddress | |
Slice Name | locationAddress |
Short | The physical location of the accident event. |
Control | 0..1 |
Type | Address |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
152. Claim.item | |
Short | 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. |
Control | 1..? |
154. Claim.item.extension | |
Short | Optional Extensions Element |
Control | 3..? |
Slicing | This element introduces a set of slices on Claim.item.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
156. Claim.item.extension:tax | |
Slice Name | tax |
Control | 0..* |
Type | Extension(Extension for Tax) (Extension Type: Money) |
158. Claim.item.extension:itemPayerShare | |
Slice Name | itemPayerShare |
Control | 1..1 |
Type | Extension(Extension for PayerShare) (Extension Type: Money) |
160. Claim.item.extension:itemPatientShare | |
Slice Name | itemPatientShare |
Control | 1..1 |
Type | Extension(Extension for Patient Share) (Extension Type: Money) |
162. Claim.item.extension:itemPatientInvoice | |
Slice Name | itemPatientInvoice |
Control | 1..1 |
Type | Extension(Extension for Patient Invoice) (Extension Type: Identifier) |
164. Claim.item.sequence | |
Short | A number to uniquely identify item entries. |
166. Claim.item.careTeamSequence | |
Short | CareTeam members related to this service or product. |
Control | 1..? |
168. Claim.item.diagnosisSequence | |
Short | Diagnosis applicable for this service or product. |
170. Claim.item.informationSequence | |
Short | Exceptions, special conditions and supporting information applicable for this service or product. |
172. Claim.item.productOrService | |
Short | 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. |
174. Claim.item.serviced[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on Claim.item.serviced[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
176. Claim.item.serviced[x]:servicedDate | |
Slice Name | servicedDate |
Short | The date or dates when the service or product was supplied, performed or completed. |
Control | 0..1 |
Type | date |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
178. Claim.item.serviced[x]:servicedPeriod | |
Slice Name | servicedPeriod |
Short | The period when the service or product was supplied, performed or completed. |
Control | 0..1 |
Type | Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
180. Claim.item.quantity | |
Short | The number of repetitions of a service or product. |
Control | 1..? |
182. Claim.item.unitPrice | |
Short | 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. |
Control | 1..? |
184. Claim.item.factor | |
Short | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. |
186. Claim.item.net | |
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax. |
Control | 1..? |
188. Claim.item.udi | |
Short | Unique Device Identifiers associated with this line item. |
190. Claim.item.bodySite | |
Short | Physical service site on the patient (limb, tooth, etc.). |
192. Claim.item.subSite | |
Short | A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
Control | 0..1 |
194. Claim.item.detail | |
Short | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
196. Claim.item.detail.extension | |
Short | Optional Extensions Element |
Slicing | This element introduces a set of slices on Claim.item.detail.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
198. Claim.item.detail.extension:tax | |
Slice Name | tax |
Control | 0..* |
Type | Extension(Extension for Tax) (Extension Type: Money) |
200. Claim.item.detail.sequence | |
Short | A number to uniquely identify item entries. |
202. Claim.item.detail.productOrService | |
Short | 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. |
204. Claim.item.detail.quantity | |
Short | The number of repetitions of a service or product. |
Control | 1..? |
206. Claim.item.detail.unitPrice | |
Short | 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. |
Control | 1..? |
208. Claim.item.detail.net | |
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax. |
Control | 1..? |
210. Claim.item.detail.udi | |
Short | Unique Device Identifiers associated with this line item. |
212. Claim.item.detail.subDetail | |
Short | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. |
214. Claim.item.detail.subDetail.extension | |
Slicing | This element introduces a set of slices on Claim.item.detail.subDetail.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
216. Claim.item.detail.subDetail.extension:tax | |
Slice Name | tax |
Control | 0..* |
Type | Extension(Extension for Tax) (Extension Type: Money) |
218. Claim.item.detail.subDetail.sequence | |
Short | A number to uniquely identify item entries. |
220. Claim.item.detail.subDetail.productOrService | |
Short | 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. |
222. Claim.item.detail.subDetail.quantity | |
Short | The number of repetitions of a service or product. |
Control | 1..? |
224. Claim.item.detail.subDetail.unitPrice | |
Short | 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. |
Control | 1..? |
226. Claim.item.detail.subDetail.net | |
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax. |
Control | 1..? |
228. Claim.item.detail.subDetail.udi | |
Short | Unique Device Identifiers associated with this line item. |
230. Claim.total | |
Short | The total value of all the items in the claim. |
Control | 1..? |
Guidance on how to interpret the contents of this table can be found here
0. 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. |
Short | Claim, Pre-determination or Pre-authorization |
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. |
Control | 0..* |
Is Modifier | false |
Summary | false |
Alternate Names | Adjudication Request, Preauthorization Request, Predetermination Request |
Invariants | 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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
2. Claim.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Unique string for reference purposesLogical id of this artifact |
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. |
Control | 10..1 |
Type | idstring |
Is Modifier | false |
Summary | true |
4. Claim.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Short | Metadata about a resourceMetadata about the resource |
Control | 10..1 |
Type | Meta |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
6. Claim.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Short | Profiles this resource claims to conform to |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Control | 10..* |
Type | canonical(StructureDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Claim.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Optional Extensions ElementAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Claim.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. Claim.extension:batchIdentifier | |
Slice Name | batchIdentifier |
Definition | Extension for Batch Identifier |
Short | Extension for Batch Identifier |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Batch Identifier ) (Extension Type: Identifier) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. Claim.extension:batchNumber | |
Slice Name | batchNumber |
Definition | The number associated with a claim within a Batch. |
Short | Extension for Batch Number |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Batch Number) (Extension Type: string) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. Claim.extension:batchPeriod | |
Slice Name | batchPeriod |
Definition | The date associated with the Batch.Batch Date |
Short | Extension for Batch Period |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Batch Period ) (Extension Type: string) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
18. Claim.extension:diagnosisRelatedGroup | |
Slice Name | diagnosisRelatedGroup |
Definition | create extension to hold the DRG - Codesystem (AR DRG) and Valueset Required |
Short | Extension for Diagnosis Related Group |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Diagnosis Related Group) (Extension Type: CodeableConcept) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
20. Claim.extension:encounter | |
Slice Name | encounter |
Definition | A reference to the encounter |
Short | ClaimAuthorizationInstitutionalProfileEncounter |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ClaimAuthorizationInstitutionalProfileEncounter) (Extension Type: Reference(Encounter)) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
22. Claim.extension:eligibilityResponse | |
Slice Name | eligibilityResponse |
Definition | A reference to the coverage eligibility response ID. |
Short | EligibilityResponse |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(EligibilityResponse) (Extension Type: Reference(SHACoverageEligibilityResponse)) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
24. Claim.extension:EligibilityOffline | |
Slice Name | EligibilityOffline |
Definition | String will contain a reference value from the payer |
Short | Extension for EligibilityOffline |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for EligibilityOffline ) (Extension Type: string) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
26. Claim.extension:EligibilityOfflineDate | |
Slice Name | EligibilityOfflineDate |
Definition | Date when the offline check was done |
Short | Extension for Eligibility OffLineDate |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Eligibility OffLineDate ) (Extension Type: date) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
28. Claim.extension:authorizationOffLineDate | |
Slice Name | authorizationOffLineDate |
Definition | Date when the offline check was done |
Short | Extension for authorization OffLineDate |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for authorization OffLineDate ) (Extension Type: date) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
30. Claim.extension:priorAuthResponse | |
Slice Name | priorAuthResponse |
Definition | A reference to the prior authorization response ID. |
Short | PriorAuthResponse |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(PriorAuthResponse) (Extension Type: Reference(ClaimResponse, ClaimResponseAuthorizationResponseProfile)) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
32. Claim.extension:episode | |
Slice Name | episode |
Definition | The provider specific episode identifier. |
Short | Extension for Episode |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Episode) (Extension Type: Identifier) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
34. Claim.extension:newborn | |
Slice Name | newborn |
Definition | Flag to identify that this claim is for a newborn |
Short | Extension for Newborn |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Newborn ) (Extension Type: boolean) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
36. Claim.extension:package | |
Slice Name | package |
Definition | A package billing code or bundle code used to group products and services to a particular health condition. |
Short | Extension for Package |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Package) (Extension Type: boolean) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
38. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
40. Claim.identifier | |
Definition | A unique identifier assigned to this claim. |
Short | A unique identifier assigned to this claim.Business Identifier for claim |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..1* |
Type | Identifier |
Is Modifier | false |
Summary | false |
Requirements | Allows claims to be distinguished and referenced. |
Alternate Names | Claim Number |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Claim.status | |
Definition | The status of the resource instance. |
Short | The status of the resource instance.active | cancelled | draft | entered-in-error |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 )A code specifying the state of the resource instance. |
Type | code |
Is Modifier | true because 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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'. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Claim.type | |
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional. |
Short | The category of authorizationCategory or discipline |
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. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type (extensible to http://hl7.org/fhir/ValueSet/claim-type )The type or discipline-style of the claim. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. 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. |
Short | A finer-grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.More granular claim type |
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. |
Control | 10..1 |
Binding | For example codes, see ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype (example to http://hl7.org/fhir/ValueSet/claim-subtype )A more granular claim typecode. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. 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. |
Short | 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.claim | preauthorization | predetermination |
Control | 1..1 |
Binding | The codes SHALL be taken from Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1 )The purpose of the Claim: predetermination, preauthorization, claim. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | This element is required to understand the nature of the request for adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
50. 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. |
Short | 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.The recipient of the products and services |
Control | 1..1 |
Type | Reference(SHAPatient, Patient) |
Is Modifier | false |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Claim.billablePeriod | |
Definition | The period for which charges are being submitted. |
Short | The period for which charges are being submitted.Relevant time frame for the claim |
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. |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Summary | true |
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. Claim.created | |
Definition | The date this resource was created. |
Short | The date this resource was created.Resource creation date |
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. |
Control | 1..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. Claim.insurer | |
Definition | The Insurer who is target of the request. |
Short | The Insurer who is target of the request.Target |
Control | 10..1 |
Type | Reference(Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Claim.provider | |
Definition | The provider which is responsible for the claim, predetermination or preauthorization. |
Short | The provider which is responsible for the claim, predetermination or preauthorization.Party responsible for the claim |
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. |
Control | 1..1 |
Type | Reference(SHAOrganization, SHAPractitioner, Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. Claim.priority | |
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred. |
Short | The provider-required urgency of processing the request. Typical values include: stat, normal (routine), deferred.Desired processing ugency |
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. |
Control | 1..1 |
Binding | For example codes, see ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority (example to http://hl7.org/fhir/ValueSet/process-priority )The timeliness with which processing is required: stat, normal, deferred. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. Claim.fundsReserve | |
Definition | A code to indicate whether and for whom funds are to be reserved for future claims. |
Short | A code to indicate whether and for whom funds are to be reserved for future claims.For whom to reserve funds |
Comments | This field is only used for preauthorizations. |
Control | 0..1 |
Binding | For example codes, see Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve (example to http://hl7.org/fhir/ValueSet/fundsreserve )For whom funds are to be reserved: (Patient, Provider, None). |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
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 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. 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. |
Short | Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.Prior or corollary claims |
Comments | For example, for the original treatment and follow-up exams. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
68. Claim.related.claim | |
Definition | Reference to a related claim. |
Short | Reference to a related claim.Reference to the related claim |
Control | 10..1 |
Type | Reference(Claim) |
Is Modifier | false |
Summary | false |
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. Claim.related.relationship | |
Definition | A code to convey how the claims are related. |
Short | A code to convey how the claims are related.How the reference claim is related |
Comments | For example, prior claim or umbrella. |
Control | 10..1 |
Binding | For example codes, see ExampleRelatedClaimRelationshipCodeshttp://hl7.org/fhir/ValueSet/related-claim-relationship (example to http://hl7.org/fhir/ValueSet/related-claim-relationship )Relationship of this claim to a related Claim. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Some insurers need a declaration of the type of relationship. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. Claim.prescription | |
Definition | Prescription to support the dispensing of pharmacy, device or vision products. |
Short | Prescription to support the dispensing of pharmacy, device or vision products.Prescription authorizing services and products |
Control | 0..1 |
Type | Reference(MedicationRequest, DeviceRequest, VisionPrescription) |
Is Modifier | false |
Summary | false |
Requirements | Required to authorize the dispensing of controlled substances and devices. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. Claim.originalPrescription | |
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. |
Short | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.Original prescription if superseded by fulfiller |
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'. |
Control | 0..1 |
Type | Reference(MedicationRequest, DeviceRequest, VisionPrescription) |
Is Modifier | false |
Summary | false |
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. Claim.payee | |
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy. |
Short | The party to be reimbursed for cost of the products and services according to the terms of the policy.Recipient of benefits payable |
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. |
Control | 10..1 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
78. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
80. Claim.payee.type | |
Definition | Type of Party to be reimbursed: subscriber, provider, other. |
Short | Type of Party to be reimbursed: subscriber, provider, other.Category of recipient |
Control | 1..1 |
Binding | For example codes, see Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype (example to http://hl7.org/fhir/ValueSet/payeetype )A code for the party to be reimbursed. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
82. Claim.payee.party | |
Definition | Reference to the individual or organization to whom any payment will be made. |
Short | Party to be reimbursed.Recipient reference |
Comments | Not required if the payee is 'subscriber' or 'provider'. |
Control | 0..1 |
Type | Reference(SHAOrganization, SHAPractitioner, SHAPatient, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson) |
Is Modifier | false |
Summary | false |
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. Claim.referral | |
Definition | A reference to a referral resource. |
Short | A reference to a referral resource.Treatment referral |
Comments | The referral resource which lists the date, practitioner, reason and other supporting information. |
Control | 0..1 |
Type | Reference(ServiceRequest) |
Is Modifier | false |
Summary | false |
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. Claim.facility | |
Definition | Facility where the services were provided. |
Short | Facility where the services were provided.Servicing facility |
Control | 0..1 |
Type | Reference(Location) |
Is Modifier | false |
Summary | false |
Requirements | Insurance adjudication can be dependant on where services were delivered. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. Claim.careTeam | |
Definition | The members of the team who provided the products and services. |
Short | The members of the team who provided the products and services.Members of the care team |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | Common to identify the responsible and supporting practitioners. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
92. Claim.careTeam.sequence | |
Definition | A number to uniquely identify care team entries. |
Short | A number to uniquely identify care team entries.Order of care team |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. Claim.careTeam.provider | |
Definition | Member of the team who provided the product or service. |
Short | Member of the team who provided the product or service.Practitioner or organization |
Control | 1..1 |
Type | Reference(Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Summary | false |
Requirements | Often a regulatory requirement to specify the responsible provider. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
96. Claim.careTeam.role | |
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. |
Short | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.Function within the team |
Comments | Role might not be required when there is only a single provider listed. |
Control | 10..1 |
Binding | For example codes, see ClaimCareTeamRoleCodeshttp://hl7.org/fhir/ValueSet/claim-careteamrole (example to http://hl7.org/fhir/ValueSet/claim-careteamrole )The role codes for the care team members. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
98. Claim.careTeam.qualification | |
Definition | The qualification of the practitioner which is applicable for this service. |
Short | The qualification of the practitioner which is applicable for this service.Practitioner credential or specialization |
Control | 10..1 |
Binding | For example codes, see ExampleProviderQualificationCodeshttp://hl7.org/fhir/ValueSet/provider-qualification (example to http://hl7.org/fhir/ValueSet/provider-qualification )Provider professional qualifications. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Need to specify which qualification a provider is delivering the product or service under. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
100. Claim.supportingInfo | |
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. |
Short | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.Supporting information |
Comments | Often there are multiple jurisdiction specific valuesets which are required. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
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 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
102. Claim.supportingInfo.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
104. Claim.supportingInfo.sequence | |
Definition | A number to uniquely identify supporting information entries. |
Short | A number to uniquely identify supporting information entries.Information instance identifier |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
106. Claim.supportingInfo.category | |
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. |
Short | The general class of the information supplied: information; exception; accident, employment; onset, etc.Classification of the supplied information |
Comments | This may contain a category for the local bill type codes. |
Control | 1..1 |
Binding | For example codes, see ClaimInformationCategoryCodeshttp://hl7.org/fhir/ValueSet/claim-informationcategory (example to http://hl7.org/fhir/ValueSet/claim-informationcategory )The valuset used for additional information category codes. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
108. 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. |
Short | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.Type of information |
Control | 0..1 |
Binding | For example codes, see ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception (example to http://hl7.org/fhir/ValueSet/claim-exception )The valuset used for additional information codes. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Required to identify the kind of additional information. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
110. Claim.supportingInfo.timing[x] | |
Definition | The date when or period to which this information refers. |
Short | When it occurred |
Control | 0..1 |
Type | Choice of: date, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Claim.supportingInfo.timing[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
112. Claim.supportingInfo.timing[x]:timingDate | |
Slice Name | timingDate |
Definition | The date when or period to which this information refers. |
Short | The date when or period to which this information refers.When it occurred |
Control | 0..1 |
Type | date, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
114. Claim.supportingInfo.timing[x]:timingPeriod | |
Slice Name | timingPeriod |
Definition | The date when or period to which this information refers. |
Short | The period when or period to which this information refers.When it occurred |
Control | 0..1 |
Type | Period, date |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
116. 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. |
Short | Data to be provided |
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. |
Control | 0..1 |
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Claim.supportingInfo.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
118. Claim.supportingInfo.value[x]:valueBoolean | |
Slice Name | valueBoolean |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Data to be provided |
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. |
Control | 0..1 |
Type | boolean, string, Reference(Resource), Quantity, Attachment |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
120. Claim.supportingInfo.value[x]:valueString | |
Slice Name | valueString |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Data to be provided |
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. |
Control | 0..1 |
Type | string, boolean, Reference(Resource), Quantity, Attachment |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
122. Claim.supportingInfo.value[x]:valueQuantity | |
Slice Name | valueQuantity |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Data to be provided |
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. |
Control | 0..1 |
Type | Quantity, boolean, string, Reference(Resource), Attachment |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
124. Claim.supportingInfo.value[x]:valueAttachment | |
Slice Name | valueAttachment |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Data to be provided |
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. |
Control | 0..1 |
Type | Attachment, boolean, string, Reference(Resource), Quantity |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
126. Claim.supportingInfo.value[x]:valueReference | |
Slice Name | valueReference |
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. |
Short | A reference, either FHIR resource reference or the business identifier of an information object, for example a document in an external repository.Data to be provided |
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. |
Control | 0..1 |
Type | Reference(Resource), boolean, string, Quantity, Attachment |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | To convey the data content to be provided when the information is more than a simple code or period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
128. Claim.supportingInfo.reason | |
Definition | Provides the reason in the situation where a reason code is required in addition to the content. |
Short | Provides the reason in the situation where a reason code is required in addition to the content.Explanation for the information |
Comments | For example: the reason for the additional stay, or why a tooth is missing. |
Control | 0..1 |
Binding | For example codes, see MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason (example to http://hl7.org/fhir/ValueSet/missing-tooth-reason )Reason codes for the missing teeth. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
130. Claim.diagnosis | |
Definition | Information about diagnoses relevant to the claim items. |
Short | Information about diagnoses relevant to the claim items.Pertinent diagnosis information |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | Required for the adjudication by provided context for the services and product listed. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
132. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
134. Claim.diagnosis.sequence | |
Definition | A number to uniquely identify diagnosis entries. |
Short | A number to uniquely identify diagnosis entries.Diagnosis instance identifier |
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
136. Claim.diagnosis.diagnosis[x] | |
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
Short | Nature of illness or problem |
Control | 1..1 |
Binding | For example codes, see ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 (example to http://hl7.org/fhir/ValueSet/icd-10 )Example ICD10 Diagnostic codes. |
Type | CodeableConcept, Reference(Condition) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | Provides health context for the evaluation of the products and/or services. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Claim.diagnosis.diagnosis[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
138. Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | |
Slice Name | diagnosisCodeableConcept |
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. |
Short | The diagnosis code.Nature of illness or problem |
Control | 1..1 |
Binding | For example codes, see ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 (example to http://hl7.org/fhir/ValueSet/icd-10 )Example ICD10 Diagnostic codes. |
Type | CodeableConcept, Reference(Condition) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | Provides health context for the evaluation of the products and/or services. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
140. Claim.diagnosis.type | |
Definition | When the condition was observed or the relative ranking. |
Short | When the condition was observed or the relative ranking.Timing or nature of the diagnosis |
Comments | For example: admitting, primary, secondary, discharge. |
Control | 10..1* |
Binding | For example codes, see ExampleDiagnosisTypeCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosistype (example to http://hl7.org/fhir/ValueSet/ex-diagnosistype )The type of the diagnosis: admitting, principal, discharge. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
142. Claim.diagnosis.onAdmission | |
Definition | Indication of whether the diagnosis was present on admission to a facility. |
Short | Indication of whether the diagnosis was present on admission to a facility.Present on admission |
Control | 0..1 |
Binding | For example codes, see ExampleDiagnosisOnAdmissionCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission (example to http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission )Present on admission. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Many systems need to understand for adjudication if the diagnosis was present a time of admission. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
144. Claim.insurance | |
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. |
Short | Insurance information.Patient insurance information |
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. |
Control | 1..* |
Type | BackboneElement |
Is Modifier | false |
Summary | true |
Requirements | At least one insurer is required for a claim to be a claim. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
146. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
148. Claim.insurance.sequence | |
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. |
Short | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.Insurance instance identifier |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | To maintain order of the coverages. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
150. Claim.insurance.focal | |
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. |
Short | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.Coverage to be used for adjudication |
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. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | To identify which coverage in the list is being used to adjudicate this claim. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
152. 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. |
Short | Reference to the insurance card level information contained in the Coverage resource.Insurance information |
Control | 1..1 |
Type | Reference(Coverage) |
Is Modifier | false |
Summary | true |
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
154. 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. |
Short | 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.Prior authorization reference number |
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. |
Control | 0..* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
156. Claim.insurance.claimResponse | |
Definition | The result of the adjudication of the line items for the Coverage specified in this insurance. |
Short | The result of the adjudication of the line items for the Coverage specified in this insurance.Adjudication results |
Comments | Must not be specified when 'focal=true' for this insurance. |
Control | 0..1 |
Type | Reference(ClaimResponse) |
Is Modifier | false |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
158. Claim.accident | |
Definition | Details of an accident which resulted in injuries which required the products and services listed in the claim. |
Short | Details of an accident which resulted in injuries which required the products and services listed in the claim.Details of the event |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
160. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
162. Claim.accident.date | |
Definition | Date of an accident event related to the products and services contained in the claim. |
Short | Date of an accident event related to the products and services contained in the claim.When the incident occurred |
Comments | The date of the accident has to precede the dates of the products and services but within a reasonable timeframe. |
Control | 1..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Required for audit purposes and adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
164. 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. |
Short | The type or context of the accident event for the purposesThe nature of the accident |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from ActIncidentCodehttp://terminology.hl7.org/ValueSet/v3-ActIncidentCode (extensible to http://terminology.hl7.org/ValueSet/v3-ActIncidentCode )Type of accident: work place, auto, etc. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Coverage may be dependant on the type of accident. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
166. Claim.accident.location[x] | |
Definition | The physical location of the accident event. |
Short | Where the event occurred |
Control | 0..1 |
Type | Choice of: Address, Reference(Location) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | Required for audit purposes and determination of applicable insurance liability. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Claim.accident.location[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
168. Claim.accident.location[x]:locationAddress | |
Slice Name | locationAddress |
Definition | The physical location of the accident event. |
Short | The physical location of the accident event.Where the event occurred |
Control | 0..1 |
Type | Address, Reference(Location) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | Required for audit purposes and determination of applicable insurance liability. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
170. 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. |
Short | 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.Product or service provided |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | The items to be processed for adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
172. Claim.item.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Optional Extensions ElementAdditional content defined by implementations |
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. |
Control | 30..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Claim.item.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
174. Claim.item.extension:tax | |
Slice Name | tax |
Definition | The amount of Tax (VAT) levied on the line item. |
Short | Extension for Tax |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Tax) (Extension Type: Money) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
176. Claim.item.extension:itemPayerShare | |
Slice Name | itemPayerShare |
Definition | Refer to the expected payer share amount (to be paid) |
Short | Extension for PayerShare |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for PayerShare) (Extension Type: Money) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
178. Claim.item.extension:itemPatientShare | |
Slice Name | itemPatientShare |
Definition | Refer to the patient share amount |
Short | Extension for Patient Share |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Patient Share) (Extension Type: Money) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
180. Claim.item.extension:itemPatientInvoice | |
Slice Name | itemPatientInvoice |
Definition | The number of the patient invoice on which the service was billed. |
Short | Extension for Patient Invoice |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Patient Invoice) (Extension Type: Identifier) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
182. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
184. Claim.item.sequence | |
Definition | A number to uniquely identify item entries. |
Short | A number to uniquely identify item entries.Item instance identifier |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
186. Claim.item.careTeamSequence | |
Definition | CareTeam members related to this service or product. |
Short | CareTeam members related to this service or product.Applicable careTeam members |
Control | 10..* |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Need to identify the individuals and their roles in the provision of the product or service. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
188. Claim.item.diagnosisSequence | |
Definition | Diagnosis applicable for this service or product. |
Short | Diagnosis applicable for this service or product.Applicable diagnoses |
Control | 0..* |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Need to related the product or service to the associated diagnoses. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
190. Claim.item.informationSequence | |
Definition | Exceptions, special conditions and supporting information applicable for this service or product. |
Short | Exceptions, special conditions and supporting information applicable for this service or product.Applicable exception and supporting information |
Control | 0..* |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Need to reference the supporting information items that relate directly to this product or service. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
192. 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. |
Short | 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.Billing, service, product, or drug 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'. |
Control | 1..1 |
Binding | For example codes, see USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Necessary to state what was provided or done. |
Alternate Names | Drug Code, Bill Code, Service Code |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
194. Claim.item.serviced[x] | |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Short | Date or dates of service or product delivery |
Control | 0..1 |
Type | Choice of: date, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Claim.item.serviced[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
196. Claim.item.serviced[x]:servicedDate | |
Slice Name | servicedDate |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Short | The date or dates when the service or product was supplied, performed or completed.Date or dates of service or product delivery |
Control | 0..1 |
Type | date, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
198. Claim.item.serviced[x]:servicedPeriod | |
Slice Name | servicedPeriod |
Definition | The date or dates when the service or product was supplied, performed or completed. |
Short | The period when the service or product was supplied, performed or completed.Date or dates of service or product delivery |
Control | 0..1 |
Type | Period, date |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
200. Claim.item.quantity | |
Definition | The number of repetitions of a service or product. |
Short | The number of repetitions of a service or product.Count of products or services |
Control | 10..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | false |
Requirements | Required when the product or service code does not convey the quantity provided. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
202. 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. |
Short | 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.Fee, charge or cost per item |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | The amount charged to the patient by the provider for a single unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
204. 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. |
Short | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.Price scaling factor |
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). |
Control | 0..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
206. Claim.item.net | |
Definition | The quantity times the unit price for an additional service or product or charge. |
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax.Total item cost |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
208. Claim.item.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Short | Unique Device Identifiers associated with this line item.Unique device identifier |
Control | 0..* |
Type | Reference(Device) |
Is Modifier | false |
Summary | false |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
210. Claim.item.bodySite | |
Definition | Physical service site on the patient (limb, tooth, etc.). |
Short | Physical service site on the patient (limb, tooth, etc.).Anatomical location |
Comments | For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. |
Control | 0..1 |
Binding | For example codes, see OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth (example to http://hl7.org/fhir/ValueSet/tooth )The code for the teeth, quadrant, sextant and arch. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Allows insurer to validate specific procedures. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
212. Claim.item.subSite | |
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). |
Short | A region or surface of the bodySite, e.g. limb region or tooth surface(s).Anatomical sub-location |
Control | 0..1* |
Binding | For example codes, see SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface (example to http://hl7.org/fhir/ValueSet/surface )The code for the tooth surface and surface combinations. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Allows insurer to validate specific procedures. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
214. 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. |
Short | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Product or service provided |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | The items to be processed for adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
216. Claim.item.detail.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Optional Extensions ElementAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Claim.item.detail.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
218. Claim.item.detail.extension:tax | |
Slice Name | tax |
Definition | The amount of Tax (VAT) levied on the line item. |
Short | Extension for Tax |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Tax) (Extension Type: Money) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
220. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
222. Claim.item.detail.sequence | |
Definition | A number to uniquely identify item entries. |
Short | A number to uniquely identify item entries.Item instance identifier |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
224. 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. |
Short | 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.Billing, service, product, or drug 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'. |
Control | 1..1 |
Binding | For example codes, see USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Necessary to state what was provided or done. |
Alternate Names | Drug Code, Bill Code, Service Code |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
226. Claim.item.detail.quantity | |
Definition | The number of repetitions of a service or product. |
Short | The number of repetitions of a service or product.Count of products or services |
Control | 10..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | false |
Requirements | Required when the product or service code does not convey the quantity provided. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
228. 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. |
Short | 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.Fee, charge or cost per item |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | The amount charged to the patient by the provider for a single unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
230. Claim.item.detail.net | |
Definition | The quantity times the unit price for an additional service or product or charge. |
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax.Total item cost |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
232. Claim.item.detail.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Short | Unique Device Identifiers associated with this line item.Unique device identifier |
Control | 0..* |
Type | Reference(Device) |
Is Modifier | false |
Summary | false |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
234. 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. |
Short | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Product or service provided |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | The items to be processed for adjudication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
236. Claim.item.detail.subDetail.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Claim.item.detail.subDetail.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
238. Claim.item.detail.subDetail.extension:tax | |
Slice Name | tax |
Definition | The amount of Tax (VAT) levied on the line item. |
Short | Extension for Tax |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Extension for Tax) (Extension Type: Money) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
240. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
242. Claim.item.detail.subDetail.sequence | |
Definition | A number to uniquely identify item entries. |
Short | A number to uniquely identify item entries.Item instance identifier |
Control | 1..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
244. 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. |
Short | 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.Billing, service, product, or drug 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'. |
Control | 1..1 |
Binding | For example codes, see USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Necessary to state what was provided or done. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
246. Claim.item.detail.subDetail.quantity | |
Definition | The number of repetitions of a service or product. |
Short | The number of repetitions of a service or product.Count of products or services |
Control | 10..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | false |
Requirements | Required when the product or service code does not convey the quantity provided. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
248. 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. |
Short | 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.Fee, charge or cost per item |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | The amount charged to the patient by the provider for a single unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
250. Claim.item.detail.subDetail.net | |
Definition | The quantity times the unit price for an additional service or product or charge. |
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax.Total item cost |
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
252. Claim.item.detail.subDetail.udi | |
Definition | Unique Device Identifiers associated with this line item. |
Short | Unique Device Identifiers associated with this line item.Unique device identifier |
Control | 0..* |
Type | Reference(Device) |
Is Modifier | false |
Summary | false |
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
254. Claim.total | |
Definition | The total value of the all the items in the claim. |
Short | The total value of all the items in the claim.Total claim cost |
Control | 10..1 |
Type | Money |
Is Modifier | false |
Summary | false |
Requirements | Used for control total purposes. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. 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. | ||||
Short | Claim, Pre-determination or Pre-authorization | ||||
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. | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | Adjudication Request, Preauthorization Request, Predetermination Request | ||||
Invariants | 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 or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||
2. Claim.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Unique string for reference purposes | ||||
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. | ||||
Control | 1..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. Claim.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about a resource | ||||
Control | 1..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. Claim.meta.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
8. Claim.meta.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Claim.meta.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
10. Claim.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
Short | Version specific identifier | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. Claim.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Short | When the resource version last changed | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
14. Claim.meta.source | |||||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
Short | Identifies where the resource comes from | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
16. Claim.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Short | Profiles this resource claims to conform to | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Control | 1..* | ||||
Type | canonical(StructureDefinition) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
18. Claim.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Short | Security Labels applied to this resource | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels )Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. Claim.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Short | Tags applied to this resource | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Control | 0..* | ||||
Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags )Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. Claim.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. Claim.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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 information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. 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. | ||||
Short | Contained, inline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
30. Claim.extension | |||||
Definition | An Extension | ||||
Short | Optional Extensions Element | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Claim.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
32. Claim.extension:batchIdentifier | |||||
Slice Name | batchIdentifier | ||||
Definition | Extension for Batch Identifier | ||||
Short | Extension for Batch Identifier | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Batch Identifier ) (Extension Type: Identifier) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
34. Claim.extension:batchNumber | |||||
Slice Name | batchNumber | ||||
Definition | The number associated with a claim within a Batch. | ||||
Short | Extension for Batch Number | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Batch Number) (Extension Type: string) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
36. Claim.extension:batchPeriod | |||||
Slice Name | batchPeriod | ||||
Definition | The date associated with the Batch.Batch Date | ||||
Short | Extension for Batch Period | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Batch Period ) (Extension Type: string) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
38. Claim.extension:diagnosisRelatedGroup | |||||
Slice Name | diagnosisRelatedGroup | ||||
Definition | create extension to hold the DRG - Codesystem (AR DRG) and Valueset Required | ||||
Short | Extension for Diagnosis Related Group | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Diagnosis Related Group) (Extension Type: CodeableConcept) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
40. Claim.extension:encounter | |||||
Slice Name | encounter | ||||
Definition | A reference to the encounter | ||||
Short | ClaimAuthorizationInstitutionalProfileEncounter | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ClaimAuthorizationInstitutionalProfileEncounter) (Extension Type: Reference(Encounter)) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
42. Claim.extension:eligibilityResponse | |||||
Slice Name | eligibilityResponse | ||||
Definition | A reference to the coverage eligibility response ID. | ||||
Short | EligibilityResponse | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(EligibilityResponse) (Extension Type: Reference(SHACoverageEligibilityResponse)) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
44. Claim.extension:EligibilityOffline | |||||
Slice Name | EligibilityOffline | ||||
Definition | String will contain a reference value from the payer | ||||
Short | Extension for EligibilityOffline | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for EligibilityOffline ) (Extension Type: string) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
46. Claim.extension:EligibilityOfflineDate | |||||
Slice Name | EligibilityOfflineDate | ||||
Definition | Date when the offline check was done | ||||
Short | Extension for Eligibility OffLineDate | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Eligibility OffLineDate ) (Extension Type: date) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
48. Claim.extension:authorizationOffLineDate | |||||
Slice Name | authorizationOffLineDate | ||||
Definition | Date when the offline check was done | ||||
Short | Extension for authorization OffLineDate | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for authorization OffLineDate ) (Extension Type: date) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
50. Claim.extension:priorAuthResponse | |||||
Slice Name | priorAuthResponse | ||||
Definition | A reference to the prior authorization response ID. | ||||
Short | PriorAuthResponse | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(PriorAuthResponse) (Extension Type: Reference(ClaimResponse, ClaimResponseAuthorizationResponseProfile)) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
52. Claim.extension:episode | |||||
Slice Name | episode | ||||
Definition | The provider specific episode identifier. | ||||
Short | Extension for Episode | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Episode) (Extension Type: Identifier) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
54. Claim.extension:newborn | |||||
Slice Name | newborn | ||||
Definition | Flag to identify that this claim is for a newborn | ||||
Short | Extension for Newborn | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Newborn ) (Extension Type: boolean) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
56. Claim.extension:package | |||||
Slice Name | package | ||||
Definition | A package billing code or bundle code used to group products and services to a particular health condition. | ||||
Short | Extension for Package | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Package) (Extension Type: boolean) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
58. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
60. Claim.identifier | |||||
Definition | A unique identifier assigned to this claim. | ||||
Short | A unique identifier assigned to this claim. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows claims to be distinguished and referenced. | ||||
Alternate Names | Claim Number | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. Claim.status | |||||
Definition | The status of the resource instance. | ||||
Short | The status of the resource instance. | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from FinancialResourceStatusCodes (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 )A code specifying the state of the resource instance. | ||||
Type | code | ||||
Is Modifier | true because 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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'. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
64. Claim.type | |||||
Definition | The category of claim, e.g. oral, pharmacy, vision, institutional, professional. | ||||
Short | The category of authorization | ||||
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. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ClaimTypeCodes (extensible to http://hl7.org/fhir/ValueSet/claim-type )The type or discipline-style of the claim. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Claim type determine the general sets of business rules applied for information requirements and adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. 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. | ||||
Short | A finer-grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. | ||||
Comments | This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ExampleClaimSubTypeCodes (example to http://hl7.org/fhir/ValueSet/claim-subtype )A more granular claim typecode. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Some jurisdictions need a finer grained claim type for routing and adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. 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. | ||||
Short | 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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Use (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1 )The purpose of the Claim: predetermination, preauthorization, claim. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | This element is required to understand the nature of the request for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. 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. | ||||
Short | 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. | ||||
Control | 1..1 | ||||
Type | Reference(SHAPatient) | ||||
Is Modifier | false | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. Claim.billablePeriod | |||||
Definition | The period for which charges are being submitted. | ||||
Short | The period for which charges are being submitted. | ||||
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. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
74. Claim.created | |||||
Definition | The date this resource was created. | ||||
Short | The date this resource was created. | ||||
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. | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to record a timestamp for use by both the recipient and the issuer. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
76. Claim.enterer | |||||
Definition | Individual who created the claim, predetermination or preauthorization. | ||||
Short | Author of the claim | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Some jurisdictions require the contact information for personnel completing claims. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
78. Claim.insurer | |||||
Definition | The Insurer who is target of the request. | ||||
Short | The Insurer who is target of the request. | ||||
Control | 1..1 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
80. Claim.provider | |||||
Definition | The provider which is responsible for the claim, predetermination or preauthorization. | ||||
Short | The provider which is responsible for the claim, predetermination or preauthorization. | ||||
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. | ||||
Control | 1..1 | ||||
Type | Reference(SHAOrganization, SHAPractitioner) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
82. Claim.priority | |||||
Definition | The provider-required urgency of processing the request. Typical values include: stat, routine deferred. | ||||
Short | The provider-required urgency of processing the request. Typical values include: stat, normal (routine), deferred. | ||||
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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ProcessPriorityCodes (example to http://hl7.org/fhir/ValueSet/process-priority )The timeliness with which processing is required: stat, normal, deferred. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
84. Claim.fundsReserve | |||||
Definition | A code to indicate whether and for whom funds are to be reserved for future claims. | ||||
Short | A code to indicate whether and for whom funds are to be reserved for future claims. | ||||
Comments | This field is only used for preauthorizations. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Funds Reservation Codes (example to http://hl7.org/fhir/ValueSet/fundsreserve )For whom funds are to be reserved: (Patient, Provider, None). | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
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 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
86. 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. | ||||
Short | Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. | ||||
Comments | For example, for the original treatment and follow-up exams. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
88. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
90. Claim.related.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
92. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
94. Claim.related.claim | |||||
Definition | Reference to a related claim. | ||||
Short | Reference to a related claim. | ||||
Control | 1..1 | ||||
Type | Reference(Claim) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | For workplace or other accidents it is common to relate separate claims arising from the same event. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. Claim.related.relationship | |||||
Definition | A code to convey how the claims are related. | ||||
Short | A code to convey how the claims are related. | ||||
Comments | For example, prior claim or umbrella. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ExampleRelatedClaimRelationshipCodes (example to http://hl7.org/fhir/ValueSet/related-claim-relationship )Relationship of this claim to a related Claim. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Some insurers need a declaration of the type of relationship. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. Claim.related.reference | |||||
Definition | An alternate organizational reference to the case or file to which this particular claim pertains. | ||||
Short | File or case reference | ||||
Comments | For example, Property/Casualty insurer claim # or Workers Compensation case # . | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
100. Claim.prescription | |||||
Definition | Prescription to support the dispensing of pharmacy, device or vision products. | ||||
Short | Prescription to support the dispensing of pharmacy, device or vision products. | ||||
Control | 0..1 | ||||
Type | Reference(MedicationRequest, DeviceRequest, VisionPrescription) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required to authorize the dispensing of controlled substances and devices. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
102. Claim.originalPrescription | |||||
Definition | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. | ||||
Short | Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. | ||||
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'. | ||||
Control | 0..1 | ||||
Type | Reference(MedicationRequest) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. Claim.payee | |||||
Definition | The party to be reimbursed for cost of the products and services according to the terms of the policy. | ||||
Short | The party to be reimbursed for cost of the products and services according to the terms of the policy. | ||||
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. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
106. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
108. Claim.payee.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
110. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
112. Claim.payee.type | |||||
Definition | Type of Party to be reimbursed: subscriber, provider, other. | ||||
Short | Type of Party to be reimbursed: subscriber, provider, other. | ||||
Control | 1..1 | ||||
Binding | For example codes, see Claim Payee Type Codes (example to http://hl7.org/fhir/ValueSet/payeetype )A code for the party to be reimbursed. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
114. Claim.payee.party | |||||
Definition | Reference to the individual or organization to whom any payment will be made. | ||||
Short | Party to be reimbursed. | ||||
Comments | Not required if the payee is 'subscriber' or 'provider'. | ||||
Control | 0..1 | ||||
Type | Reference(SHAOrganization, SHAPractitioner, SHAPatient) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Need to provide demographics if the payee is not 'subscriber' nor 'provider'. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
116. Claim.referral | |||||
Definition | A reference to a referral resource. | ||||
Short | A reference to a referral resource. | ||||
Comments | The referral resource which lists the date, practitioner, reason and other supporting information. | ||||
Control | 0..1 | ||||
Type | Reference(ServiceRequest) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Some insurers require proof of referral to pay for services or to pay specialist rates for services. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
118. Claim.facility | |||||
Definition | Facility where the services were provided. | ||||
Short | Facility where the services were provided. | ||||
Control | 0..1 | ||||
Type | Reference(Location) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Insurance adjudication can be dependant on where services were delivered. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
120. Claim.careTeam | |||||
Definition | The members of the team who provided the products and services. | ||||
Short | The members of the team who provided the products and services. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Common to identify the responsible and supporting practitioners. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
122. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
124. Claim.careTeam.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
126. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
128. Claim.careTeam.sequence | |||||
Definition | A number to uniquely identify care team entries. | ||||
Short | A number to uniquely identify care team entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
130. Claim.careTeam.provider | |||||
Definition | Member of the team who provided the product or service. | ||||
Short | Member of the team who provided the product or service. | ||||
Control | 1..1 | ||||
Type | Reference(Practitioner, PractitionerRole, Organization) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Often a regulatory requirement to specify the responsible provider. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
132. Claim.careTeam.responsible | |||||
Definition | The party who is billing and/or responsible for the claimed products or services. | ||||
Short | Indicator of the lead practitioner | ||||
Comments | Responsible might not be required when there is only a single provider listed. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | When multiple parties are present it is required to distinguish the lead or responsible individual. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
134. Claim.careTeam.role | |||||
Definition | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. | ||||
Short | The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. | ||||
Comments | Role might not be required when there is only a single provider listed. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ClaimCareTeamRoleCodes (example to http://hl7.org/fhir/ValueSet/claim-careteamrole )The role codes for the care team members. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | When multiple parties are present it is required to distinguish the roles performed by each member. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
136. Claim.careTeam.qualification | |||||
Definition | The qualification of the practitioner which is applicable for this service. | ||||
Short | The qualification of the practitioner which is applicable for this service. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ExampleProviderQualificationCodes (example to http://hl7.org/fhir/ValueSet/provider-qualification )Provider professional qualifications. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Need to specify which qualification a provider is delivering the product or service under. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
138. Claim.supportingInfo | |||||
Definition | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Short | Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. | ||||
Comments | Often there are multiple jurisdiction specific valuesets which are required. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
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 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
140. Claim.supportingInfo.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
142. Claim.supportingInfo.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
144. Claim.supportingInfo.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
146. Claim.supportingInfo.sequence | |||||
Definition | A number to uniquely identify supporting information entries. | ||||
Short | A number to uniquely identify supporting information entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
148. Claim.supportingInfo.category | |||||
Definition | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Short | The general class of the information supplied: information; exception; accident, employment; onset, etc. | ||||
Comments | This may contain a category for the local bill type codes. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ClaimInformationCategoryCodes (example to http://hl7.org/fhir/ValueSet/claim-informationcategory )The valuset used for additional information category codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required to group or associate information items with common characteristics. For example: admission information or prior treatments. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
150. 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. | ||||
Short | System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExceptionCodes (example to http://hl7.org/fhir/ValueSet/claim-exception )The valuset used for additional information codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required to identify the kind of additional information. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
152. Claim.supportingInfo.timing[x] | |||||
Definition | The date when or period to which this information refers. | ||||
Short | When it occurred | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Claim.supportingInfo.timing[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
154. Claim.supportingInfo.timing[x]:timingDate | |||||
Slice Name | timingDate | ||||
Definition | The date when or period to which this information refers. | ||||
Short | The date when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | date | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
156. Claim.supportingInfo.timing[x]:timingPeriod | |||||
Slice Name | timingPeriod | ||||
Definition | The date when or period to which this information refers. | ||||
Short | The period when or period to which this information refers. | ||||
Control | 0..1 | ||||
Type | Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
158. 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. | ||||
Short | Data to be provided | ||||
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. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, string, Quantity, Attachment, Reference(Resource) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Claim.supportingInfo.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
160. Claim.supportingInfo.value[x]:valueBoolean | |||||
Slice Name | valueBoolean | ||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
162. Claim.supportingInfo.value[x]:valueString | |||||
Slice Name | valueString | ||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
164. Claim.supportingInfo.value[x]:valueQuantity | |||||
Slice Name | valueQuantity | ||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
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. | ||||
Control | 0..1 | ||||
Type | Quantity | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
166. Claim.supportingInfo.value[x]:valueAttachment | |||||
Slice Name | valueAttachment | ||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Short | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
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. | ||||
Control | 0..1 | ||||
Type | Attachment | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
168. Claim.supportingInfo.value[x]:valueReference | |||||
Slice Name | valueReference | ||||
Definition | Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. | ||||
Short | A reference, either FHIR resource reference or the business identifier of an information object, for example a document in an external repository. | ||||
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. | ||||
Control | 0..1 | ||||
Type | Reference(Resource) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To convey the data content to be provided when the information is more than a simple code or period. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
170. Claim.supportingInfo.reason | |||||
Definition | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Short | Provides the reason in the situation where a reason code is required in addition to the content. | ||||
Comments | For example: the reason for the additional stay, or why a tooth is missing. | ||||
Control | 0..1 | ||||
Binding | For example codes, see MissingToothReasonCodes (example to http://hl7.org/fhir/ValueSet/missing-tooth-reason )Reason codes for the missing teeth. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed when the supporting information has both a date and amount/value and requires explanation. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
172. Claim.diagnosis | |||||
Definition | Information about diagnoses relevant to the claim items. | ||||
Short | Information about diagnoses relevant to the claim items. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required for the adjudication by provided context for the services and product listed. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
174. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
176. Claim.diagnosis.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
178. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
180. Claim.diagnosis.sequence | |||||
Definition | A number to uniquely identify diagnosis entries. | ||||
Short | A number to uniquely identify diagnosis entries. | ||||
Comments | Diagnosis are presented in list order to their expected importance: primary, secondary, etc. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
182. Claim.diagnosis.diagnosis[x] | |||||
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. | ||||
Short | Nature of illness or problem | ||||
Control | 1..1 | ||||
Binding | For example codes, see ICD-10Codes (example to http://hl7.org/fhir/ValueSet/icd-10 )Example ICD10 Diagnostic codes. | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Provides health context for the evaluation of the products and/or services. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Claim.diagnosis.diagnosis[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
184. Claim.diagnosis.diagnosis[x]:diagnosisCodeableConcept | |||||
Slice Name | diagnosisCodeableConcept | ||||
Definition | The nature of illness or problem in a coded form or as a reference to an external defined Condition. | ||||
Short | The diagnosis code. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ICD-10Codes (example to http://hl7.org/fhir/ValueSet/icd-10 )Example ICD10 Diagnostic codes. | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Provides health context for the evaluation of the products and/or services. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
186. Claim.diagnosis.type | |||||
Definition | When the condition was observed or the relative ranking. | ||||
Short | When the condition was observed or the relative ranking. | ||||
Comments | For example: admitting, primary, secondary, discharge. | ||||
Control | 1..1 | ||||
Binding | For example codes, see ExampleDiagnosisTypeCodes (example to http://hl7.org/fhir/ValueSet/ex-diagnosistype )The type of the diagnosis: admitting, principal, discharge. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
188. Claim.diagnosis.onAdmission | |||||
Definition | Indication of whether the diagnosis was present on admission to a facility. | ||||
Short | Indication of whether the diagnosis was present on admission to a facility. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleDiagnosisOnAdmissionCodes (example to http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission )Present on admission. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Many systems need to understand for adjudication if the diagnosis was present a time of admission. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
190. 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. | ||||
Short | Package billing 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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleDiagnosisRelatedGroupCodes (example to http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup )The DRG codes associated with the diagnosis. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
192. Claim.procedure | |||||
Definition | Procedures performed on the patient relevant to the billing items with the claim. | ||||
Short | Clinical procedures performed | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
194. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
196. Claim.procedure.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
198. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
200. Claim.procedure.sequence | |||||
Definition | A number to uniquely identify procedure entries. | ||||
Short | Procedure instance identifier | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to provide a mechanism to link to claim details. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
202. Claim.procedure.type | |||||
Definition | When the condition was observed or the relative ranking. | ||||
Short | Category of Procedure | ||||
Comments | For example: primary, secondary. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProcedureTypeCodes (example to http://hl7.org/fhir/ValueSet/ex-procedure-type )Example procedure type codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Often required to capture a particular diagnosis, for example: primary or discharge. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
204. Claim.procedure.date | |||||
Definition | Date and optionally time the procedure was performed. | ||||
Short | When the procedure was performed | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Required for auditing purposes. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
206. Claim.procedure.procedure[x] | |||||
Definition | The code or reference to a Procedure resource which identifies the clinical intervention performed. | ||||
Short | Specific clinical procedure | ||||
Control | 1..1 | ||||
Binding | For example codes, see ICD-10ProcedureCodes (example to http://hl7.org/fhir/ValueSet/icd-10-procedures )Example ICD10 Procedure codes. | ||||
Type | Choice of: CodeableConcept, Reference(Procedure) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | This identifies the actual clinical procedure. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
208. Claim.procedure.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Short | Unique device identifier | ||||
Control | 0..* | ||||
Type | Reference(Device) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
210. Claim.insurance | |||||
Definition | Financial instruments for reimbursement for the health care products and services specified on the claim. | ||||
Short | Insurance information. | ||||
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. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | At least one insurer is required for a claim to be a claim. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
212. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
214. Claim.insurance.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
216. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
218. Claim.insurance.sequence | |||||
Definition | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. | ||||
Short | A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | To maintain order of the coverages. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
220. Claim.insurance.focal | |||||
Definition | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. | ||||
Short | A flag to indicate that this Coverage is to be used for adjudication of this claim when set to 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. | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | To identify which coverage in the list is being used to adjudicate this claim. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
222. Claim.insurance.identifier | |||||
Definition | The business identifier to be used when the claim is sent for adjudication against this insurance policy. | ||||
Short | Pre-assigned Claim number | ||||
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'. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
224. 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. | ||||
Short | Reference to the insurance card level information contained in the Coverage resource. | ||||
Control | 1..1 | ||||
Type | Reference(Coverage) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
226. Claim.insurance.businessArrangement | |||||
Definition | A business agreement number established between the provider and the insurer for special business processing purposes. | ||||
Short | Additional provider contract number | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
228. 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. | ||||
Short | 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. | ||||
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. | ||||
Control | 0..* | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
230. Claim.insurance.claimResponse | |||||
Definition | The result of the adjudication of the line items for the Coverage specified in this insurance. | ||||
Short | The result of the adjudication of the line items for the Coverage specified in this insurance. | ||||
Comments | Must not be specified when 'focal=true' for this insurance. | ||||
Control | 0..1 | ||||
Type | Reference(ClaimResponse) | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
232. Claim.accident | |||||
Definition | Details of an accident which resulted in injuries which required the products and services listed in the claim. | ||||
Short | Details of an accident which resulted in injuries which required the products and services listed in the claim. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
234. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
236. Claim.accident.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
238. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
240. Claim.accident.date | |||||
Definition | Date of an accident event related to the products and services contained in the claim. | ||||
Short | Date of an accident event related to the products and services contained in the claim. | ||||
Comments | The date of the accident has to precede the dates of the products and services but within a reasonable timeframe. | ||||
Control | 1..1 | ||||
Type | date | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Required for audit purposes and adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
242. 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. | ||||
Short | The type or context of the accident event for the purposes | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ActIncidentCode (extensible to http://terminology.hl7.org/ValueSet/v3-ActIncidentCode )Type of accident: work place, auto, etc. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Coverage may be dependant on the type of accident. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
244. Claim.accident.location[x] | |||||
Definition | The physical location of the accident event. | ||||
Short | Where the event occurred | ||||
Control | 0..1 | ||||
Type | Choice of: Address, Reference(Location) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required for audit purposes and determination of applicable insurance liability. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Claim.accident.location[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
246. Claim.accident.location[x]:locationAddress | |||||
Slice Name | locationAddress | ||||
Definition | The physical location of the accident event. | ||||
Short | The physical location of the accident event. | ||||
Control | 0..1 | ||||
Type | Address | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required for audit purposes and determination of applicable insurance liability. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
248. 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. | ||||
Short | 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. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The items to be processed for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
250. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
252. Claim.item.extension | |||||
Definition | An Extension | ||||
Short | Optional Extensions Element | ||||
Control | 3..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Claim.item.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
254. Claim.item.extension:tax | |||||
Slice Name | tax | ||||
Definition | The amount of Tax (VAT) levied on the line item. | ||||
Short | Extension for Tax | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Tax) (Extension Type: Money) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
256. Claim.item.extension:itemPayerShare | |||||
Slice Name | itemPayerShare | ||||
Definition | Refer to the expected payer share amount (to be paid) | ||||
Short | Extension for PayerShare | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for PayerShare) (Extension Type: Money) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
258. Claim.item.extension:itemPatientShare | |||||
Slice Name | itemPatientShare | ||||
Definition | Refer to the patient share amount | ||||
Short | Extension for Patient Share | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Patient Share) (Extension Type: Money) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
260. Claim.item.extension:itemPatientInvoice | |||||
Slice Name | itemPatientInvoice | ||||
Definition | The number of the patient invoice on which the service was billed. | ||||
Short | Extension for Patient Invoice | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Patient Invoice) (Extension Type: Identifier) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
262. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
264. Claim.item.sequence | |||||
Definition | A number to uniquely identify item entries. | ||||
Short | A number to uniquely identify item entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
266. Claim.item.careTeamSequence | |||||
Definition | CareTeam members related to this service or product. | ||||
Short | CareTeam members related to this service or product. | ||||
Control | 1..* | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Need to identify the individuals and their roles in the provision of the product or service. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
268. Claim.item.diagnosisSequence | |||||
Definition | Diagnosis applicable for this service or product. | ||||
Short | Diagnosis applicable for this service or product. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Need to related the product or service to the associated diagnoses. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
270. Claim.item.procedureSequence | |||||
Definition | Procedures applicable for this service or product. | ||||
Short | Applicable procedures | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Need to provide any listed specific procedures to support the product or service being claimed. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
272. Claim.item.informationSequence | |||||
Definition | Exceptions, special conditions and supporting information applicable for this service or product. | ||||
Short | Exceptions, special conditions and supporting information applicable for this service or product. | ||||
Control | 0..* | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Need to reference the supporting information items that relate directly to this product or service. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
274. Claim.item.revenue | |||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Short | Revenue or cost center code | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleRevenueCenterCodes (example to http://hl7.org/fhir/ValueSet/ex-revenue-center )Codes for the revenue or cost centers supplying the service and/or products. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
276. Claim.item.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Short | Benefit classification | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitCategoryCodes (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory )Benefit categories such as: oral-basic, major, glasses. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
278. 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. | ||||
Short | 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. | ||||
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'. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug Code, Bill Code, Service Code | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
280. Claim.item.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short | Product or service billing modifiers | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes (example to http://hl7.org/fhir/ValueSet/claim-modifiers )Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
282. Claim.item.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Short | Program the product or service is provided under | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes (example to http://hl7.org/fhir/ValueSet/ex-program-code )Program specific reason codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
284. Claim.item.serviced[x] | |||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Short | Date or dates of service or product delivery | ||||
Control | 0..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Claim.item.serviced[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
286. Claim.item.serviced[x]:servicedDate | |||||
Slice Name | servicedDate | ||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Short | The date or dates when the service or product was supplied, performed or completed. | ||||
Control | 0..1 | ||||
Type | date | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
288. Claim.item.serviced[x]:servicedPeriod | |||||
Slice Name | servicedPeriod | ||||
Definition | The date or dates when the service or product was supplied, performed or completed. | ||||
Short | The period when the service or product was supplied, performed or completed. | ||||
Control | 0..1 | ||||
Type | Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed to determine whether the service or product was provided during the term of the insurance coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
290. Claim.item.location[x] | |||||
Definition | Where the product or service was provided. | ||||
Short | Place of service or where product was supplied | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleServicePlaceCodes (example to http://hl7.org/fhir/ValueSet/service-place )Place of service: pharmacy, school, prison, etc. | ||||
Type | Choice of: CodeableConcept, Address, Reference(Location) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
292. Claim.item.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Short | The number of repetitions of a service or product. | ||||
Control | 1..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
294. 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. | ||||
Short | 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. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
296. 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. | ||||
Short | A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
298. Claim.item.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
300. Claim.item.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Short | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
302. Claim.item.bodySite | |||||
Definition | Physical service site on the patient (limb, tooth, etc.). | ||||
Short | Physical service site on the patient (limb, tooth, etc.). | ||||
Comments | For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed. | ||||
Control | 0..1 | ||||
Binding | For example codes, see OralSiteCodes (example to http://hl7.org/fhir/ValueSet/tooth )The code for the teeth, quadrant, sextant and arch. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
304. Claim.item.subSite | |||||
Definition | A region or surface of the bodySite, e.g. limb region or tooth surface(s). | ||||
Short | A region or surface of the bodySite, e.g. limb region or tooth surface(s). | ||||
Control | 0..1 | ||||
Binding | For example codes, see SurfaceCodes (example to http://hl7.org/fhir/ValueSet/surface )The code for the tooth surface and surface combinations. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows insurer to validate specific procedures. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
306. Claim.item.encounter | |||||
Definition | The Encounters during which this Claim was created or to which the creation of this record is tightly associated. | ||||
Short | Encounters related to this billed item | ||||
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. | ||||
Control | 0..* | ||||
Type | Reference(Encounter) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Used in some jurisdictions to link clinical events to claim items. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
308. 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. | ||||
Short | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The items to be processed for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
310. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
312. Claim.item.detail.extension | |||||
Definition | An Extension | ||||
Short | Optional Extensions Element | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Claim.item.detail.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
314. Claim.item.detail.extension:tax | |||||
Slice Name | tax | ||||
Definition | The amount of Tax (VAT) levied on the line item. | ||||
Short | Extension for Tax | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Tax) (Extension Type: Money) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
316. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
318. Claim.item.detail.sequence | |||||
Definition | A number to uniquely identify item entries. | ||||
Short | A number to uniquely identify item entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
320. Claim.item.detail.revenue | |||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Short | Revenue or cost center code | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleRevenueCenterCodes (example to http://hl7.org/fhir/ValueSet/ex-revenue-center )Codes for the revenue or cost centers supplying the service and/or products. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
322. Claim.item.detail.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Short | Benefit classification | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitCategoryCodes (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory )Benefit categories such as: oral-basic, major, glasses. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
324. 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. | ||||
Short | 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. | ||||
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'. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Necessary to state what was provided or done. | ||||
Alternate Names | Drug Code, Bill Code, Service Code | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
326. Claim.item.detail.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short | Service/Product billing modifiers | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes (example to http://hl7.org/fhir/ValueSet/claim-modifiers )Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
328. Claim.item.detail.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Short | Program the product or service is provided under | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes (example to http://hl7.org/fhir/ValueSet/ex-program-code )Program specific reason codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
330. Claim.item.detail.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Short | The number of repetitions of a service or product. | ||||
Control | 1..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
332. 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. | ||||
Short | 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. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
334. 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. | ||||
Short | Price scaling factor | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
336. Claim.item.detail.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
338. Claim.item.detail.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Short | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
340. 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. | ||||
Short | A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The items to be processed for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
342. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
344. Claim.item.detail.subDetail.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Claim.item.detail.subDetail.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
346. Claim.item.detail.subDetail.extension:tax | |||||
Slice Name | tax | ||||
Definition | The amount of Tax (VAT) levied on the line item. | ||||
Short | Extension for Tax | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension for Tax) (Extension Type: Money) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
348. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
350. Claim.item.detail.subDetail.sequence | |||||
Definition | A number to uniquely identify item entries. | ||||
Short | A number to uniquely identify item entries. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
352. Claim.item.detail.subDetail.revenue | |||||
Definition | The type of revenue or cost center providing the product and/or service. | ||||
Short | Revenue or cost center code | ||||
Control | 0..1 | ||||
Binding | For example codes, see ExampleRevenueCenterCodes (example to http://hl7.org/fhir/ValueSet/ex-revenue-center )Codes for the revenue or cost centers supplying the service and/or products. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed in the processing of institutional claims. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
354. Claim.item.detail.subDetail.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Short | Benefit classification | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Control | 0..1 | ||||
Binding | For example codes, see BenefitCategoryCodes (example to http://hl7.org/fhir/ValueSet/ex-benefitcategory )Benefit categories such as: oral-basic, major, glasses. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
356. 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. | ||||
Short | 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. | ||||
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'. | ||||
Control | 1..1 | ||||
Binding | For example codes, see USCLSCodes (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Necessary to state what was provided or done. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
358. Claim.item.detail.subDetail.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short | Service/Product billing modifiers | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes (example to http://hl7.org/fhir/ValueSet/claim-modifiers )Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To support inclusion of the item for adjudication or to charge an elevated fee. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
360. Claim.item.detail.subDetail.programCode | |||||
Definition | Identifies the program under which this may be recovered. | ||||
Short | Program the product or service is provided under | ||||
Comments | For example: Neonatal program, child dental program or drug users recovery program. | ||||
Control | 0..* | ||||
Binding | For example codes, see ExampleProgramReasonCodes (example to http://hl7.org/fhir/ValueSet/ex-program-code )Program specific reason codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Commonly used in in the identification of publicly provided program focused on population segments or disease classifications. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
362. Claim.item.detail.subDetail.quantity | |||||
Definition | The number of repetitions of a service or product. | ||||
Short | The number of repetitions of a service or product. | ||||
Control | 1..1 | ||||
Type | Quantity(SimpleQuantity) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required when the product or service code does not convey the quantity provided. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
364. 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. | ||||
Short | 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. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The amount charged to the patient by the provider for a single unit. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
366. 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. | ||||
Short | Price scaling factor | ||||
Comments | To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10). | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
368. Claim.item.detail.subDetail.net | |||||
Definition | The quantity times the unit price for an additional service or product or charge. | ||||
Short | The quantity times the unit price for a service or product or charge times the factor plus the Tax. | ||||
Comments | For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Provides the total amount claimed for the group (if a grouper) or the line item. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
370. Claim.item.detail.subDetail.udi | |||||
Definition | Unique Device Identifiers associated with this line item. | ||||
Short | Unique Device Identifiers associated with this line item. | ||||
Control | 0..* | ||||
Type | Reference(Device) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The UDI code allows the insurer to obtain device level information on the product supplied. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
372. Claim.total | |||||
Definition | The total value of the all the items in the claim. | ||||
Short | The total value of all the items in the claim. | ||||
Control | 1..1 | ||||
Type | Money | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Used for control total purposes. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |