QI-Core Implementation Guide
5.0.0 - STU5 United States of America flag

This page is part of the Quality Improvement Core Framework (v5.0.0: STU5 (v5.0.0)) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore ClaimResponse

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-claimresponse Version: 5.0.0
Draft as of 2022-04-20 Computable Name: QICoreClaimResponse

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The QI Core ClaimResponse profile is used to provide the results of the adjudication and/or authorization of a set of healthcare-related products and services for a patient against the patient’s insurance coverages, or to respond with what the adjudication would be for a supplied set of products or services should they be actually supplied to the patient.It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the ClaimResponse resource when using this profile

Usage

See the patterns page for implementation and usage patterns.

Examples

Preauthorization Vision ClaimResponse Example

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ClaimResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type SΣ1..1CodeableConceptMore granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.

... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Fixed Value: preauthorization
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(QICore Organization)Party responsible for reimbursement
... requestor S0..1Reference(QICore Practitioner | QICore Organization | QICore PractitionerRole)Party responsible for the claim
... request SΣ0..1Reference(QICore Claim)Id of resource triggering adjudication
... item S0..*BackboneElementAdjudication for claim line items
.... adjudication S1..*BackboneElementAdjudication details
..... category S1..1CodeableConceptThis code is fixed to 'submitted' to indicate that the adjudication result is on what was submitted.
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/adjudication
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submitted
..... amount S0..1MoneyMonetary amount
.... detail
..... detailSequence S1..1positiveIntClaim detail instance identifier

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Fixed Value: preauthorization
... patient SΣ1..1Reference(QICore Patient)The recipient of the products and services
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(QICore Organization)Party responsible for reimbursement
... requestor S0..1Reference(QICore Practitioner | QICore Organization | QICore PractitionerRole)Party responsible for the claim
... request SΣ0..1Reference(QICore Claim)Id of resource triggering adjudication
... outcome Σ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... item S0..*BackboneElementAdjudication for claim line items
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 1..1positiveIntClaim item instance identifier
.... adjudication S1..*BackboneElementAdjudication details
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category S1..1CodeableConceptThis code is fixed to 'submitted' to indicate that the adjudication result is on what was submitted.
Binding: AdjudicationValueCodes (example): The adjudication codes.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/adjudication
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submitted
..... amount S0..1MoneyMonetary amount
.... detail 0..*BackboneElementAdjudication for claim details
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... detailSequence S1..1positiveIntClaim detail instance identifier
..... adjudication 1..*See adjudication (ClaimResponse)Detail level adjudication details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization
ClaimResponse.outcomerequiredClaimProcessingCodes
ClaimResponse.item.adjudication.categoryexamplePattern: submitted

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier for a claim response
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type SΣ1..1CodeableConceptMore granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.

... subType 0..1CodeableConceptMore granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Fixed Value: preauthorization
... patient SΣ1..1Reference(QICore Patient)The recipient of the products and services
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(QICore Organization)Party responsible for reimbursement
... requestor S0..1Reference(QICore Practitioner | QICore Organization | QICore PractitionerRole)Party responsible for the claim
... request SΣ0..1Reference(QICore Claim)Id of resource triggering adjudication
... outcome Σ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition 0..1stringDisposition Message
... preAuthRef 0..1stringPreauthorization reference
... preAuthPeriod 0..1PeriodPreauthorization reference effective period
... payeeType 0..1CodeableConceptParty to be paid any benefits payable
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

... item S0..*BackboneElementAdjudication for claim line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 1..1positiveIntClaim item instance identifier
.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication S1..*BackboneElementAdjudication details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category S1..1CodeableConceptThis code is fixed to 'submitted' to indicate that the adjudication result is on what was submitted.
Binding: AdjudicationValueCodes (example): The adjudication codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/adjudication
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submitted
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... reason 0..1CodeableConceptExplanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.

..... amount S0..1MoneyMonetary amount
..... value 0..1decimalNon-monetary value
.... detail 0..*BackboneElementAdjudication for claim details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... detailSequence S1..1positiveIntClaim detail instance identifier
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Detail level adjudication details
..... subDetail 0..*BackboneElementAdjudication for claim sub-details
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1positiveIntClaim sub-detail instance identifier
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ClaimResponse)Subdetail level adjudication details
... addItem 0..*BackboneElementInsurer added line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..*positiveIntItem sequence number
.... detailSequence 0..*positiveIntDetail sequence number
.... subdetailSequence 0..*positiveIntSubdetail sequence number
.... provider 0..*Reference(Practitioner | PractitionerRole | Organization)Authorized providers
.... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..*CodeableConceptService/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.


.... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] 0..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 1..*See adjudication (ClaimResponse)Added items adjudication
.... detail 0..*BackboneElementInsurer added line details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/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.


..... quantity 0..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
..... subDetail 0..*BackboneElementInsurer added line items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/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.


...... quantity 0..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
... adjudication 0..*See adjudication (ClaimResponse)Header-level adjudication
... total Σ0..*BackboneElementAdjudication totals
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ1..1MoneyFinancial total for the category
... payment 0..1BackboneElementPayment Details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptPartial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.

.... adjustment 0..1MoneyPayment adjustment for non-claim issues
.... adjustmentReason 0..1CodeableConceptExplanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.

.... date 0..1dateExpected date of payment
.... amount 1..1MoneyPayable amount after adjustment
.... identifier 0..1IdentifierBusiness identifier for the payment
... fundsReserve 0..1CodeableConceptFunds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... formCode 0..1CodeableConceptPrinted form identifier
Binding: Form Codes (example): The forms codes.

... form 0..1AttachmentPrinted reference or actual form
... processNote 0..*BackboneElementNote concerning adjudication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... number 0..1positiveIntNote instance identifier
.... type 0..1codedisplay | print | printoper
Binding: NoteType (required): The presentation types of notes.

.... text 1..1stringNote explanatory text
.... language 0..1CodeableConceptLanguage of the text
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... communicationRequest 0..*Reference(CommunicationRequest)Request for additional information
... insurance 0..*BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInsurance instance identifier
.... focal 1..1booleanCoverage to be used for adjudication
.... coverage 1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
.... claimResponse 0..1Reference(ClaimResponse)Adjudication results
... error 0..*BackboneElementProcessing errors
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..1positiveIntItem sequence number
.... detailSequence 0..1positiveIntDetail sequence number
.... subDetailSequence 0..1positiveIntSubdetail sequence number
.... code 1..1CodeableConceptError code detailing processing issues
Binding: Adjudication Error Codes (example): The adjudication error codes.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClaimResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.subTypeexampleExampleClaimSubTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization
ClaimResponse.outcomerequiredClaimProcessingCodes
ClaimResponse.payeeTypeexampleClaim Payee Type Codes
ClaimResponse.item.adjudication.categoryexamplePattern: submitted
ClaimResponse.item.adjudication.reasonexampleAdjudicationReasonCodes
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.modifierexampleModifierTypeCodes
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
ClaimResponse.addItem.subSiteexampleSurfaceCodes
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
ClaimResponse.total.categoryexampleAdjudicationValueCodes
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
ClaimResponse.fundsReserveexampleFunds Reservation Codes
ClaimResponse.formCodeexampleForm Codes
ClaimResponse.processNote.typerequiredNoteType
ClaimResponse.processNote.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.error.codeexampleAdjudication Error Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from ClaimResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type SΣ1..1CodeableConceptMore granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.

... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Fixed Value: preauthorization
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(QICore Organization)Party responsible for reimbursement
... requestor S0..1Reference(QICore Practitioner | QICore Organization | QICore PractitionerRole)Party responsible for the claim
... request SΣ0..1Reference(QICore Claim)Id of resource triggering adjudication
... item S0..*BackboneElementAdjudication for claim line items
.... adjudication S1..*BackboneElementAdjudication details
..... category S1..1CodeableConceptThis code is fixed to 'submitted' to indicate that the adjudication result is on what was submitted.
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/adjudication
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submitted
..... amount S0..1MoneyMonetary amount
.... detail
..... detailSequence S1..1positiveIntClaim detail instance identifier

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Fixed Value: preauthorization
... patient SΣ1..1Reference(QICore Patient)The recipient of the products and services
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(QICore Organization)Party responsible for reimbursement
... requestor S0..1Reference(QICore Practitioner | QICore Organization | QICore PractitionerRole)Party responsible for the claim
... request SΣ0..1Reference(QICore Claim)Id of resource triggering adjudication
... outcome Σ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... item S0..*BackboneElementAdjudication for claim line items
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 1..1positiveIntClaim item instance identifier
.... adjudication S1..*BackboneElementAdjudication details
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category S1..1CodeableConceptThis code is fixed to 'submitted' to indicate that the adjudication result is on what was submitted.
Binding: AdjudicationValueCodes (example): The adjudication codes.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/adjudication
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submitted
..... amount S0..1MoneyMonetary amount
.... detail 0..*BackboneElementAdjudication for claim details
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... detailSequence S1..1positiveIntClaim detail instance identifier
..... adjudication 1..*See adjudication (ClaimResponse)Detail level adjudication details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization
ClaimResponse.outcomerequiredClaimProcessingCodes
ClaimResponse.item.adjudication.categoryexamplePattern: submitted

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier for a claim response
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type SΣ1..1CodeableConceptMore granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.

... subType 0..1CodeableConceptMore granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Fixed Value: preauthorization
... patient SΣ1..1Reference(QICore Patient)The recipient of the products and services
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(QICore Organization)Party responsible for reimbursement
... requestor S0..1Reference(QICore Practitioner | QICore Organization | QICore PractitionerRole)Party responsible for the claim
... request SΣ0..1Reference(QICore Claim)Id of resource triggering adjudication
... outcome Σ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition 0..1stringDisposition Message
... preAuthRef 0..1stringPreauthorization reference
... preAuthPeriod 0..1PeriodPreauthorization reference effective period
... payeeType 0..1CodeableConceptParty to be paid any benefits payable
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

... item S0..*BackboneElementAdjudication for claim line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 1..1positiveIntClaim item instance identifier
.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication S1..*BackboneElementAdjudication details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category S1..1CodeableConceptThis code is fixed to 'submitted' to indicate that the adjudication result is on what was submitted.
Binding: AdjudicationValueCodes (example): The adjudication codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/adjudication
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submitted
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... reason 0..1CodeableConceptExplanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.

..... amount S0..1MoneyMonetary amount
..... value 0..1decimalNon-monetary value
.... detail 0..*BackboneElementAdjudication for claim details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... detailSequence S1..1positiveIntClaim detail instance identifier
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Detail level adjudication details
..... subDetail 0..*BackboneElementAdjudication for claim sub-details
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1positiveIntClaim sub-detail instance identifier
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ClaimResponse)Subdetail level adjudication details
... addItem 0..*BackboneElementInsurer added line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..*positiveIntItem sequence number
.... detailSequence 0..*positiveIntDetail sequence number
.... subdetailSequence 0..*positiveIntSubdetail sequence number
.... provider 0..*Reference(Practitioner | PractitionerRole | Organization)Authorized providers
.... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..*CodeableConceptService/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.


.... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] 0..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 1..*See adjudication (ClaimResponse)Added items adjudication
.... detail 0..*BackboneElementInsurer added line details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/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.


..... quantity 0..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
..... subDetail 0..*BackboneElementInsurer added line items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/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.


...... quantity 0..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
... adjudication 0..*See adjudication (ClaimResponse)Header-level adjudication
... total Σ0..*BackboneElementAdjudication totals
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ1..1MoneyFinancial total for the category
... payment 0..1BackboneElementPayment Details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptPartial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.

.... adjustment 0..1MoneyPayment adjustment for non-claim issues
.... adjustmentReason 0..1CodeableConceptExplanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.

.... date 0..1dateExpected date of payment
.... amount 1..1MoneyPayable amount after adjustment
.... identifier 0..1IdentifierBusiness identifier for the payment
... fundsReserve 0..1CodeableConceptFunds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... formCode 0..1CodeableConceptPrinted form identifier
Binding: Form Codes (example): The forms codes.

... form 0..1AttachmentPrinted reference or actual form
... processNote 0..*BackboneElementNote concerning adjudication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... number 0..1positiveIntNote instance identifier
.... type 0..1codedisplay | print | printoper
Binding: NoteType (required): The presentation types of notes.

.... text 1..1stringNote explanatory text
.... language 0..1CodeableConceptLanguage of the text
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... communicationRequest 0..*Reference(CommunicationRequest)Request for additional information
... insurance 0..*BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInsurance instance identifier
.... focal 1..1booleanCoverage to be used for adjudication
.... coverage 1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
.... claimResponse 0..1Reference(ClaimResponse)Adjudication results
... error 0..*BackboneElementProcessing errors
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..1positiveIntItem sequence number
.... detailSequence 0..1positiveIntDetail sequence number
.... subDetailSequence 0..1positiveIntSubdetail sequence number
.... code 1..1CodeableConceptError code detailing processing issues
Binding: Adjudication Error Codes (example): The adjudication error codes.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClaimResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.subTypeexampleExampleClaimSubTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization
ClaimResponse.outcomerequiredClaimProcessingCodes
ClaimResponse.payeeTypeexampleClaim Payee Type Codes
ClaimResponse.item.adjudication.categoryexamplePattern: submitted
ClaimResponse.item.adjudication.reasonexampleAdjudicationReasonCodes
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.modifierexampleModifierTypeCodes
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
ClaimResponse.addItem.subSiteexampleSurfaceCodes
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
ClaimResponse.total.categoryexampleAdjudicationValueCodes
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
ClaimResponse.fundsReserveexampleFunds Reservation Codes
ClaimResponse.formCodeexampleForm Codes
ClaimResponse.processNote.typerequiredNoteType
ClaimResponse.processNote.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.error.codeexampleAdjudication Error Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron