Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ClaimResponse | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_ClaimResponse_R4 | ||
This cross-version profile allows R5 ClaimResponse content to be represented via FHIR R4 ClaimResponse resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ClaimResponse(4.0.1) | Response to a claim predetermination or preauthorization | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.traceNumber Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Result of the adjudication (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.decision Binding: R5ClaimDecisionForR4 (0.1.0) (example): The overall result of the claim adjudication. Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: Event information (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.event Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) | R5: Encounters associated with the listed treatments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.encounter Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Package billing code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.diagnosisRelatedGroup Binding: ExampleDiagnosisRelatedGroupCodes (example) Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. |
![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
![]() ![]() |
Σ | 1..1 | dateTime | Response creation date |
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement |
![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClaimResponse.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| ClaimResponse.outcome | Base | required | Claim Processing Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ClaimResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ClaimResponse | 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 | error | ClaimResponse | 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 | error | ClaimResponse | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ClaimResponse | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ClaimResponse.implicitRules, ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension, ClaimResponse.status, ClaimResponse.type, ClaimResponse.use, ClaimResponse.patient, ClaimResponse.created, ClaimResponse.insurer, ClaimResponse.outcome | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ClaimResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ClaimResponse(4.0.1) | Response to a claim predetermination or preauthorization | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Result of the adjudication (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.decision Binding: R5ClaimDecisionForR4 (0.1.0) (example): The overall result of the claim adjudication. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: Event information (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.event Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) | R5: Encounters associated with the listed treatments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.encounter Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Package billing code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.diagnosisRelatedGroup Binding: ExampleDiagnosisRelatedGroupCodes (example) Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
0..* | Identifier | Business Identifier for a claim response | |||||
![]() ![]() |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. | ||||
![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services | ||||
![]() ![]() |
Σ | 1..1 | dateTime | Response creation date | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement | ||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | |||||
![]() ![]() |
Σ | 0..1 | Reference(Claim) | Id of resource triggering adjudication | ||||
![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
![]() ![]() |
0..1 | string | Disposition Message | |||||
![]() ![]() |
0..1 | string | Preauthorization reference | |||||
![]() ![]() |
0..1 | Period | Preauthorization reference effective period | |||||
![]() ![]() |
0..1 | CodeableConcept | Party to be paid any benefits payable Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
![]() ![]() |
0..* | BackboneElement | Adjudication for claim line items | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | positiveInt | Claim item instance identifier | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() |
1..* | BackboneElement | Adjudication details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): The adjudication reason codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Monetary amount | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | R5: quantity additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.adjudication.quantity Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Primitive value for decimal | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Adjudication for claim details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.detail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Detail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Claim detail instance identifier | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Adjudication for claim sub-details | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.detail.subDetail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Subdetail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Claim sub-detail instance identifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Subdetail level adjudication details | |||||
![]() ![]() |
0..* | BackboneElement | Insurer added line items | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Revenue or cost center code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.revenue Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: End of a range of codes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.productOrServiceEnd Binding: USCLSCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.SupplyRequest for use in FHIR R4(0.1.0) | SupplyRequest | Cross-version Profile for R5.VisionPrescription for use in FHIR R4(0.1.0) | VisionPrescription) | R5: Request or Referral for Service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.request Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | R5: Total tax (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.tax Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Added items adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..* | positiveInt | Item sequence number | |||||
![]() ![]() ![]() |
0..* | positiveInt | Detail sequence number | |||||
![]() ![]() ![]() |
0..* | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
![]() ![]() ![]() |
0..1 | Date or dates of service or product delivery | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Count of products or services | |||||
![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | (Complex) | R5: Location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.bodySite.site Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | R5: Sub-location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.bodySite.subSite Binding: SurfaceCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items adjudication | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Revenue or cost center code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.revenue Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: End of a range of codes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.productOrServiceEnd Binding: USCLSCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | R5: Total tax (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.tax Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Added items detail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Count of products or services | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line items | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Revenue or cost center code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.revenue Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: End of a range of codes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.productOrServiceEnd Binding: USCLSCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Money | R5: Total tax (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.tax Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Added items subdetail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Count of products or services | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() |
0..* | See adjudication (ClaimResponse) | Header-level adjudication | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Adjudication totals | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Money | Financial total for the category | ||||
![]() ![]() |
0..1 | BackboneElement | Payment Details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Partial or complete payment Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment. | |||||
![]() ![]() ![]() |
0..1 | Money | Payment adjustment for non-claim issues | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the adjustment Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes. | |||||
![]() ![]() ![]() |
0..1 | date | Expected date of payment | |||||
![]() ![]() ![]() |
1..1 | Money | Payable amount after adjustment | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifier for the payment | |||||
![]() ![]() |
0..1 | CodeableConcept | Funds reserved status Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). | |||||
![]() ![]() |
0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |||||
![]() ![]() |
0..1 | Attachment | Printed reference or actual form | |||||
![]() ![]() |
0..* | BackboneElement | Note concerning adjudication | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Note instance identifier | |||||
![]() ![]() ![]() |
0..1 | code | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Note purpose additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.processNote.type Binding: NoteType (extensible): The presentation types of notes. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() ![]() |
1..1 | string | Note explanatory text | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Language of the text Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..* | Reference(CommunicationRequest) | Request for additional information | |||||
![]() ![]() |
0..* | BackboneElement | Patient insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |||||
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |||||
![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() |
0..1 | Reference(ClaimResponse) | Adjudication results | |||||
![]() ![]() |
0..* | BackboneElement | Processing errors | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | string | R5: FHIRPath of element(s) related to issue (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.error.expression Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Item sequence number | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Detail sequence number | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Error code detailing processing issues Binding: Adjudication Error Codes (example): The adjudication error codes. | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClaimResponse.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ClaimResponse.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.subType | Base | example | Example Claim SubType Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| ClaimResponse.outcome | Base | required | Claim Processing Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.payeeType | Base | example | PayeeType | 📍4.0.1 | FHIR Std. |
| ClaimResponse.item.adjudication.category | Base | example | Adjudication Value Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.item.adjudication.reason | Base | example | Adjudication Reason Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.programCode | Base | example | Example Program Reason Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.location[x] | Base | example | Example Service Place Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.bodySite | Base | example | Oral Site Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.subSite | Base | example | Surface Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.subDetail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.subDetail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.total.category | Base | example | Adjudication Value Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.payment.type | Base | example | Example Payment Type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.payment.adjustmentReason | Base | example | Payment Adjustment Reason Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.fundsReserve | Base | example | FundsReserve | 📍4.0.1 | FHIR Std. |
| ClaimResponse.formCode | Base | example | Forms | 📍4.0.1 | FHIR Std. |
| ClaimResponse.processNote.type | Base | required | NoteType | 📍4.0.1 | FHIR Std. |
| ClaimResponse.processNote.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ClaimResponse.error.code | Base | example | AdjudicationError | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ClaimResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ClaimResponse | 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 | error | ClaimResponse | 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 | error | ClaimResponse | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ClaimResponse | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ClaimResponse.meta, ClaimResponse.implicitRules, ClaimResponse.language, ClaimResponse.text, ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension, ClaimResponse.identifier, ClaimResponse.status, ClaimResponse.type, ClaimResponse.subType, ClaimResponse.use, ClaimResponse.patient, ClaimResponse.created, ClaimResponse.insurer, ClaimResponse.requestor, ClaimResponse.request, ClaimResponse.outcome, ClaimResponse.disposition, ClaimResponse.preAuthRef, ClaimResponse.preAuthPeriod, ClaimResponse.payeeType, ClaimResponse.item, ClaimResponse.item.extension, ClaimResponse.item.extension:traceNumber, ClaimResponse.item.extension:reviewOutcome, ClaimResponse.item.modifierExtension, ClaimResponse.item.itemSequence, ClaimResponse.item.noteNumber, ClaimResponse.item.adjudication, ClaimResponse.item.adjudication.extension, ClaimResponse.item.adjudication.modifierExtension, ClaimResponse.item.adjudication.category, ClaimResponse.item.adjudication.reason, ClaimResponse.item.adjudication.amount, ClaimResponse.item.adjudication.value, ClaimResponse.item.adjudication.value.extension, ClaimResponse.item.adjudication.value.extension:quantity, ClaimResponse.item.detail, ClaimResponse.item.detail.extension, ClaimResponse.item.detail.extension:traceNumber, ClaimResponse.item.detail.extension:reviewOutcome, ClaimResponse.item.detail.modifierExtension, ClaimResponse.item.detail.detailSequence, ClaimResponse.item.detail.noteNumber, ClaimResponse.item.detail.adjudication, ClaimResponse.item.detail.subDetail, ClaimResponse.item.detail.subDetail.extension, ClaimResponse.item.detail.subDetail.extension:traceNumber, ClaimResponse.item.detail.subDetail.extension:reviewOutcome, ClaimResponse.item.detail.subDetail.modifierExtension, ClaimResponse.item.detail.subDetail.subDetailSequence, ClaimResponse.item.detail.subDetail.noteNumber, ClaimResponse.item.detail.subDetail.adjudication, ClaimResponse.addItem, ClaimResponse.addItem.extension, ClaimResponse.addItem.extension:traceNumber, ClaimResponse.addItem.extension:revenue, ClaimResponse.addItem.extension:productOrServiceEnd, ClaimResponse.addItem.extension:request, ClaimResponse.addItem.extension:tax, ClaimResponse.addItem.extension:reviewOutcome, ClaimResponse.addItem.modifierExtension, ClaimResponse.addItem.itemSequence, ClaimResponse.addItem.detailSequence, ClaimResponse.addItem.subdetailSequence, ClaimResponse.addItem.provider, ClaimResponse.addItem.productOrService, ClaimResponse.addItem.modifier, ClaimResponse.addItem.programCode, ClaimResponse.addItem.serviced[x], ClaimResponse.addItem.location[x], ClaimResponse.addItem.quantity, ClaimResponse.addItem.unitPrice, ClaimResponse.addItem.factor, ClaimResponse.addItem.net, ClaimResponse.addItem.bodySite, ClaimResponse.addItem.bodySite.extension, ClaimResponse.addItem.bodySite.extension:site, ClaimResponse.addItem.bodySite.extension:subSite, ClaimResponse.addItem.bodySite.coding, ClaimResponse.addItem.bodySite.text, ClaimResponse.addItem.subSite, ClaimResponse.addItem.noteNumber, ClaimResponse.addItem.adjudication, ClaimResponse.addItem.detail, ClaimResponse.addItem.detail.extension, ClaimResponse.addItem.detail.extension:traceNumber, ClaimResponse.addItem.detail.extension:revenue, ClaimResponse.addItem.detail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.extension:tax, ClaimResponse.addItem.detail.extension:reviewOutcome, ClaimResponse.addItem.detail.modifierExtension, ClaimResponse.addItem.detail.productOrService, ClaimResponse.addItem.detail.modifier, ClaimResponse.addItem.detail.quantity, ClaimResponse.addItem.detail.unitPrice, ClaimResponse.addItem.detail.factor, ClaimResponse.addItem.detail.net, ClaimResponse.addItem.detail.noteNumber, ClaimResponse.addItem.detail.adjudication, ClaimResponse.addItem.detail.subDetail, ClaimResponse.addItem.detail.subDetail.extension, ClaimResponse.addItem.detail.subDetail.extension:traceNumber, ClaimResponse.addItem.detail.subDetail.extension:revenue, ClaimResponse.addItem.detail.subDetail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.subDetail.extension:tax, ClaimResponse.addItem.detail.subDetail.extension:reviewOutcome, ClaimResponse.addItem.detail.subDetail.modifierExtension, ClaimResponse.addItem.detail.subDetail.productOrService, ClaimResponse.addItem.detail.subDetail.modifier, ClaimResponse.addItem.detail.subDetail.quantity, ClaimResponse.addItem.detail.subDetail.unitPrice, ClaimResponse.addItem.detail.subDetail.factor, ClaimResponse.addItem.detail.subDetail.net, ClaimResponse.addItem.detail.subDetail.noteNumber, ClaimResponse.addItem.detail.subDetail.adjudication, ClaimResponse.adjudication, ClaimResponse.total, ClaimResponse.total.extension, ClaimResponse.total.modifierExtension, ClaimResponse.total.category, ClaimResponse.total.amount, ClaimResponse.payment, ClaimResponse.payment.extension, ClaimResponse.payment.modifierExtension, ClaimResponse.payment.type, ClaimResponse.payment.adjustment, ClaimResponse.payment.adjustmentReason, ClaimResponse.payment.date, ClaimResponse.payment.amount, ClaimResponse.payment.identifier, ClaimResponse.fundsReserve, ClaimResponse.formCode, ClaimResponse.form, ClaimResponse.processNote, ClaimResponse.processNote.extension, ClaimResponse.processNote.modifierExtension, ClaimResponse.processNote.number, ClaimResponse.processNote.type, ClaimResponse.processNote.type.extension, ClaimResponse.processNote.type.extension:type, ClaimResponse.processNote.text, ClaimResponse.processNote.language, ClaimResponse.communicationRequest, ClaimResponse.insurance, ClaimResponse.insurance.extension, ClaimResponse.insurance.modifierExtension, ClaimResponse.insurance.sequence, ClaimResponse.insurance.focal, ClaimResponse.insurance.coverage, ClaimResponse.insurance.businessArrangement, ClaimResponse.insurance.claimResponse, ClaimResponse.error, ClaimResponse.error.extension, ClaimResponse.error.extension:expression, ClaimResponse.error.modifierExtension, ClaimResponse.error.itemSequence, ClaimResponse.error.detailSequence, ClaimResponse.error.subDetailSequence, ClaimResponse.error.code | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension, ClaimResponse.item.extension, ClaimResponse.item.extension:traceNumber, ClaimResponse.item.extension:reviewOutcome, ClaimResponse.item.modifierExtension, ClaimResponse.item.adjudication.extension, ClaimResponse.item.adjudication.modifierExtension, ClaimResponse.item.adjudication.value.extension, ClaimResponse.item.adjudication.value.extension:quantity, ClaimResponse.item.detail.extension, ClaimResponse.item.detail.extension:traceNumber, ClaimResponse.item.detail.extension:reviewOutcome, ClaimResponse.item.detail.modifierExtension, ClaimResponse.item.detail.subDetail.extension, ClaimResponse.item.detail.subDetail.extension:traceNumber, ClaimResponse.item.detail.subDetail.extension:reviewOutcome, ClaimResponse.item.detail.subDetail.modifierExtension, ClaimResponse.addItem.extension, ClaimResponse.addItem.extension:traceNumber, ClaimResponse.addItem.extension:revenue, ClaimResponse.addItem.extension:productOrServiceEnd, ClaimResponse.addItem.extension:request, ClaimResponse.addItem.extension:tax, ClaimResponse.addItem.extension:reviewOutcome, ClaimResponse.addItem.modifierExtension, ClaimResponse.addItem.bodySite.extension, ClaimResponse.addItem.bodySite.extension:site, ClaimResponse.addItem.bodySite.extension:subSite, ClaimResponse.addItem.detail.extension, ClaimResponse.addItem.detail.extension:traceNumber, ClaimResponse.addItem.detail.extension:revenue, ClaimResponse.addItem.detail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.extension:tax, ClaimResponse.addItem.detail.extension:reviewOutcome, ClaimResponse.addItem.detail.modifierExtension, ClaimResponse.addItem.detail.subDetail.extension, ClaimResponse.addItem.detail.subDetail.extension:traceNumber, ClaimResponse.addItem.detail.subDetail.extension:revenue, ClaimResponse.addItem.detail.subDetail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.subDetail.extension:tax, ClaimResponse.addItem.detail.subDetail.extension:reviewOutcome, ClaimResponse.addItem.detail.subDetail.modifierExtension, ClaimResponse.total.extension, ClaimResponse.total.modifierExtension, ClaimResponse.payment.extension, ClaimResponse.payment.modifierExtension, ClaimResponse.processNote.extension, ClaimResponse.processNote.modifierExtension, ClaimResponse.processNote.type.extension, ClaimResponse.processNote.type.extension:type, ClaimResponse.insurance.extension, ClaimResponse.insurance.modifierExtension, ClaimResponse.error.extension, ClaimResponse.error.extension:expression, ClaimResponse.error.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ClaimResponse
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ClaimResponse(4.0.1) | Response to a claim predetermination or preauthorization | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.traceNumber Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Result of the adjudication (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.decision Binding: R5ClaimDecisionForR4 (0.1.0) (example): The overall result of the claim adjudication. Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: Event information (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.event Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) | R5: Encounters associated with the listed treatments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.encounter Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Package billing code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.diagnosisRelatedGroup Binding: ExampleDiagnosisRelatedGroupCodes (example) Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. |
![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
![]() ![]() |
Σ | 1..1 | dateTime | Response creation date |
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement |
![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClaimResponse.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| ClaimResponse.outcome | Base | required | Claim Processing Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ClaimResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ClaimResponse | 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 | error | ClaimResponse | 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 | error | ClaimResponse | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ClaimResponse | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ClaimResponse.implicitRules, ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension, ClaimResponse.status, ClaimResponse.type, ClaimResponse.use, ClaimResponse.patient, ClaimResponse.created, ClaimResponse.insurer, ClaimResponse.outcome | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ClaimResponse
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ClaimResponse(4.0.1) | Response to a claim predetermination or preauthorization | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Result of the adjudication (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.decision Binding: R5ClaimDecisionForR4 (0.1.0) (example): The overall result of the claim adjudication. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: Event information (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.event Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) | R5: Encounters associated with the listed treatments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.encounter Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Package billing code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.diagnosisRelatedGroup Binding: ExampleDiagnosisRelatedGroupCodes (example) Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
0..* | Identifier | Business Identifier for a claim response | |||||
![]() ![]() |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. | ||||
![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services | ||||
![]() ![]() |
Σ | 1..1 | dateTime | Response creation date | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement | ||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | |||||
![]() ![]() |
Σ | 0..1 | Reference(Claim) | Id of resource triggering adjudication | ||||
![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
![]() ![]() |
0..1 | string | Disposition Message | |||||
![]() ![]() |
0..1 | string | Preauthorization reference | |||||
![]() ![]() |
0..1 | Period | Preauthorization reference effective period | |||||
![]() ![]() |
0..1 | CodeableConcept | Party to be paid any benefits payable Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
![]() ![]() |
0..* | BackboneElement | Adjudication for claim line items | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | positiveInt | Claim item instance identifier | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() |
1..* | BackboneElement | Adjudication details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): The adjudication reason codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Monetary amount | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | R5: quantity additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.adjudication.quantity Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Primitive value for decimal | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Adjudication for claim details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.detail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Detail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Claim detail instance identifier | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Adjudication for claim sub-details | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.detail.subDetail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Subdetail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Claim sub-detail instance identifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Subdetail level adjudication details | |||||
![]() ![]() |
0..* | BackboneElement | Insurer added line items | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Revenue or cost center code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.revenue Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: End of a range of codes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.productOrServiceEnd Binding: USCLSCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.SupplyRequest for use in FHIR R4(0.1.0) | SupplyRequest | Cross-version Profile for R5.VisionPrescription for use in FHIR R4(0.1.0) | VisionPrescription) | R5: Request or Referral for Service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.request Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | R5: Total tax (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.tax Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Added items adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..* | positiveInt | Item sequence number | |||||
![]() ![]() ![]() |
0..* | positiveInt | Detail sequence number | |||||
![]() ![]() ![]() |
0..* | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
![]() ![]() ![]() |
0..1 | Date or dates of service or product delivery | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Count of products or services | |||||
![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | (Complex) | R5: Location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.bodySite.site Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | R5: Sub-location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.bodySite.subSite Binding: SurfaceCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items adjudication | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Revenue or cost center code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.revenue Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: End of a range of codes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.productOrServiceEnd Binding: USCLSCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | R5: Total tax (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.tax Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Added items detail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Count of products or services | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line items | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | R5: Number for tracking (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.traceNumber Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Revenue or cost center code (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.revenue Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: End of a range of codes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.productOrServiceEnd Binding: USCLSCodes (example) Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Money | R5: Total tax (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.addItem.detail.subDetail.tax Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | R5: Added items subdetail level adjudication results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.item.reviewOutcome Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Count of products or services | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() |
0..* | See adjudication (ClaimResponse) | Header-level adjudication | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Adjudication totals | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Money | Financial total for the category | ||||
![]() ![]() |
0..1 | BackboneElement | Payment Details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Partial or complete payment Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment. | |||||
![]() ![]() ![]() |
0..1 | Money | Payment adjustment for non-claim issues | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the adjustment Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes. | |||||
![]() ![]() ![]() |
0..1 | date | Expected date of payment | |||||
![]() ![]() ![]() |
1..1 | Money | Payable amount after adjustment | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifier for the payment | |||||
![]() ![]() |
0..1 | CodeableConcept | Funds reserved status Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). | |||||
![]() ![]() |
0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |||||
![]() ![]() |
0..1 | Attachment | Printed reference or actual form | |||||
![]() ![]() |
0..* | BackboneElement | Note concerning adjudication | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Note instance identifier | |||||
![]() ![]() ![]() |
0..1 | code | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | R5: Note purpose additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.processNote.type Binding: NoteType (extensible): The presentation types of notes. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() ![]() |
1..1 | string | Note explanatory text | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Language of the text Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..* | Reference(CommunicationRequest) | Request for additional information | |||||
![]() ![]() |
0..* | BackboneElement | Patient insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |||||
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |||||
![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() |
0..1 | Reference(ClaimResponse) | Adjudication results | |||||
![]() ![]() |
0..* | BackboneElement | Processing errors | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | string | R5: FHIRPath of element(s) related to issue (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClaimResponse.error.expression Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Item sequence number | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Detail sequence number | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Error code detailing processing issues Binding: Adjudication Error Codes (example): The adjudication error codes. | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClaimResponse.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ClaimResponse.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.subType | Base | example | Example Claim SubType Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| ClaimResponse.outcome | Base | required | Claim Processing Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.payeeType | Base | example | PayeeType | 📍4.0.1 | FHIR Std. |
| ClaimResponse.item.adjudication.category | Base | example | Adjudication Value Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.item.adjudication.reason | Base | example | Adjudication Reason Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.programCode | Base | example | Example Program Reason Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.location[x] | Base | example | Example Service Place Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.bodySite | Base | example | Oral Site Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.subSite | Base | example | Surface Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.subDetail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.addItem.detail.subDetail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.total.category | Base | example | Adjudication Value Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.payment.type | Base | example | Example Payment Type Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.payment.adjustmentReason | Base | example | Payment Adjustment Reason Codes | 📍4.0.1 | FHIR Std. |
| ClaimResponse.fundsReserve | Base | example | FundsReserve | 📍4.0.1 | FHIR Std. |
| ClaimResponse.formCode | Base | example | Forms | 📍4.0.1 | FHIR Std. |
| ClaimResponse.processNote.type | Base | required | NoteType | 📍4.0.1 | FHIR Std. |
| ClaimResponse.processNote.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ClaimResponse.error.code | Base | example | AdjudicationError | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ClaimResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ClaimResponse | 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 | error | ClaimResponse | 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 | error | ClaimResponse | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ClaimResponse | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ClaimResponse.meta, ClaimResponse.implicitRules, ClaimResponse.language, ClaimResponse.text, ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension, ClaimResponse.identifier, ClaimResponse.status, ClaimResponse.type, ClaimResponse.subType, ClaimResponse.use, ClaimResponse.patient, ClaimResponse.created, ClaimResponse.insurer, ClaimResponse.requestor, ClaimResponse.request, ClaimResponse.outcome, ClaimResponse.disposition, ClaimResponse.preAuthRef, ClaimResponse.preAuthPeriod, ClaimResponse.payeeType, ClaimResponse.item, ClaimResponse.item.extension, ClaimResponse.item.extension:traceNumber, ClaimResponse.item.extension:reviewOutcome, ClaimResponse.item.modifierExtension, ClaimResponse.item.itemSequence, ClaimResponse.item.noteNumber, ClaimResponse.item.adjudication, ClaimResponse.item.adjudication.extension, ClaimResponse.item.adjudication.modifierExtension, ClaimResponse.item.adjudication.category, ClaimResponse.item.adjudication.reason, ClaimResponse.item.adjudication.amount, ClaimResponse.item.adjudication.value, ClaimResponse.item.adjudication.value.extension, ClaimResponse.item.adjudication.value.extension:quantity, ClaimResponse.item.detail, ClaimResponse.item.detail.extension, ClaimResponse.item.detail.extension:traceNumber, ClaimResponse.item.detail.extension:reviewOutcome, ClaimResponse.item.detail.modifierExtension, ClaimResponse.item.detail.detailSequence, ClaimResponse.item.detail.noteNumber, ClaimResponse.item.detail.adjudication, ClaimResponse.item.detail.subDetail, ClaimResponse.item.detail.subDetail.extension, ClaimResponse.item.detail.subDetail.extension:traceNumber, ClaimResponse.item.detail.subDetail.extension:reviewOutcome, ClaimResponse.item.detail.subDetail.modifierExtension, ClaimResponse.item.detail.subDetail.subDetailSequence, ClaimResponse.item.detail.subDetail.noteNumber, ClaimResponse.item.detail.subDetail.adjudication, ClaimResponse.addItem, ClaimResponse.addItem.extension, ClaimResponse.addItem.extension:traceNumber, ClaimResponse.addItem.extension:revenue, ClaimResponse.addItem.extension:productOrServiceEnd, ClaimResponse.addItem.extension:request, ClaimResponse.addItem.extension:tax, ClaimResponse.addItem.extension:reviewOutcome, ClaimResponse.addItem.modifierExtension, ClaimResponse.addItem.itemSequence, ClaimResponse.addItem.detailSequence, ClaimResponse.addItem.subdetailSequence, ClaimResponse.addItem.provider, ClaimResponse.addItem.productOrService, ClaimResponse.addItem.modifier, ClaimResponse.addItem.programCode, ClaimResponse.addItem.serviced[x], ClaimResponse.addItem.location[x], ClaimResponse.addItem.quantity, ClaimResponse.addItem.unitPrice, ClaimResponse.addItem.factor, ClaimResponse.addItem.net, ClaimResponse.addItem.bodySite, ClaimResponse.addItem.bodySite.extension, ClaimResponse.addItem.bodySite.extension:site, ClaimResponse.addItem.bodySite.extension:subSite, ClaimResponse.addItem.bodySite.coding, ClaimResponse.addItem.bodySite.text, ClaimResponse.addItem.subSite, ClaimResponse.addItem.noteNumber, ClaimResponse.addItem.adjudication, ClaimResponse.addItem.detail, ClaimResponse.addItem.detail.extension, ClaimResponse.addItem.detail.extension:traceNumber, ClaimResponse.addItem.detail.extension:revenue, ClaimResponse.addItem.detail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.extension:tax, ClaimResponse.addItem.detail.extension:reviewOutcome, ClaimResponse.addItem.detail.modifierExtension, ClaimResponse.addItem.detail.productOrService, ClaimResponse.addItem.detail.modifier, ClaimResponse.addItem.detail.quantity, ClaimResponse.addItem.detail.unitPrice, ClaimResponse.addItem.detail.factor, ClaimResponse.addItem.detail.net, ClaimResponse.addItem.detail.noteNumber, ClaimResponse.addItem.detail.adjudication, ClaimResponse.addItem.detail.subDetail, ClaimResponse.addItem.detail.subDetail.extension, ClaimResponse.addItem.detail.subDetail.extension:traceNumber, ClaimResponse.addItem.detail.subDetail.extension:revenue, ClaimResponse.addItem.detail.subDetail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.subDetail.extension:tax, ClaimResponse.addItem.detail.subDetail.extension:reviewOutcome, ClaimResponse.addItem.detail.subDetail.modifierExtension, ClaimResponse.addItem.detail.subDetail.productOrService, ClaimResponse.addItem.detail.subDetail.modifier, ClaimResponse.addItem.detail.subDetail.quantity, ClaimResponse.addItem.detail.subDetail.unitPrice, ClaimResponse.addItem.detail.subDetail.factor, ClaimResponse.addItem.detail.subDetail.net, ClaimResponse.addItem.detail.subDetail.noteNumber, ClaimResponse.addItem.detail.subDetail.adjudication, ClaimResponse.adjudication, ClaimResponse.total, ClaimResponse.total.extension, ClaimResponse.total.modifierExtension, ClaimResponse.total.category, ClaimResponse.total.amount, ClaimResponse.payment, ClaimResponse.payment.extension, ClaimResponse.payment.modifierExtension, ClaimResponse.payment.type, ClaimResponse.payment.adjustment, ClaimResponse.payment.adjustmentReason, ClaimResponse.payment.date, ClaimResponse.payment.amount, ClaimResponse.payment.identifier, ClaimResponse.fundsReserve, ClaimResponse.formCode, ClaimResponse.form, ClaimResponse.processNote, ClaimResponse.processNote.extension, ClaimResponse.processNote.modifierExtension, ClaimResponse.processNote.number, ClaimResponse.processNote.type, ClaimResponse.processNote.type.extension, ClaimResponse.processNote.type.extension:type, ClaimResponse.processNote.text, ClaimResponse.processNote.language, ClaimResponse.communicationRequest, ClaimResponse.insurance, ClaimResponse.insurance.extension, ClaimResponse.insurance.modifierExtension, ClaimResponse.insurance.sequence, ClaimResponse.insurance.focal, ClaimResponse.insurance.coverage, ClaimResponse.insurance.businessArrangement, ClaimResponse.insurance.claimResponse, ClaimResponse.error, ClaimResponse.error.extension, ClaimResponse.error.extension:expression, ClaimResponse.error.modifierExtension, ClaimResponse.error.itemSequence, ClaimResponse.error.detailSequence, ClaimResponse.error.subDetailSequence, ClaimResponse.error.code | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ClaimResponse.extension, ClaimResponse.extension:traceNumber, ClaimResponse.extension:decision, ClaimResponse.extension:event, ClaimResponse.extension:encounter, ClaimResponse.extension:diagnosisRelatedGroup, ClaimResponse.modifierExtension, ClaimResponse.item.extension, ClaimResponse.item.extension:traceNumber, ClaimResponse.item.extension:reviewOutcome, ClaimResponse.item.modifierExtension, ClaimResponse.item.adjudication.extension, ClaimResponse.item.adjudication.modifierExtension, ClaimResponse.item.adjudication.value.extension, ClaimResponse.item.adjudication.value.extension:quantity, ClaimResponse.item.detail.extension, ClaimResponse.item.detail.extension:traceNumber, ClaimResponse.item.detail.extension:reviewOutcome, ClaimResponse.item.detail.modifierExtension, ClaimResponse.item.detail.subDetail.extension, ClaimResponse.item.detail.subDetail.extension:traceNumber, ClaimResponse.item.detail.subDetail.extension:reviewOutcome, ClaimResponse.item.detail.subDetail.modifierExtension, ClaimResponse.addItem.extension, ClaimResponse.addItem.extension:traceNumber, ClaimResponse.addItem.extension:revenue, ClaimResponse.addItem.extension:productOrServiceEnd, ClaimResponse.addItem.extension:request, ClaimResponse.addItem.extension:tax, ClaimResponse.addItem.extension:reviewOutcome, ClaimResponse.addItem.modifierExtension, ClaimResponse.addItem.bodySite.extension, ClaimResponse.addItem.bodySite.extension:site, ClaimResponse.addItem.bodySite.extension:subSite, ClaimResponse.addItem.detail.extension, ClaimResponse.addItem.detail.extension:traceNumber, ClaimResponse.addItem.detail.extension:revenue, ClaimResponse.addItem.detail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.extension:tax, ClaimResponse.addItem.detail.extension:reviewOutcome, ClaimResponse.addItem.detail.modifierExtension, ClaimResponse.addItem.detail.subDetail.extension, ClaimResponse.addItem.detail.subDetail.extension:traceNumber, ClaimResponse.addItem.detail.subDetail.extension:revenue, ClaimResponse.addItem.detail.subDetail.extension:productOrServiceEnd, ClaimResponse.addItem.detail.subDetail.extension:tax, ClaimResponse.addItem.detail.subDetail.extension:reviewOutcome, ClaimResponse.addItem.detail.subDetail.modifierExtension, ClaimResponse.total.extension, ClaimResponse.total.modifierExtension, ClaimResponse.payment.extension, ClaimResponse.payment.modifierExtension, ClaimResponse.processNote.extension, ClaimResponse.processNote.modifierExtension, ClaimResponse.processNote.type.extension, ClaimResponse.processNote.type.extension:type, ClaimResponse.insurance.extension, ClaimResponse.insurance.modifierExtension, ClaimResponse.error.extension, ClaimResponse.error.extension:expression, ClaimResponse.error.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ClaimResponse
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron