Consumer Real-Time Pharmacy Benefit Check FHIR IG
2.0.0 - CI Build United States of America flag

Consumer Real-Time Pharmacy Benefit Check FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-rtpbc/ and changes regularly. See the Directory of published versions

Resource Profile: RtpbcResponseClaimResponse - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 4

Definitions for the rtpbc-response-claimresponse resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. ClaimResponse
Definition

This resource provides the adjudication details from the processing of a Claim resource.

ShortResponse to a claim predetermination or preauthorization
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesRemittance Advice
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ClaimResponse.id
Definition

Unique ClaimResponse Resource Identifier assigned by the responding payer/PBM


The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortUnique ClaimResponse Resource IdentifierLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeidstring
Is Modifierfalse
Must Supporttrue
Summarytrue
LabelUnique ClaimResponse Resource Identifier
4. ClaimResponse.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ClaimResponse.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. ClaimResponse.identifier
Definition

A unique identifier assigned to this claim response.

ShortRTPBC Response IdentifierBusiness Identifier for a claim response
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Allows claim responses to be distinguished and referenced.

LabelRTPBC Response Identifier
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ClaimResponse.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ClaimResponse.identifier.value
Definition

An identifier for each RTPBC response that is assigned by and unique to the reponder


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortUnique RTPBC response IDThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
LabelUnique RTPBC response ID
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ClaimResponse.status
Definition

The status of this response (active)


The status of the resource instance.

ShortResponse statusactive | cancelled | draft | entered-in-error
Comments

Value is always 'active'


This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

LabelResponse status
Fixed Valueactive
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ClaimResponse.type
Definition

The type of service for which pricing and coverage predetermination is being requested


A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

ShortRequested Service TypeMore granular claim type
Comments

Value is always 'pharmacy'


This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type
(extensible to http://hl7.org/fhir/ValueSet/claim-type)

The type or discipline-style of the claim.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Some jurisdictions need a finer grained claim type for routing and adjudication.

LabelRequested Service Type
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. ClaimResponse.type.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control10..1*
TypeCoding
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ClaimResponse.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/claim-type
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ClaimResponse.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control10..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Valuepharmacy
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ClaimResponse.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Fixed ValuePharmacy
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ClaimResponse.use
Definition

The mode of processing being performed by the payer/PBM


A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

ShortProcessing Modeclaim | preauthorization | predetermination
Comments

Value is always 'predetermination'

Control1..1
BindingThe codes SHALL be taken from Usehttp://hl7.org/fhir/ValueSet/claim-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

Claim, preauthorization, predetermination.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

This element is required to understand the nature of the request for adjudication.

LabelProcessing Mode
Fixed Valuepredetermination
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ClaimResponse.patient
Definition

Limited patient information required in the consumer real-time pharmacy benefit check (RTPBC) process


The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

ShortResponse Patient InformationThe recipient of the products and services
Comments

Echo the Patient resource received in the request

Control1..1
TypeReference(RTPBC Patient, Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

LabelResponse Patient Information
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ClaimResponse.created
Definition

The date this resource was created.

ShortResponse creation date
Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ClaimResponse.insurer
Definition

The party responsible for authorization, adjudication and reimbursement.

ShortParty responsible for reimbursement
Control1..1
TypeReference(Organization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. ClaimResponse.insurer.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. ClaimResponse.insurer.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. ClaimResponse.insurer.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortPayer IDThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
LabelPayer ID
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. ClaimResponse.request
Definition

The RTPBC Request ID contained in the associated request


Original request resource reference.

ShortSubmitter's RTPBC Request IDId of resource triggering adjudication
Control10..1
TypeReference(Claim)
Is Modifierfalse
Must Supporttrue
Summarytrue
LabelSubmitter's RTPBC Request ID
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. ClaimResponse.request.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ClaimResponse.request.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ClaimResponse.request.identifier.value
Definition

The RTPBC Request ID contained in the associated request


The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortRTPBC Request IDThe value that is unique
Comments

Populate with the Claim.identifier.value from the associated request


If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
LabelRTPBC Request ID
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ClaimResponse.outcome
Definition

The outcome of processing. Either 'complete' (finished without errors) or 'error' (processing could not complete). The outcome is 'processed' if processing completes with a coverage determination, including when it is determined that the requested product is not covered. Otherwise, the outcome = 'error'.

Note: If a system or communication error occurs, an OperationOutcome is returned instead of a ClaimResponse


The outcome of the claim, predetermination, or preauthorization processing.

ShortProcessing Outcomequeued | complete | error | partial
Comments

If the outcome = 'error', the .error composite must be populated.


The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).

Control1..1
BindingThe codes SHALL be taken from ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
(required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

The result of the claim processing.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

To advise the requestor of an overall processing outcome.

LabelProcessing Outcome
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ClaimResponse.disposition
Definition

Note providing clarifying information and/or support contact information. Available for both 'completed' and 'error' outcomes.


A human readable description of the status of the adjudication.

ShortCompleted NoteDisposition Message
Comments

The responding payer/PBM determines when and how to populate.Recommended that a patient help desk phone number be included.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

Corresponds to the Help Desk Support elements in the NCPDP RTPBC response message.


Provided for user display.

LabelCompleted Note
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ClaimResponse.item
Definition

Composite containing cost and coverage for the requested product and pharmacy.


A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

ShortRequested Product and PharmacyAdjudication for claim line items
Comments

SHALL be populated when the .outcome = 'complete'.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

The adjudication for items provided on the claim.

LabelRequested Product and Pharmacy
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. ClaimResponse.item.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClaimResponse.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 56. ClaimResponse.item.extension:benefitRestriction
    Slice NamebenefitRestriction
    Definition

    This extension conveys benefit restrictions that may apply to a prescription product and pharmacy combination.

    ShortBenefit Restriction (Extension)
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(RTPBC benefitRestriction Extension) (Extension Type: Coding)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    58. ClaimResponse.item.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    60. ClaimResponse.item.itemSequence
    Definition

    Indicates that the information in this .item composite relates to the requested product and pharmacy.


    A number to uniquely reference the claim item entries.

    ShortClaim item instance identifier
    Control1..1
    TypepositiveInt
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Requirements

    Necessary to provide a mechanism to link the adjudication result to the submitted claim item.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. ClaimResponse.item.noteNumber
    Definition

    Number referencing a Determination Note (.processNote) explaining the coverage status for this product + pharmacy combination.


    The numbers associated with notes below which apply to the adjudication of this item.

    ShortDetermination Note NumberApplicable note numbers
    Control0..*
    TypepositiveInt
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Requirements

    Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

    LabelDetermination Note Number
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. ClaimResponse.item.adjudication
    Definition

    Patient cost and coverage details for the requested product and pharmacy.


    If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

    ShortRequested Product and Pharmacy DeterminationAdjudication details
    Control1..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

    LabelRequested Product and Pharmacy Determination
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. ClaimResponse.item.adjudication.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    68. ClaimResponse.item.adjudication.category
    Definition

    Identifies a component of the patient's financial responsibility for the product cost.


    A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

    ShortPatient Pay ComponentType of adjudication information
    Comments

    At least one .adjudication must contain a .category with the .code value 'total', representing the patient's total financial responsibility for the product


    For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

    Control1..1
    BindingThe codes SHALL be taken from For example codes, see RTPBC Patient Pay Type Value Sethttp://hl7.org/fhir/ValueSet/adjudication
    (required to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-patient-pay-type)

    RTPBC Patient Pay Categories


    The adjudication codes.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Corresponds to NCPDP C95-KQ Patient Pay Component Qualifier.


    Needed to enable understanding of the context of the other information in the adjudication.

    LabelPatient Pay Component
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. ClaimResponse.item.adjudication.amount
    Definition

    The amount associated with the Patient Pay Component (.adjudication.category).


    Monetary amount associated with the category.

    ShortPatient Pay Component AmountMonetary amount
    Comments

    For example: amount submitted, eligible amount, co-payment, and benefit payable.

    Control10..1
    TypeMoney
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Most adjuciation categories convey a monetary amount.

    LabelPatient Pay Component Amount
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    72. ClaimResponse.item.adjudication.amount.value
    Definition

    The patient pay component amount in terms of the specified currency.


    Numerical value (with implicit precision).

    ShortPatient Pay Amount ValueNumerical value (with implicit precision)
    Comments

    Monetary values have their own rules for handling precision (refer to standard accounting text books).

    Control10..1
    Typedecimal
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    The amount of the currency. The value includes an implicit precision in the presentation of the value.

    LabelPatient Pay Amount Value
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. ClaimResponse.item.adjudication.amount.currency
    Definition

    ISO 4217 Currency Code.

    ShortPatient Pay Amount CurrencyISO 4217 Currency Code
    Control10..1
    BindingThe codes SHALL be taken from Currencieshttp://hl7.org/fhir/ValueSet/currencies|4.0.1
    (required to http://hl7.org/fhir/ValueSet/currencies)

    Currencies


    A code indicating the currency, taken from ISO 4217.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    A code indicating the currency, taken from ISO 4217.

    LabelPatient Pay Amount Currency
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    76. ClaimResponse.addItem
    Definition

    The first-tier service adjudications for payor added product or service lines.

    ShortInsurer added line items
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    78. ClaimResponse.addItem.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control10..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on ClaimResponse.addItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 80. ClaimResponse.addItem.extension:isAlternative
      Slice NameisAlternative
      Definition

      This extension indicates that this added line item is to be interpreted as one of possibly multiple alternatives to the requested product or service. When isAlternative is true, the added line item is to be considered independently from any other added line items associated with the requested product or service

      ShortIs Alternative (Extension)
      Comments

      Set to true in all real-time pharmacy benefit check response .addItems.

      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(RTPBC isAlternative Extension) (Extension Type: boolean)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      82. ClaimResponse.addItem.extension:benefitRestriction
      Slice NamebenefitRestriction
      Definition

      This extension conveys benefit restrictions that may apply to a prescription product and pharmacy combination.

      ShortBenefit Restriction (Extension)
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(RTPBC benefitRestriction Extension) (Extension Type: Coding)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      84. ClaimResponse.addItem.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      86. ClaimResponse.addItem.itemSequence
      Definition

      Indicates that the information in this .item composite is an alternative to the requested product and pharmacy.


      Claim items which this service line is intended to replace.

      ShortAssociated request Item SequenceItem sequence number
      Comments

      Because a maximum of one product is submitted per request, this value is always '1'.

      Control10..*
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Requirements

      Provides references to the claim items.

      LabelAssociated request Item Sequence
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      88. ClaimResponse.addItem.provider
      Definition

      Reference to an Organization resource representing the priced pharmacy


      The providers who are authorized for the services rendered to the patient.

      ShortPriced PharmacyAuthorized providers
      Control10..*
      TypeReference(RTPBC Pharmacy Organization, Practitioner, PractitionerRole, Organization)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.

      LabelPriced Pharmacy
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      90. ClaimResponse.addItem.provider.reference
      Definition

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      ShortReference to Priced PharmacyLiteral reference, Relative, internal or absolute URL
      Comments

      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Control10..1
      This element is affected by the following invariants: ref-1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      LabelReference to Priced Pharmacy
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      92. ClaimResponse.addItem.productOrService
      Definition

      A product identifier for the medication. Either an NDC11 or an RxNorm code for a prescribable product (representing drug name, strength and dose form)


      When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

      ShortProductBilling, service, product, or drug code
      Comments

      The NDC11 is an 11-digit normalized format consisting of a 5-digit labeler segment, 4-digit product segment, and 2-digit package segment, with no dashes


      If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

      Control1..1
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see RTPBC Prescribable Product Code Value Sethttp://hl7.org/fhir/ValueSet/service-uscls
      (extensible to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code)

      RTPBC prescribable product codes (NDC11 and RxNorm)


      Allowable service and product codes.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Necessary to state what was provided or done.

      LabelProduct
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      94. ClaimResponse.addItem.productOrService.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..*
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      96. ClaimResponse.addItem.productOrService.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      98. ClaimResponse.addItem.productOrService.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      100. ClaimResponse.addItem.productOrService.coding.display
      Definition

      The full prescribable product name, including drug name, strength and dose form. The drug name equals the brand name if the branded product is desired.


      A representation of the meaning of the code in the system, following the rules of the system.

      ShortProduct DescriptionRepresentation defined by the system
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      LabelProduct Description
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      102. ClaimResponse.addItem.quantity
      Definition

      The number of repetitions of a service or product.

      ShortPriced QuantityCount of products or services
      Control10..1
      TypeQuantity(SimpleQuantity)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Required when the product or service code does not convey the quantity provided.

      LabelPriced Quantity
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      104. ClaimResponse.addItem.quantity.value
      Definition

      The prescribed quantity in terms of the applicable billing unit of measure.


      The value of the measured amount. The value includes an implicit precision in the presentation of the value.

      ShortQuantity in Billing UnitsNumerical value (with implicit precision)
      Comments

      The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

      Control10..1
      Typedecimal
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Precision is handled implicitly in almost all cases of measurement.

      LabelQuantity in Billing Units
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      106. ClaimResponse.addItem.quantity.comparator
      Definition

      Not allowed to be used in this context


      How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

      Short< | <= | >= | > - how to understand the value
      Control0..01
      BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

      How the Quantity should be understood and represented.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

      Meaning if MissingIf there is no comparator, then there is no modification of the value
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      108. ClaimResponse.addItem.quantity.unit
      Definition

      Pharmacy metric billing unit: GM (gram), ML (milliliter) or EA (each)


      A human-readable form of the unit.

      ShortBilling unit of measureUnit representation
      Control10..1
      BindingUnless not suitable, these codes SHALL be taken from For codes, see RTPBC Billing Unit Value Set
      (extensible to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit)

      Billing quantity unit of measure

      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

      LabelBilling unit of measure
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      110. ClaimResponse.addItem.noteNumber
      Definition

      Number referencing a Determination Note (.processNote) explaining the coverage status for this product + pharmacy combination.


      The numbers associated with notes below which apply to the adjudication of this item.

      ShortDetermination Note NumberApplicable note numbers
      Control0..*
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Requirements

      Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

      LabelDetermination Note Number
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      112. ClaimResponse.addItem.adjudication
      Definition

      Patient cost and coverage details for an alternative product and pharmacy combination.


      The adjudication results.

      ShortAlternative Product and Pharmacy DeterminationAdded items adjudication
      Control1..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      LabelAlternative Product and Pharmacy Determination
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      114. ClaimResponse.addItem.adjudication.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      116. ClaimResponse.addItem.adjudication.category
      Definition

      Identifies a component of the patient's financial responsibility for the product cost.


      A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

      ShortPatient Pay ComponentType of adjudication information
      Comments

      At least one .adjudication must contain a .category with the .code value 'total', representing the patient's total financial responsibility for the product


      For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

      Control1..1
      BindingThe codes SHALL be taken from For example codes, see RTPBC Patient Pay Type Value Sethttp://hl7.org/fhir/ValueSet/adjudication
      (required to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-patient-pay-type)

      RTPBC Patient Pay Categories


      The adjudication codes.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Corresponds to NCPDP C95-KQ Patient Pay Component Qualifier.


      Needed to enable understanding of the context of the other information in the adjudication.

      LabelPatient Pay Component
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      118. ClaimResponse.addItem.adjudication.amount
      Definition

      The amount associated with the Patient Pay Component (.adjudication.category).


      Monetary amount associated with the category.

      ShortPatient Pay Component AmountMonetary amount
      Comments

      For example: amount submitted, eligible amount, co-payment, and benefit payable.

      Control10..1
      TypeMoney
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Most adjuciation categories convey a monetary amount.

      LabelPatient Pay Component Amount
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      120. ClaimResponse.addItem.adjudication.amount.value
      Definition

      The patient pay component amount in terms of the specified currency.


      Numerical value (with implicit precision).

      ShortPatient Pay Amount ValueNumerical value (with implicit precision)
      Comments

      Monetary values have their own rules for handling precision (refer to standard accounting text books).

      Control10..1
      Typedecimal
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      The amount of the currency. The value includes an implicit precision in the presentation of the value.

      LabelPatient Pay Amount Value
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      122. ClaimResponse.addItem.adjudication.amount.currency
      Definition

      ISO 4217 Currency Code.

      ShortPatient Pay Amount CurrencyISO 4217 Currency Code
      Control10..1
      BindingThe codes SHALL be taken from Currencieshttp://hl7.org/fhir/ValueSet/currencies|4.0.1
      (required to http://hl7.org/fhir/ValueSet/currencies)

      Currencies


      A code indicating the currency, taken from ISO 4217.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      A code indicating the currency, taken from ISO 4217.

      LabelPatient Pay Amount Currency
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      124. ClaimResponse.processNote
      Definition

      Additional coverage determination information for a product / pharmacy combination.


      A note that describes or explains adjudication results in a human readable form.

      ShortDetermination NoteNote concerning adjudication
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Provides the insurer specific textual explanations associated with the processing.

      LabelDetermination Note
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      126. ClaimResponse.processNote.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      128. ClaimResponse.processNote.number
      Definition

      A number to uniquely identify a note entry.

      ShortDetermination Note NumberNote instance identifier
      Comments

      Links to the .noteNumber elements in .item and .addItem

      Control10..1
      TypepositiveInt
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Requirements

      Necessary to provide a mechanism to link from adjudications.

      LabelDetermination Note Number
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      130. ClaimResponse.processNote.text
      Definition

      The explanation or description associated with the processing.

      ShortDetermination Note TextNote explanatory text
      Control1..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summaryfalse
      Requirements

      Required to provide human readable explanation.

      LabelDetermination Note Text
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      132. ClaimResponse.error
      Definition

      Errors encountered during the processing of the adjudication.

      ShortError InformationProcessing errors
      Comments

      Must be populated when .outcome = 'error'


      If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.

      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Need to communicate processing issues to the requestor.

      LabelError Information
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      134. ClaimResponse.error.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      136. ClaimResponse.error.code
      Definition

      A code identifying the reason that processing could not be completed.


      An error code, from a specified code system, which details why the claim could not be adjudicated.

      ShortReject ReasonError code detailing processing issues
      Control1..1
      BindingThe codes SHOULD be taken from For example codes, see RTPBC Error Code Value Sethttp://hl7.org/fhir/ValueSet/adjudication-error
      (preferred to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-error-code)

      RTPBC Error Codes


      The adjudication error codes.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Required to convey processing errors.

      LabelReject Reason
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      138. ClaimResponse.error.code.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..*
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      140. ClaimResponse.error.code.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      142. ClaimResponse.error.code.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortReject CodeSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      LabelReject Code
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      144. ClaimResponse.error.code.coding.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortRepresentation defined by the system
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      146. ClaimResponse.error.code.text
      Definition

      Clarification of the reject cause.


      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      ShortReject MessagePlain text representation of the concept
      Comments

      Very often the text is the same as a displayName of one of the codings.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

      LabelReject Message
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. ClaimResponse
      2. ClaimResponse.id
      Definition

      Unique ClaimResponse Resource Identifier assigned by the responding payer/PBM

      ShortUnique ClaimResponse Resource Identifier
      Must Supporttrue
      LabelUnique ClaimResponse Resource Identifier
      4. ClaimResponse.identifier
      ShortRTPBC Response Identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..?
      Must Supporttrue
      LabelRTPBC Response Identifier
      6. ClaimResponse.identifier.value
      Definition

      An identifier for each RTPBC response that is assigned by and unique to the reponder

      ShortUnique RTPBC response ID
      Control1..?
      Must Supporttrue
      LabelUnique RTPBC response ID
      8. ClaimResponse.status
      Definition

      The status of this response (active)

      ShortResponse status
      Comments

      Value is always 'active'

      Must Supporttrue
      LabelResponse status
      Fixed Valueactive
      10. ClaimResponse.type
      Definition

      The type of service for which pricing and coverage predetermination is being requested

      ShortRequested Service Type
      Comments

      Value is always 'pharmacy'

      Must Supporttrue
      LabelRequested Service Type
      12. ClaimResponse.type.coding
      Control1..1
      Must Supporttrue
      14. ClaimResponse.type.coding.system
      Control1..?
      Must Supporttrue
      Fixed Valuehttp://terminology.hl7.org/CodeSystem/claim-type
      16. ClaimResponse.type.coding.code
      Control1..?
      Must Supporttrue
      Fixed Valuepharmacy
      18. ClaimResponse.type.coding.display
      Control1..?
      Must Supporttrue
      Fixed ValuePharmacy
      20. ClaimResponse.use
      Definition

      The mode of processing being performed by the payer/PBM

      ShortProcessing Mode
      Comments

      Value is always 'predetermination'

      Must Supporttrue
      LabelProcessing Mode
      Fixed Valuepredetermination
      22. ClaimResponse.patient
      Definition

      Limited patient information required in the consumer real-time pharmacy benefit check (RTPBC) process

      ShortResponse Patient Information
      Comments

      Echo the Patient resource received in the request

      TypeReference(RTPBC Patient)
      Must Supporttrue
      LabelResponse Patient Information
      24. ClaimResponse.insurer
      Must Supporttrue
      26. ClaimResponse.insurer.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..?
      Must Supporttrue
      28. ClaimResponse.insurer.identifier.value
      ShortPayer ID
      Control1..?
      Must Supporttrue
      LabelPayer ID
      30. ClaimResponse.request
      Definition

      The RTPBC Request ID contained in the associated request

      ShortSubmitter's RTPBC Request ID
      Control1..?
      Must Supporttrue
      LabelSubmitter's RTPBC Request ID
      32. ClaimResponse.request.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..?
      Must Supporttrue
      34. ClaimResponse.request.identifier.value
      Definition

      The RTPBC Request ID contained in the associated request

      ShortRTPBC Request ID
      Comments

      Populate with the Claim.identifier.value from the associated request

      Control1..?
      Must Supporttrue
      LabelRTPBC Request ID
      36. ClaimResponse.outcome
      Definition

      The outcome of processing. Either 'complete' (finished without errors) or 'error' (processing could not complete). The outcome is 'processed' if processing completes with a coverage determination, including when it is determined that the requested product is not covered. Otherwise, the outcome = 'error'.

      Note: If a system or communication error occurs, an OperationOutcome is returned instead of a ClaimResponse

      ShortProcessing Outcome
      Comments

      If the outcome = 'error', the .error composite must be populated.

      Must Supporttrue
      LabelProcessing Outcome
      38. ClaimResponse.disposition
      Definition

      Note providing clarifying information and/or support contact information. Available for both 'completed' and 'error' outcomes.

      ShortCompleted Note
      Comments

      The responding payer/PBM determines when and how to populate.Recommended that a patient help desk phone number be included.

      Must Supporttrue
      Requirements

      Corresponds to the Help Desk Support elements in the NCPDP RTPBC response message.

      LabelCompleted Note
      40. ClaimResponse.item
      Definition

      Composite containing cost and coverage for the requested product and pharmacy.

      ShortRequested Product and Pharmacy
      Comments

      SHALL be populated when the .outcome = 'complete'.

      Must Supporttrue
      LabelRequested Product and Pharmacy
      42. ClaimResponse.item.extension
      SlicingThis element introduces a set of slices on ClaimResponse.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 44. ClaimResponse.item.extension:benefitRestriction
        Slice NamebenefitRestriction
        Definition

        This extension conveys benefit restrictions that may apply to a prescription product and pharmacy combination.

        ShortBenefit Restriction (Extension)
        Control0..*
        TypeExtension(RTPBC benefitRestriction Extension) (Extension Type: Coding)
        Must Supporttrue
        46. ClaimResponse.item.itemSequence
        Definition

        Indicates that the information in this .item composite relates to the requested product and pharmacy.

        Must Supporttrue
        48. ClaimResponse.item.noteNumber
        Definition

        Number referencing a Determination Note (.processNote) explaining the coverage status for this product + pharmacy combination.

        ShortDetermination Note Number
        Must Supporttrue
        LabelDetermination Note Number
        50. ClaimResponse.item.adjudication
        Definition

        Patient cost and coverage details for the requested product and pharmacy.

        ShortRequested Product and Pharmacy Determination
        Must Supporttrue
        LabelRequested Product and Pharmacy Determination
        52. ClaimResponse.item.adjudication.category
        Definition

        Identifies a component of the patient's financial responsibility for the product cost.

        ShortPatient Pay Component
        Comments

        At least one .adjudication must contain a .category with the .code value 'total', representing the patient's total financial responsibility for the product

        BindingThe codes SHALL be taken from RTPBC Patient Pay Type Value Set
        (required to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-patient-pay-type)

        RTPBC Patient Pay Categories

        Must Supporttrue
        Requirements

        Corresponds to NCPDP C95-KQ Patient Pay Component Qualifier.

        LabelPatient Pay Component
        54. ClaimResponse.item.adjudication.amount
        Definition

        The amount associated with the Patient Pay Component (.adjudication.category).

        ShortPatient Pay Component Amount
        Control1..?
        Must Supporttrue
        LabelPatient Pay Component Amount
        56. ClaimResponse.item.adjudication.amount.value
        Definition

        The patient pay component amount in terms of the specified currency.

        ShortPatient Pay Amount Value
        Control1..?
        Must Supporttrue
        LabelPatient Pay Amount Value
        58. ClaimResponse.item.adjudication.amount.currency
        ShortPatient Pay Amount Currency
        Control1..?
        BindingThe codes SHALL be taken from Currencies
        (required to http://hl7.org/fhir/ValueSet/currencies)

        Currencies

        Must Supporttrue
        LabelPatient Pay Amount Currency
        60. ClaimResponse.addItem
        Must Supporttrue
        62. ClaimResponse.addItem.extension
        Control1..?
        SlicingThis element introduces a set of slices on ClaimResponse.addItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 64. ClaimResponse.addItem.extension:isAlternative
          Slice NameisAlternative
          Definition

          This extension indicates that this added line item is to be interpreted as one of possibly multiple alternatives to the requested product or service. When isAlternative is true, the added line item is to be considered independently from any other added line items associated with the requested product or service

          ShortIs Alternative (Extension)
          Comments

          Set to true in all real-time pharmacy benefit check response .addItems.

          Control1..1
          TypeExtension(RTPBC isAlternative Extension) (Extension Type: boolean)
          Must Supporttrue
          66. ClaimResponse.addItem.extension:benefitRestriction
          Slice NamebenefitRestriction
          Definition

          This extension conveys benefit restrictions that may apply to a prescription product and pharmacy combination.

          ShortBenefit Restriction (Extension)
          Control0..*
          TypeExtension(RTPBC benefitRestriction Extension) (Extension Type: Coding)
          Must Supporttrue
          68. ClaimResponse.addItem.itemSequence
          Definition

          Indicates that the information in this .item composite is an alternative to the requested product and pharmacy.

          ShortAssociated request Item Sequence
          Comments

          Because a maximum of one product is submitted per request, this value is always '1'.

          Control1..?
          Must Supporttrue
          LabelAssociated request Item Sequence
          70. ClaimResponse.addItem.provider
          Definition

          Reference to an Organization resource representing the priced pharmacy

          ShortPriced Pharmacy
          Control1..?
          TypeReference(RTPBC Pharmacy Organization)
          Must Supporttrue
          LabelPriced Pharmacy
          72. ClaimResponse.addItem.provider.reference
          ShortReference to Priced Pharmacy
          Control1..?
          Must Supporttrue
          LabelReference to Priced Pharmacy
          74. ClaimResponse.addItem.productOrService
          Definition

          A product identifier for the medication. Either an NDC11 or an RxNorm code for a prescribable product (representing drug name, strength and dose form)

          ShortProduct
          Comments

          The NDC11 is an 11-digit normalized format consisting of a 5-digit labeler segment, 4-digit product segment, and 2-digit package segment, with no dashes

          BindingUnless not suitable, these codes SHALL be taken from RTPBC Prescribable Product Code Value Set
          (extensible to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code)

          RTPBC prescribable product codes (NDC11 and RxNorm)

          Must Supporttrue
          LabelProduct
          76. ClaimResponse.addItem.productOrService.coding
          Control1..?
          Must Supporttrue
          78. ClaimResponse.addItem.productOrService.coding.system
          Control1..?
          Must Supporttrue
          80. ClaimResponse.addItem.productOrService.coding.code
          Control1..?
          Must Supporttrue
          82. ClaimResponse.addItem.productOrService.coding.display
          Definition

          The full prescribable product name, including drug name, strength and dose form. The drug name equals the brand name if the branded product is desired.

          ShortProduct Description
          Control1..?
          Must Supporttrue
          LabelProduct Description
          84. ClaimResponse.addItem.quantity
          ShortPriced Quantity
          Control1..?
          Must Supporttrue
          LabelPriced Quantity
          86. ClaimResponse.addItem.quantity.value
          Definition

          The prescribed quantity in terms of the applicable billing unit of measure.

          ShortQuantity in Billing Units
          Control1..?
          Must Supporttrue
          LabelQuantity in Billing Units
          88. ClaimResponse.addItem.quantity.unit
          Definition

          Pharmacy metric billing unit: GM (gram), ML (milliliter) or EA (each)

          ShortBilling unit of measure
          Control1..?
          BindingUnless not suitable, these codes SHALL be taken from RTPBC Billing Unit Value Set
          (extensible to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit)

          Billing quantity unit of measure

          Must Supporttrue
          LabelBilling unit of measure
          90. ClaimResponse.addItem.noteNumber
          Definition

          Number referencing a Determination Note (.processNote) explaining the coverage status for this product + pharmacy combination.

          ShortDetermination Note Number
          Must Supporttrue
          LabelDetermination Note Number
          92. ClaimResponse.addItem.adjudication
          Definition

          Patient cost and coverage details for an alternative product and pharmacy combination.

          ShortAlternative Product and Pharmacy Determination
          TypeBackboneElement
          Must Supporttrue
          LabelAlternative Product and Pharmacy Determination
          94. ClaimResponse.addItem.adjudication.category
          Definition

          Identifies a component of the patient's financial responsibility for the product cost.

          ShortPatient Pay Component
          Comments

          At least one .adjudication must contain a .category with the .code value 'total', representing the patient's total financial responsibility for the product

          BindingThe codes SHALL be taken from RTPBC Patient Pay Type Value Set
          (required to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-patient-pay-type)

          RTPBC Patient Pay Categories

          Must Supporttrue
          Requirements

          Corresponds to NCPDP C95-KQ Patient Pay Component Qualifier.

          LabelPatient Pay Component
          96. ClaimResponse.addItem.adjudication.amount
          Definition

          The amount associated with the Patient Pay Component (.adjudication.category).

          ShortPatient Pay Component Amount
          Control1..?
          Must Supporttrue
          LabelPatient Pay Component Amount
          98. ClaimResponse.addItem.adjudication.amount.value
          Definition

          The patient pay component amount in terms of the specified currency.

          ShortPatient Pay Amount Value
          Control1..?
          Must Supporttrue
          LabelPatient Pay Amount Value
          100. ClaimResponse.addItem.adjudication.amount.currency
          ShortPatient Pay Amount Currency
          Control1..?
          BindingThe codes SHALL be taken from Currencies
          (required to http://hl7.org/fhir/ValueSet/currencies)

          Currencies

          Must Supporttrue
          LabelPatient Pay Amount Currency
          102. ClaimResponse.processNote
          Definition

          Additional coverage determination information for a product / pharmacy combination.

          ShortDetermination Note
          Must Supporttrue
          LabelDetermination Note
          104. ClaimResponse.processNote.number
          ShortDetermination Note Number
          Comments

          Links to the .noteNumber elements in .item and .addItem

          Control1..?
          Must Supporttrue
          LabelDetermination Note Number
          106. ClaimResponse.processNote.text
          ShortDetermination Note Text
          Must Supporttrue
          LabelDetermination Note Text
          108. ClaimResponse.error
          ShortError Information
          Comments

          Must be populated when .outcome = 'error'

          Must Supporttrue
          LabelError Information
          110. ClaimResponse.error.code
          Definition

          A code identifying the reason that processing could not be completed.

          ShortReject Reason
          BindingThe codes SHOULD be taken from RTPBC Error Code Value Set
          (preferred to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-error-code)

          RTPBC Error Codes

          Must Supporttrue
          LabelReject Reason
          112. ClaimResponse.error.code.coding
          Control1..?
          Must Supporttrue
          114. ClaimResponse.error.code.coding.system
          Control1..?
          Must Supporttrue
          116. ClaimResponse.error.code.coding.code
          ShortReject Code
          Control1..?
          Must Supporttrue
          LabelReject Code
          118. ClaimResponse.error.code.coding.display
          Control1..?
          Must Supporttrue
          120. ClaimResponse.error.code.text
          Definition

          Clarification of the reject cause.

          ShortReject Message
          Must Supporttrue
          LabelReject Message

          Guidance on how to interpret the contents of this table can be foundhere

          0. ClaimResponse
          Definition

          This resource provides the adjudication details from the processing of a Claim resource.

          ShortResponse to a claim predetermination or preauthorization
          Control0..*
          Is Modifierfalse
          Summaryfalse
          Alternate NamesRemittance Advice
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          2. ClaimResponse.id
          Definition

          Unique ClaimResponse Resource Identifier assigned by the responding payer/PBM

          ShortUnique ClaimResponse Resource Identifier
          Comments

          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          LabelUnique ClaimResponse Resource Identifier
          4. ClaimResponse.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. ClaimResponse.implicitRules
          Definition

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. ClaimResponse.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

          Control0..1
          BindingThe codes SHOULD be taken from CommonLanguages
          (preferred to http://hl7.org/fhir/ValueSet/languages)

          A human language.

          Additional BindingsPurpose
          AllLanguagesMax Binding
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. ClaimResponse.text
          Definition

          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          TypeNarrative
          Is Modifierfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. ClaimResponse.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

          Control0..*
          TypeResource
          Is Modifierfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. ClaimResponse.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          16. ClaimResponse.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Summaryfalse
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. ClaimResponse.identifier
          Definition

          A unique identifier assigned to this claim response.

          ShortRTPBC Response Identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control1..*
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Allows claim responses to be distinguished and referenced.

          LabelRTPBC Response Identifier
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. ClaimResponse.identifier.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          22. ClaimResponse.identifier.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on ClaimResponse.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 24. ClaimResponse.identifier.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUse
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

            Identifies the purpose for this identifier, if known .

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. ClaimResponse.identifier.type
            Definition

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            ShortDescription of identifier
            Comments

            This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
            (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

            A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows users to make use of identifiers when the identifier system is not known.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            28. ClaimResponse.identifier.system
            Definition

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            ExampleGeneral: http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. ClaimResponse.identifier.value
            Definition

            An identifier for each RTPBC response that is assigned by and unique to the reponder

            ShortUnique RTPBC response ID
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            LabelUnique RTPBC response ID
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            32. ClaimResponse.identifier.period
            Definition

            Time period during which identifier is/was valid for use.

            ShortTime period when id is/was valid for use
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            34. ClaimResponse.identifier.assigner
            Definition

            Organization that issued/manages the identifier.

            ShortOrganization that issued id (may be just text)
            Comments

            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

            Control0..1
            TypeReference(Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. ClaimResponse.status
            Definition

            The status of this response (active)

            ShortResponse status
            Comments

            Value is always 'active'

            Control1..1
            BindingThe codes SHALL be taken from FinancialResourceStatusCodes
            (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

            A code specifying the state of the resource instance.

            Typecode
            Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

            LabelResponse status
            Fixed Valueactive
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. ClaimResponse.type
            Definition

            The type of service for which pricing and coverage predetermination is being requested

            ShortRequested Service Type
            Comments

            Value is always 'pharmacy'

            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from ClaimTypeCodes
            (extensible to http://hl7.org/fhir/ValueSet/claim-type)

            The type or discipline-style of the claim.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Some jurisdictions need a finer grained claim type for routing and adjudication.

            LabelRequested Service Type
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. ClaimResponse.type.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            42. ClaimResponse.type.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on ClaimResponse.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 44. ClaimResponse.type.coding
              Definition

              A reference to a code defined by a terminology system.

              ShortCode defined by a terminology system
              Comments

              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

              Control1..1
              TypeCoding
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Requirements

              Allows for alternative encodings within a code system, and translations to other code systems.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              46. ClaimResponse.type.coding.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              48. ClaimResponse.type.coding.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on ClaimResponse.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 50. ClaimResponse.type.coding.system
                Definition

                The identification of the code system that defines the meaning of the symbol in the code.

                ShortIdentity of the terminology system
                Comments

                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                Control1..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Need to be unambiguous about the source of the definition of the symbol.

                Fixed Valuehttp://terminology.hl7.org/CodeSystem/claim-type
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                52. ClaimResponse.type.coding.version
                Definition

                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                ShortVersion of the system - if relevant
                Comments

                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                NoteThis is a business version Id, not a resource version Id (see discussion)
                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                54. ClaimResponse.type.coding.code
                Definition

                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                ShortSymbol in syntax defined by the system
                Control1..1
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Need to refer to a particular code in the system.

                Fixed Valuepharmacy
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                56. ClaimResponse.type.coding.display
                Definition

                A representation of the meaning of the code in the system, following the rules of the system.

                ShortRepresentation defined by the system
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                Fixed ValuePharmacy
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                58. ClaimResponse.type.coding.userSelected
                Definition

                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                ShortIf this coding was chosen directly by the user
                Comments

                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                Control0..1
                Typeboolean
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                60. ClaimResponse.type.text
                Definition

                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                ShortPlain text representation of the concept
                Comments

                Very often the text is the same as a displayName of one of the codings.

                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                62. ClaimResponse.subType
                Definition

                A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

                ShortMore granular claim type
                Comments

                This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.

                Control0..1
                BindingFor example codes, see ExampleClaimSubTypeCodes
                (example to http://hl7.org/fhir/ValueSet/claim-subtype)

                A more granular claim typecode.

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Requirements

                Some jurisdictions need a finer grained claim type for routing and adjudication.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                64. ClaimResponse.use
                Definition

                The mode of processing being performed by the payer/PBM

                ShortProcessing Mode
                Comments

                Value is always 'predetermination'

                Control1..1
                BindingThe codes SHALL be taken from Use
                (required to http://hl7.org/fhir/ValueSet/claim-use|4.0.1)

                Claim, preauthorization, predetermination.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                This element is required to understand the nature of the request for adjudication.

                LabelProcessing Mode
                Fixed Valuepredetermination
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                66. ClaimResponse.patient
                Definition

                Limited patient information required in the consumer real-time pharmacy benefit check (RTPBC) process

                ShortResponse Patient Information
                Comments

                Echo the Patient resource received in the request

                Control1..1
                TypeReference(RTPBC Patient)
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.

                LabelResponse Patient Information
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                68. ClaimResponse.created
                Definition

                The date this resource was created.

                ShortResponse creation date
                Control1..1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need to record a timestamp for use by both the recipient and the issuer.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                70. ClaimResponse.insurer
                Definition

                The party responsible for authorization, adjudication and reimbursement.

                ShortParty responsible for reimbursement
                Control1..1
                TypeReference(Organization)
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                72. ClaimResponse.insurer.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                74. ClaimResponse.insurer.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on ClaimResponse.insurer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 76. ClaimResponse.insurer.reference
                  Definition

                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                  ShortLiteral reference, Relative, internal or absolute URL
                  Comments

                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                  Control0..1
                  This element is affected by the following invariants: ref-1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  78. ClaimResponse.insurer.type
                  Definition

                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                  ShortType the reference refers to (e.g. "Patient")
                  Comments

                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                  (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                  Aa resource (or, for logical models, the URI of the logical model).

                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  80. ClaimResponse.insurer.identifier
                  Definition

                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                  ShortLogical reference, when literal reference is not known
                  Comments

                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..1
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  82. ClaimResponse.insurer.identifier.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  84. ClaimResponse.insurer.identifier.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on ClaimResponse.insurer.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 86. ClaimResponse.insurer.identifier.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. ClaimResponse.insurer.identifier.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. ClaimResponse.insurer.identifier.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control0..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    ExampleGeneral: http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    92. ClaimResponse.insurer.identifier.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortPayer ID
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    LabelPayer ID
                    ExampleGeneral: 123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    94. ClaimResponse.insurer.identifier.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    96. ClaimResponse.insurer.identifier.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    98. ClaimResponse.insurer.display
                    Definition

                    Plain text narrative that identifies the resource in addition to the resource reference.

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    100. ClaimResponse.requestor
                    Definition

                    The provider which is responsible for the claim, predetermination or preauthorization.

                    ShortParty responsible for the claim
                    Comments

                    Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.

                    Control0..1
                    TypeReference(Practitioner, PractitionerRole, Organization)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    102. ClaimResponse.request
                    Definition

                    The RTPBC Request ID contained in the associated request

                    ShortSubmitter's RTPBC Request ID
                    Control1..1
                    TypeReference(Claim)
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    LabelSubmitter's RTPBC Request ID
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    104. ClaimResponse.request.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    106. ClaimResponse.request.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on ClaimResponse.request.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 108. ClaimResponse.request.reference
                      Definition

                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                      ShortLiteral reference, Relative, internal or absolute URL
                      Comments

                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                      Control0..1
                      This element is affected by the following invariants: ref-1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      110. ClaimResponse.request.type
                      Definition

                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                      ShortType the reference refers to (e.g. "Patient")
                      Comments

                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from ResourceType
                      (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                      Aa resource (or, for logical models, the URI of the logical model).

                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. ClaimResponse.request.identifier
                      Definition

                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                      ShortLogical reference, when literal reference is not known
                      Comments

                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control1..1
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. ClaimResponse.request.identifier.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      116. ClaimResponse.request.identifier.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on ClaimResponse.request.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 118. ClaimResponse.request.identifier.use
                        Definition

                        The purpose of this identifier.

                        Shortusual | official | temp | secondary | old (If known)
                        Comments

                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                        Control0..1
                        BindingThe codes SHALL be taken from IdentifierUse
                        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                        Identifies the purpose for this identifier, if known .

                        Typecode
                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        120. ClaimResponse.request.identifier.type
                        Definition

                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                        ShortDescription of identifier
                        Comments

                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                        A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Allows users to make use of identifiers when the identifier system is not known.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        122. ClaimResponse.request.identifier.system
                        Definition

                        Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                        ShortThe namespace for the identifier value
                        Comments

                        Identifier.system is always case sensitive.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                        ExampleGeneral: http://www.acme.com/identifiers/patient
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. ClaimResponse.request.identifier.value
                        Definition

                        The RTPBC Request ID contained in the associated request

                        ShortRTPBC Request ID
                        Comments

                        Populate with the Claim.identifier.value from the associated request

                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        LabelRTPBC Request ID
                        ExampleGeneral: 123456
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. ClaimResponse.request.identifier.period
                        Definition

                        Time period during which identifier is/was valid for use.

                        ShortTime period when id is/was valid for use
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. ClaimResponse.request.identifier.assigner
                        Definition

                        Organization that issued/manages the identifier.

                        ShortOrganization that issued id (may be just text)
                        Comments

                        The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                        Control0..1
                        TypeReference(Organization)
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        130. ClaimResponse.request.display
                        Definition

                        Plain text narrative that identifies the resource in addition to the resource reference.

                        ShortText alternative for the resource
                        Comments

                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. ClaimResponse.outcome
                        Definition

                        The outcome of processing. Either 'complete' (finished without errors) or 'error' (processing could not complete). The outcome is 'processed' if processing completes with a coverage determination, including when it is determined that the requested product is not covered. Otherwise, the outcome = 'error'.

                        Note: If a system or communication error occurs, an OperationOutcome is returned instead of a ClaimResponse

                        ShortProcessing Outcome
                        Comments

                        If the outcome = 'error', the .error composite must be populated.

                        Control1..1
                        BindingThe codes SHALL be taken from ClaimProcessingCodes
                        (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1)

                        The result of the claim processing.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        To advise the requestor of an overall processing outcome.

                        LabelProcessing Outcome
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        134. ClaimResponse.disposition
                        Definition

                        Note providing clarifying information and/or support contact information. Available for both 'completed' and 'error' outcomes.

                        ShortCompleted Note
                        Comments

                        The responding payer/PBM determines when and how to populate.Recommended that a patient help desk phone number be included.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Corresponds to the Help Desk Support elements in the NCPDP RTPBC response message.

                        LabelCompleted Note
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        136. ClaimResponse.preAuthRef
                        Definition

                        Reference from the Insurer which is used in later communications which refers to this adjudication.

                        ShortPreauthorization reference
                        Comments

                        This value is only present on preauthorization adjudications.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Requirements

                        On subsequent claims, the insurer may require the provider to quote this value.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        138. ClaimResponse.preAuthPeriod
                        Definition

                        The time frame during which this authorization is effective.

                        ShortPreauthorization reference effective period
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summaryfalse
                        Requirements

                        To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        140. ClaimResponse.payeeType
                        Definition

                        Type of Party to be reimbursed: subscriber, provider, other.

                        ShortParty to be paid any benefits payable
                        Control0..1
                        BindingFor example codes, see Claim Payee Type Codes
                        (example to http://hl7.org/fhir/ValueSet/payeetype)

                        A code for the party to be reimbursed.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summaryfalse
                        Requirements

                        Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        142. ClaimResponse.item
                        Definition

                        Composite containing cost and coverage for the requested product and pharmacy.

                        ShortRequested Product and Pharmacy
                        Comments

                        SHALL be populated when the .outcome = 'complete'.

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        The adjudication for items provided on the claim.

                        LabelRequested Product and Pharmacy
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        144. ClaimResponse.item.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        146. ClaimResponse.item.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on ClaimResponse.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 148. ClaimResponse.item.extension:benefitRestriction
                          Slice NamebenefitRestriction
                          Definition

                          This extension conveys benefit restrictions that may apply to a prescription product and pharmacy combination.

                          ShortBenefit Restriction (Extension)
                          Control0..*
                          This element is affected by the following invariants: ele-1
                          TypeExtension(RTPBC benefitRestriction Extension) (Extension Type: Coding)
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          150. ClaimResponse.item.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          152. ClaimResponse.item.itemSequence
                          Definition

                          Indicates that the information in this .item composite relates to the requested product and pharmacy.

                          ShortClaim item instance identifier
                          Control1..1
                          TypepositiveInt
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          Necessary to provide a mechanism to link the adjudication result to the submitted claim item.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          154. ClaimResponse.item.noteNumber
                          Definition

                          Number referencing a Determination Note (.processNote) explaining the coverage status for this product + pharmacy combination.

                          ShortDetermination Note Number
                          Control0..*
                          TypepositiveInt
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                          LabelDetermination Note Number
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          156. ClaimResponse.item.adjudication
                          Definition

                          Patient cost and coverage details for the requested product and pharmacy.

                          ShortRequested Product and Pharmacy Determination
                          Control1..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.

                          LabelRequested Product and Pharmacy Determination
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          158. ClaimResponse.item.adjudication.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          160. ClaimResponse.item.adjudication.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          162. ClaimResponse.item.adjudication.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          164. ClaimResponse.item.adjudication.category
                          Definition

                          Identifies a component of the patient's financial responsibility for the product cost.

                          ShortPatient Pay Component
                          Comments

                          At least one .adjudication must contain a .category with the .code value 'total', representing the patient's total financial responsibility for the product

                          Control1..1
                          BindingThe codes SHALL be taken from RTPBC Patient Pay Type Value Set
                          (required to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-patient-pay-type)

                          RTPBC Patient Pay Categories

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          Corresponds to NCPDP C95-KQ Patient Pay Component Qualifier.

                          LabelPatient Pay Component
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          166. ClaimResponse.item.adjudication.reason
                          Definition

                          A code supporting the understanding of the adjudication result and explaining variance from expected amount.

                          ShortExplanation of adjudication outcome
                          Comments

                          For example may indicate that the funds for this benefit type have been exhausted.

                          Control0..1
                          BindingFor example codes, see AdjudicationReasonCodes
                          (example to http://hl7.org/fhir/ValueSet/adjudication-reason)

                          The adjudication reason codes.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          To support understanding of variance from adjudication expectations.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          168. ClaimResponse.item.adjudication.amount
                          Definition

                          The amount associated with the Patient Pay Component (.adjudication.category).

                          ShortPatient Pay Component Amount
                          Comments

                          For example: amount submitted, eligible amount, co-payment, and benefit payable.

                          Control1..1
                          TypeMoney
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          Most adjuciation categories convey a monetary amount.

                          LabelPatient Pay Component Amount
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          170. ClaimResponse.item.adjudication.amount.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          172. ClaimResponse.item.adjudication.amount.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on ClaimResponse.item.adjudication.amount.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 174. ClaimResponse.item.adjudication.amount.value
                            Definition

                            The patient pay component amount in terms of the specified currency.

                            ShortPatient Pay Amount Value
                            Comments

                            Monetary values have their own rules for handling precision (refer to standard accounting text books).

                            Control1..1
                            Typedecimal
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            The amount of the currency. The value includes an implicit precision in the presentation of the value.

                            LabelPatient Pay Amount Value
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            176. ClaimResponse.item.adjudication.amount.currency
                            Definition

                            ISO 4217 Currency Code.

                            ShortPatient Pay Amount Currency
                            Control1..1
                            BindingThe codes SHALL be taken from Currencies
                            (required to http://hl7.org/fhir/ValueSet/currencies)

                            Currencies

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            A code indicating the currency, taken from ISO 4217.

                            LabelPatient Pay Amount Currency
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            178. ClaimResponse.item.adjudication.value
                            Definition

                            A non-monetary value associated with the category. Mutually exclusive to the amount element above.

                            ShortNon-monetary value
                            Comments

                            For example: eligible percentage or co-payment percentage.

                            Control0..1
                            Typedecimal
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            Some adjudication categories convey a percentage or a fixed value.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            180. ClaimResponse.item.detail
                            Definition

                            A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

                            ShortAdjudication for claim details
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            The adjudication for details provided on the claim.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            182. ClaimResponse.item.detail.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            184. ClaimResponse.item.detail.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            186. ClaimResponse.item.detail.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            188. ClaimResponse.item.detail.detailSequence
                            Definition

                            A number to uniquely reference the claim detail entry.

                            ShortClaim detail instance identifier
                            Control1..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            Necessary to provide a mechanism to link the adjudication result to the submitted claim detail.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            190. ClaimResponse.item.detail.noteNumber
                            Definition

                            The numbers associated with notes below which apply to the adjudication of this item.

                            ShortApplicable note numbers
                            Control0..*
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            192. ClaimResponse.item.detail.adjudication
                            Definition

                            The adjudication results.

                            ShortDetail level adjudication details
                            Control1..*
                            TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            194. ClaimResponse.item.detail.subDetail
                            Definition

                            A sub-detail adjudication of a simple product or service.

                            ShortAdjudication for claim sub-details
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            The adjudication for sub-details provided on the claim.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            196. ClaimResponse.item.detail.subDetail.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            198. ClaimResponse.item.detail.subDetail.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            200. ClaimResponse.item.detail.subDetail.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            202. ClaimResponse.item.detail.subDetail.subDetailSequence
                            Definition

                            A number to uniquely reference the claim sub-detail entry.

                            ShortClaim sub-detail instance identifier
                            Control1..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            Necessary to provide a mechanism to link the adjudication result to the submitted claim sub-detail.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            204. ClaimResponse.item.detail.subDetail.noteNumber
                            Definition

                            The numbers associated with notes below which apply to the adjudication of this item.

                            ShortApplicable note numbers
                            Control0..*
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            206. ClaimResponse.item.detail.subDetail.adjudication
                            Definition

                            The adjudication results.

                            ShortSubdetail level adjudication details
                            Control0..*
                            TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            208. ClaimResponse.addItem
                            Definition

                            The first-tier service adjudications for payor added product or service lines.

                            ShortInsurer added line items
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            Requirements

                            Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            210. ClaimResponse.addItem.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            212. ClaimResponse.addItem.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control1..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on ClaimResponse.addItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 214. ClaimResponse.addItem.extension:isAlternative
                              Slice NameisAlternative
                              Definition

                              This extension indicates that this added line item is to be interpreted as one of possibly multiple alternatives to the requested product or service. When isAlternative is true, the added line item is to be considered independently from any other added line items associated with the requested product or service

                              ShortIs Alternative (Extension)
                              Comments

                              Set to true in all real-time pharmacy benefit check response .addItems.

                              Control1..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(RTPBC isAlternative Extension) (Extension Type: boolean)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              216. ClaimResponse.addItem.extension:benefitRestriction
                              Slice NamebenefitRestriction
                              Definition

                              This extension conveys benefit restrictions that may apply to a prescription product and pharmacy combination.

                              ShortBenefit Restriction (Extension)
                              Control0..*
                              This element is affected by the following invariants: ele-1
                              TypeExtension(RTPBC benefitRestriction Extension) (Extension Type: Coding)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              218. ClaimResponse.addItem.modifierExtension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                              ShortExtensions that cannot be ignored even if unrecognized
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                              Summarytrue
                              Requirements

                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                              Alternate Namesextensions, user content, modifiers
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              220. ClaimResponse.addItem.itemSequence
                              Definition

                              Indicates that the information in this .item composite is an alternative to the requested product and pharmacy.

                              ShortAssociated request Item Sequence
                              Comments

                              Because a maximum of one product is submitted per request, this value is always '1'.

                              Control1..*
                              TypepositiveInt
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summaryfalse
                              Requirements

                              Provides references to the claim items.

                              LabelAssociated request Item Sequence
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              222. ClaimResponse.addItem.detailSequence
                              Definition

                              The sequence number of the details within the claim item which this line is intended to replace.

                              ShortDetail sequence number
                              Control0..*
                              TypepositiveInt
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              Provides references to the claim details within the claim item.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              224. ClaimResponse.addItem.subdetailSequence
                              Definition

                              The sequence number of the sub-details within the details within the claim item which this line is intended to replace.

                              ShortSubdetail sequence number
                              Control0..*
                              TypepositiveInt
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Requirements

                              Provides references to the claim sub-details within the claim detail.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              226. ClaimResponse.addItem.provider
                              Definition

                              Reference to an Organization resource representing the priced pharmacy

                              ShortPriced Pharmacy
                              Control1..*
                              TypeReference(RTPBC Pharmacy Organization)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Requirements

                              Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.

                              LabelPriced Pharmacy
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              228. ClaimResponse.addItem.provider.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              230. ClaimResponse.addItem.provider.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on ClaimResponse.addItem.provider.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 232. ClaimResponse.addItem.provider.reference
                                Definition

                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                ShortReference to Priced Pharmacy
                                Comments

                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                Control1..1
                                This element is affected by the following invariants: ref-1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                LabelReference to Priced Pharmacy
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                234. ClaimResponse.addItem.provider.type
                                Definition

                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                ShortType the reference refers to (e.g. "Patient")
                                Comments

                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                Aa resource (or, for logical models, the URI of the logical model).

                                Typeuri
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                236. ClaimResponse.addItem.provider.identifier
                                Definition

                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                ShortLogical reference, when literal reference is not known
                                Comments

                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..1
                                TypeIdentifier
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                238. ClaimResponse.addItem.provider.display
                                Definition

                                Plain text narrative that identifies the resource in addition to the resource reference.

                                ShortText alternative for the resource
                                Comments

                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                240. ClaimResponse.addItem.productOrService
                                Definition

                                A product identifier for the medication. Either an NDC11 or an RxNorm code for a prescribable product (representing drug name, strength and dose form)

                                ShortProduct
                                Comments

                                The NDC11 is an 11-digit normalized format consisting of a 5-digit labeler segment, 4-digit product segment, and 2-digit package segment, with no dashes

                                Control1..1
                                BindingUnless not suitable, these codes SHALL be taken from RTPBC Prescribable Product Code Value Set
                                (extensible to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code)

                                RTPBC prescribable product codes (NDC11 and RxNorm)

                                TypeCodeableConcept
                                Is Modifierfalse
                                Must Supporttrue
                                Summaryfalse
                                Requirements

                                Necessary to state what was provided or done.

                                LabelProduct
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                242. ClaimResponse.addItem.productOrService.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                244. ClaimResponse.addItem.productOrService.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                SlicingThis element introduces a set of slices on ClaimResponse.addItem.productOrService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 246. ClaimResponse.addItem.productOrService.coding
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control1..*
                                  TypeCoding
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  248. ClaimResponse.addItem.productOrService.coding.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  250. ClaimResponse.addItem.productOrService.coding.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  SlicingThis element introduces a set of slices on ClaimResponse.addItem.productOrService.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 252. ClaimResponse.addItem.productOrService.coding.system
                                    Definition

                                    The identification of the code system that defines the meaning of the symbol in the code.

                                    ShortIdentity of the terminology system
                                    Comments

                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Need to be unambiguous about the source of the definition of the symbol.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    254. ClaimResponse.addItem.productOrService.coding.version
                                    Definition

                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                    ShortVersion of the system - if relevant
                                    Comments

                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    256. ClaimResponse.addItem.productOrService.coding.code
                                    Definition

                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                    ShortSymbol in syntax defined by the system
                                    Control1..1
                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Need to refer to a particular code in the system.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    258. ClaimResponse.addItem.productOrService.coding.display
                                    Definition

                                    The full prescribable product name, including drug name, strength and dose form. The drug name equals the brand name if the branded product is desired.

                                    ShortProduct Description
                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                    LabelProduct Description
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    260. ClaimResponse.addItem.productOrService.coding.userSelected
                                    Definition

                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                    ShortIf this coding was chosen directly by the user
                                    Comments

                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                    Control0..1
                                    Typeboolean
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    262. ClaimResponse.addItem.productOrService.text
                                    Definition

                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                    ShortPlain text representation of the concept
                                    Comments

                                    Very often the text is the same as a displayName of one of the codings.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    264. ClaimResponse.addItem.modifier
                                    Definition

                                    Item typification or modifiers codes to convey additional context for the product or service.

                                    ShortService/Product billing modifiers
                                    Comments

                                    For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

                                    Control0..*
                                    BindingFor example codes, see ModifierTypeCodes
                                    (example to http://hl7.org/fhir/ValueSet/claim-modifiers)

                                    Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    To support inclusion of the item for adjudication or to charge an elevated fee.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    266. ClaimResponse.addItem.programCode
                                    Definition

                                    Identifies the program under which this may be recovered.

                                    ShortProgram the product or service is provided under
                                    Comments

                                    For example: Neonatal program, child dental program or drug users recovery program.

                                    Control0..*
                                    BindingFor example codes, see ExampleProgramReasonCodes
                                    (example to http://hl7.org/fhir/ValueSet/ex-program-code)

                                    Program specific reason codes.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    268. ClaimResponse.addItem.serviced[x]
                                    Definition

                                    The date or dates when the service or product was supplied, performed or completed.

                                    ShortDate or dates of service or product delivery
                                    Control0..1
                                    TypeChoice of: date, Period
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summaryfalse
                                    Requirements

                                    Needed to determine whether the service or product was provided during the term of the insurance coverage.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    270. ClaimResponse.addItem.location[x]
                                    Definition

                                    Where the product or service was provided.

                                    ShortPlace of service or where product was supplied
                                    Control0..1
                                    BindingFor example codes, see ExampleServicePlaceCodes
                                    (example to http://hl7.org/fhir/ValueSet/service-place)

                                    Place of service: pharmacy, school, prison, etc.

                                    TypeChoice of: CodeableConcept, Address, Reference(Location)
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

                                    The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    272. ClaimResponse.addItem.quantity
                                    Definition

                                    The number of repetitions of a service or product.

                                    ShortPriced Quantity
                                    Control1..1
                                    TypeQuantity(SimpleQuantity)
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summaryfalse
                                    Requirements

                                    Required when the product or service code does not convey the quantity provided.

                                    LabelPriced Quantity
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    274. ClaimResponse.addItem.quantity.id
                                    Definition

                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    276. ClaimResponse.addItem.quantity.extension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                    ShortAdditional content defined by implementations
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on ClaimResponse.addItem.quantity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 278. ClaimResponse.addItem.quantity.value
                                      Definition

                                      The prescribed quantity in terms of the applicable billing unit of measure.

                                      ShortQuantity in Billing Units
                                      Comments

                                      The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

                                      Control1..1
                                      Typedecimal
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Precision is handled implicitly in almost all cases of measurement.

                                      LabelQuantity in Billing Units
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      280. ClaimResponse.addItem.quantity.comparator
                                      Definition

                                      Not allowed to be used in this context

                                      Short< | <= | >= | > - how to understand the value
                                      Control0..0
                                      BindingThe codes SHALL be taken from QuantityComparator
                                      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                                      How the Quantity should be understood and represented.

                                      Typecode
                                      Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                                      Meaning if MissingIf there is no comparator, then there is no modification of the value
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      282. ClaimResponse.addItem.quantity.unit
                                      Definition

                                      Pharmacy metric billing unit: GM (gram), ML (milliliter) or EA (each)

                                      ShortBilling unit of measure
                                      Control1..1
                                      BindingUnless not suitable, these codes SHALL be taken from RTPBC Billing Unit Value Set
                                      (extensible to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit)

                                      Billing quantity unit of measure

                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

                                      LabelBilling unit of measure
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      284. ClaimResponse.addItem.quantity.system
                                      Definition

                                      The identification of the system that provides the coded form of the unit.

                                      ShortSystem that defines coded unit form
                                      Control0..1
                                      This element is affected by the following invariants: qty-3
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Need to know the system that defines the coded form of the unit.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      286. ClaimResponse.addItem.quantity.code
                                      Definition

                                      A computer processable form of the unit in some unit representation system.

                                      ShortCoded form of the unit
                                      Comments

                                      The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

                                      Control0..1
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      288. ClaimResponse.addItem.unitPrice
                                      Definition

                                      If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

                                      ShortFee, charge or cost per item
                                      Control0..1
                                      TypeMoney
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      The amount charged to the patient by the provider for a single unit.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      290. ClaimResponse.addItem.factor
                                      Definition

                                      A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                                      ShortPrice scaling factor
                                      Comments

                                      To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

                                      Control0..1
                                      Typedecimal
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Requirements

                                      When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      292. ClaimResponse.addItem.net
                                      Definition

                                      The quantity times the unit price for an additional service or product or charge.

                                      ShortTotal item cost
                                      Comments

                                      For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                                      Control0..1
                                      TypeMoney
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      Provides the total amount claimed for the group (if a grouper) or the line item.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      294. ClaimResponse.addItem.bodySite
                                      Definition

                                      Physical service site on the patient (limb, tooth, etc.).

                                      ShortAnatomical location
                                      Comments

                                      For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.

                                      Control0..1
                                      BindingFor example codes, see OralSiteCodes
                                      (example to http://hl7.org/fhir/ValueSet/tooth)

                                      The code for the teeth, quadrant, sextant and arch.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      Allows insurer to validate specific procedures.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      296. ClaimResponse.addItem.subSite
                                      Definition

                                      A region or surface of the bodySite, e.g. limb region or tooth surface(s).

                                      ShortAnatomical sub-location
                                      Control0..*
                                      BindingFor example codes, see SurfaceCodes
                                      (example to http://hl7.org/fhir/ValueSet/surface)

                                      The code for the tooth surface and surface combinations.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      Allows insurer to validate specific procedures.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      298. ClaimResponse.addItem.noteNumber
                                      Definition

                                      Number referencing a Determination Note (.processNote) explaining the coverage status for this product + pharmacy combination.

                                      ShortDetermination Note Number
                                      Control0..*
                                      TypepositiveInt
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summaryfalse
                                      Requirements

                                      Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                                      LabelDetermination Note Number
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      300. ClaimResponse.addItem.adjudication
                                      Definition

                                      Patient cost and coverage details for an alternative product and pharmacy combination.

                                      ShortAlternative Product and Pharmacy Determination
                                      Control1..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      LabelAlternative Product and Pharmacy Determination
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      302. ClaimResponse.addItem.adjudication.id
                                      Definition

                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      304. ClaimResponse.addItem.adjudication.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      ShortAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      306. ClaimResponse.addItem.adjudication.modifierExtension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      308. ClaimResponse.addItem.adjudication.category
                                      Definition

                                      Identifies a component of the patient's financial responsibility for the product cost.

                                      ShortPatient Pay Component
                                      Comments

                                      At least one .adjudication must contain a .category with the .code value 'total', representing the patient's total financial responsibility for the product

                                      Control1..1
                                      BindingThe codes SHALL be taken from RTPBC Patient Pay Type Value Set
                                      (required to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-patient-pay-type)

                                      RTPBC Patient Pay Categories

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Requirements

                                      Corresponds to NCPDP C95-KQ Patient Pay Component Qualifier.

                                      LabelPatient Pay Component
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      310. ClaimResponse.addItem.adjudication.reason
                                      Definition

                                      A code supporting the understanding of the adjudication result and explaining variance from expected amount.

                                      ShortExplanation of adjudication outcome
                                      Comments

                                      For example may indicate that the funds for this benefit type have been exhausted.

                                      Control0..1
                                      BindingFor example codes, see AdjudicationReasonCodes
                                      (example to http://hl7.org/fhir/ValueSet/adjudication-reason)

                                      The adjudication reason codes.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Requirements

                                      To support understanding of variance from adjudication expectations.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      312. ClaimResponse.addItem.adjudication.amount
                                      Definition

                                      The amount associated with the Patient Pay Component (.adjudication.category).

                                      ShortPatient Pay Component Amount
                                      Comments

                                      For example: amount submitted, eligible amount, co-payment, and benefit payable.

                                      Control1..1
                                      TypeMoney
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Requirements

                                      Most adjuciation categories convey a monetary amount.

                                      LabelPatient Pay Component Amount
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      314. ClaimResponse.addItem.adjudication.amount.id
                                      Definition

                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      316. ClaimResponse.addItem.adjudication.amount.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      ShortAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on ClaimResponse.addItem.adjudication.amount.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 318. ClaimResponse.addItem.adjudication.amount.value
                                        Definition

                                        The patient pay component amount in terms of the specified currency.

                                        ShortPatient Pay Amount Value
                                        Comments

                                        Monetary values have their own rules for handling precision (refer to standard accounting text books).

                                        Control1..1
                                        Typedecimal
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Summarytrue
                                        Requirements

                                        The amount of the currency. The value includes an implicit precision in the presentation of the value.

                                        LabelPatient Pay Amount Value
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        320. ClaimResponse.addItem.adjudication.amount.currency
                                        Definition

                                        ISO 4217 Currency Code.

                                        ShortPatient Pay Amount Currency
                                        Control1..1
                                        BindingThe codes SHALL be taken from Currencies
                                        (required to http://hl7.org/fhir/ValueSet/currencies)

                                        Currencies

                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Summarytrue
                                        Requirements

                                        A code indicating the currency, taken from ISO 4217.

                                        LabelPatient Pay Amount Currency
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        322. ClaimResponse.addItem.adjudication.value
                                        Definition

                                        A non-monetary value associated with the category. Mutually exclusive to the amount element above.

                                        ShortNon-monetary value
                                        Comments

                                        For example: eligible percentage or co-payment percentage.

                                        Control0..1
                                        Typedecimal
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Some adjudication categories convey a percentage or a fixed value.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        324. ClaimResponse.addItem.detail
                                        Definition

                                        The second-tier service adjudications for payor added services.

                                        ShortInsurer added line details
                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        326. ClaimResponse.addItem.detail.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        328. ClaimResponse.addItem.detail.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        330. ClaimResponse.addItem.detail.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        332. ClaimResponse.addItem.detail.productOrService
                                        Definition

                                        When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

                                        ShortBilling, service, product, or drug code
                                        Comments

                                        If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

                                        Control1..1
                                        BindingFor example codes, see USCLSCodes
                                        (example to http://hl7.org/fhir/ValueSet/service-uscls)

                                        Allowable service and product codes.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Necessary to state what was provided or done.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        334. ClaimResponse.addItem.detail.modifier
                                        Definition

                                        Item typification or modifiers codes to convey additional context for the product or service.

                                        ShortService/Product billing modifiers
                                        Comments

                                        For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

                                        Control0..*
                                        BindingFor example codes, see ModifierTypeCodes
                                        (example to http://hl7.org/fhir/ValueSet/claim-modifiers)

                                        Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        To support inclusion of the item for adjudication or to charge an elevated fee.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        336. ClaimResponse.addItem.detail.quantity
                                        Definition

                                        The number of repetitions of a service or product.

                                        ShortCount of products or services
                                        Control0..1
                                        TypeQuantity(SimpleQuantity)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Required when the product or service code does not convey the quantity provided.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        338. ClaimResponse.addItem.detail.unitPrice
                                        Definition

                                        If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

                                        ShortFee, charge or cost per item
                                        Control0..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        The amount charged to the patient by the provider for a single unit.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        340. ClaimResponse.addItem.detail.factor
                                        Definition

                                        A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                                        ShortPrice scaling factor
                                        Comments

                                        To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

                                        Control0..1
                                        Typedecimal
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        342. ClaimResponse.addItem.detail.net
                                        Definition

                                        The quantity times the unit price for an additional service or product or charge.

                                        ShortTotal item cost
                                        Comments

                                        For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                                        Control0..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Provides the total amount claimed for the group (if a grouper) or the line item.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        344. ClaimResponse.addItem.detail.noteNumber
                                        Definition

                                        The numbers associated with notes below which apply to the adjudication of this item.

                                        ShortApplicable note numbers
                                        Control0..*
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        346. ClaimResponse.addItem.detail.adjudication
                                        Definition

                                        The adjudication results.

                                        ShortAdded items detail adjudication
                                        Control1..*
                                        TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        348. ClaimResponse.addItem.detail.subDetail
                                        Definition

                                        The third-tier service adjudications for payor added services.

                                        ShortInsurer added line items
                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        350. ClaimResponse.addItem.detail.subDetail.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        352. ClaimResponse.addItem.detail.subDetail.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        354. ClaimResponse.addItem.detail.subDetail.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        356. ClaimResponse.addItem.detail.subDetail.productOrService
                                        Definition

                                        When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

                                        ShortBilling, service, product, or drug code
                                        Comments

                                        If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.

                                        Control1..1
                                        BindingFor example codes, see USCLSCodes
                                        (example to http://hl7.org/fhir/ValueSet/service-uscls)

                                        Allowable service and product codes.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Necessary to state what was provided or done.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        358. ClaimResponse.addItem.detail.subDetail.modifier
                                        Definition

                                        Item typification or modifiers codes to convey additional context for the product or service.

                                        ShortService/Product billing modifiers
                                        Comments

                                        For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.

                                        Control0..*
                                        BindingFor example codes, see ModifierTypeCodes
                                        (example to http://hl7.org/fhir/ValueSet/claim-modifiers)

                                        Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        To support inclusion of the item for adjudication or to charge an elevated fee.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        360. ClaimResponse.addItem.detail.subDetail.quantity
                                        Definition

                                        The number of repetitions of a service or product.

                                        ShortCount of products or services
                                        Control0..1
                                        TypeQuantity(SimpleQuantity)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Required when the product or service code does not convey the quantity provided.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        362. ClaimResponse.addItem.detail.subDetail.unitPrice
                                        Definition

                                        If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

                                        ShortFee, charge or cost per item
                                        Control0..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        The amount charged to the patient by the provider for a single unit.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        364. ClaimResponse.addItem.detail.subDetail.factor
                                        Definition

                                        A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

                                        ShortPrice scaling factor
                                        Comments

                                        To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).

                                        Control0..1
                                        Typedecimal
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        366. ClaimResponse.addItem.detail.subDetail.net
                                        Definition

                                        The quantity times the unit price for an additional service or product or charge.

                                        ShortTotal item cost
                                        Comments

                                        For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.

                                        Control0..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Provides the total amount claimed for the group (if a grouper) or the line item.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        368. ClaimResponse.addItem.detail.subDetail.noteNumber
                                        Definition

                                        The numbers associated with notes below which apply to the adjudication of this item.

                                        ShortApplicable note numbers
                                        Control0..*
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        370. ClaimResponse.addItem.detail.subDetail.adjudication
                                        Definition

                                        The adjudication results.

                                        ShortAdded items detail adjudication
                                        Control1..*
                                        TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        372. ClaimResponse.adjudication
                                        Definition

                                        The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

                                        ShortHeader-level adjudication
                                        Control0..*
                                        TypeSeettp://hl7.org/fhir/StructureDefinition/ClaimResponse#ClaimResponse.item.adjudication
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Some insurers will receive line-items but provide the adjudication only at a summary or header-level.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        374. ClaimResponse.total
                                        Definition

                                        Categorized monetary totals for the adjudication.

                                        ShortAdjudication totals
                                        Comments

                                        Totals for amounts submitted, co-pays, benefits payable etc.

                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        To provide the requestor with financial totals by category for the adjudication.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        376. ClaimResponse.total.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        378. ClaimResponse.total.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        380. ClaimResponse.total.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        382. ClaimResponse.total.category
                                        Definition

                                        A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

                                        ShortType of adjudication information
                                        Comments

                                        For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.

                                        Control1..1
                                        BindingFor example codes, see AdjudicationValueCodes
                                        (example to http://hl7.org/fhir/ValueSet/adjudication)

                                        The adjudication codes.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        Needed to convey the type of total provided.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        384. ClaimResponse.total.amount
                                        Definition

                                        Monetary total amount associated with the category.

                                        ShortFinancial total for the category
                                        Control1..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        Needed to convey the total monetary amount.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        386. ClaimResponse.payment
                                        Definition

                                        Payment details for the adjudication of the claim.

                                        ShortPayment Details
                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Needed to convey references to the financial instrument that has been used if payment has been made.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        388. ClaimResponse.payment.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        390. ClaimResponse.payment.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        392. ClaimResponse.payment.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        394. ClaimResponse.payment.type
                                        Definition

                                        Whether this represents partial or complete payment of the benefits payable.

                                        ShortPartial or complete payment
                                        Control1..1
                                        BindingFor example codes, see ExamplePaymentTypeCodes
                                        (example to http://hl7.org/fhir/ValueSet/ex-paymenttype)

                                        The type (partial, complete) of the payment.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        To advise the requestor when the insurer believes all payments to have been completed.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        396. ClaimResponse.payment.adjustment
                                        Definition

                                        Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

                                        ShortPayment adjustment for non-claim issues
                                        Comments

                                        Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.

                                        Control0..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        To advise the requestor of adjustments applied to the payment.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        398. ClaimResponse.payment.adjustmentReason
                                        Definition

                                        Reason for the payment adjustment.

                                        ShortExplanation for the adjustment
                                        Control0..1
                                        BindingFor example codes, see PaymentAdjustmentReasonCodes
                                        (example to http://hl7.org/fhir/ValueSet/payment-adjustment-reason)

                                        Payment Adjustment reason codes.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Needed to clarify the monetary adjustment.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        400. ClaimResponse.payment.date
                                        Definition

                                        Estimated date the payment will be issued or the actual issue date of payment.

                                        ShortExpected date of payment
                                        Control0..1
                                        Typedate
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        To advise the payee when payment can be expected.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        402. ClaimResponse.payment.amount
                                        Definition

                                        Benefits payable less any payment adjustment.

                                        ShortPayable amount after adjustment
                                        Control1..1
                                        TypeMoney
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Needed to provide the actual payment amount.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        404. ClaimResponse.payment.identifier
                                        Definition

                                        Issuer's unique identifier for the payment instrument.

                                        ShortBusiness identifier for the payment
                                        Comments

                                        For example: EFT number or check number.

                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..1
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Enable the receiver to reconcile when payment received.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        406. ClaimResponse.fundsReserve
                                        Definition

                                        A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

                                        ShortFunds reserved status
                                        Comments

                                        Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.

                                        Control0..1
                                        BindingFor example codes, see Funds Reservation Codes
                                        (example to http://hl7.org/fhir/ValueSet/fundsreserve)

                                        For whom funds are to be reserved: (Patient, Provider, None).

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        408. ClaimResponse.formCode
                                        Definition

                                        A code for the form to be used for printing the content.

                                        ShortPrinted form identifier
                                        Comments

                                        May be needed to identify specific jurisdictional forms.

                                        Control0..1
                                        BindingFor example codes, see Form Codes
                                        (example to http://hl7.org/fhir/ValueSet/forms)

                                        The forms codes.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Needed to specify the specific form used for producing output for this response.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        410. ClaimResponse.form
                                        Definition

                                        The actual form, by reference or inclusion, for printing the content or an EOB.

                                        ShortPrinted reference or actual form
                                        Comments

                                        Needed to permit insurers to include the actual form.

                                        Control0..1
                                        TypeAttachment
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Needed to include the specific form used for producing output for this response.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        412. ClaimResponse.processNote
                                        Definition

                                        Additional coverage determination information for a product / pharmacy combination.

                                        ShortDetermination Note
                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

                                        Provides the insurer specific textual explanations associated with the processing.

                                        LabelDetermination Note
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        414. ClaimResponse.processNote.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        416. ClaimResponse.processNote.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        418. ClaimResponse.processNote.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        420. ClaimResponse.processNote.number
                                        Definition

                                        A number to uniquely identify a note entry.

                                        ShortDetermination Note Number
                                        Comments

                                        Links to the .noteNumber elements in .item and .addItem

                                        Control1..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

                                        Necessary to provide a mechanism to link from adjudications.

                                        LabelDetermination Note Number
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        422. ClaimResponse.processNote.type
                                        Definition

                                        The business purpose of the note text.

                                        Shortdisplay | print | printoper
                                        Control0..1
                                        BindingThe codes SHALL be taken from NoteType
                                        (required to http://hl7.org/fhir/ValueSet/note-type|4.0.1)

                                        The presentation types of notes.

                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        To convey the expectation for when the text is used.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        424. ClaimResponse.processNote.text
                                        Definition

                                        The explanation or description associated with the processing.

                                        ShortDetermination Note Text
                                        Control1..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

                                        Required to provide human readable explanation.

                                        LabelDetermination Note Text
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        426. ClaimResponse.processNote.language
                                        Definition

                                        A code to define the language used in the text of the note.

                                        ShortLanguage of the text
                                        Comments

                                        Only required if the language is different from the resource language.

                                        Control0..1
                                        BindingThe codes SHOULD be taken from CommonLanguages
                                        (preferred to http://hl7.org/fhir/ValueSet/languages)

                                        A human language.

                                        Additional BindingsPurpose
                                        AllLanguagesMax Binding
                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Note text may vary from the resource defined language.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        428. ClaimResponse.communicationRequest
                                        Definition

                                        Request for additional supporting or authorizing information.

                                        ShortRequest for additional information
                                        Comments

                                        For example: professional reports, documents, images, clinical resources, or accident reports.

                                        Control0..*
                                        TypeReference(CommunicationRequest)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Need to communicate insurer request for additional information required to support the adjudication.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        430. ClaimResponse.insurance
                                        Definition

                                        Financial instruments for reimbursement for the health care products and services specified on the claim.

                                        ShortPatient insurance information
                                        Comments

                                        All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.

                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        At least one insurer is required for a claim to be a claim.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        432. ClaimResponse.insurance.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        434. ClaimResponse.insurance.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        436. ClaimResponse.insurance.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        438. ClaimResponse.insurance.sequence
                                        Definition

                                        A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

                                        ShortInsurance instance identifier
                                        Control1..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        To maintain order of the coverages.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        440. ClaimResponse.insurance.focal
                                        Definition

                                        A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

                                        ShortCoverage to be used for adjudication
                                        Comments

                                        A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.

                                        Control1..1
                                        Typeboolean
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        To identify which coverage in the list is being used to adjudicate this claim.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        442. ClaimResponse.insurance.coverage
                                        Definition

                                        Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

                                        ShortInsurance information
                                        Control1..1
                                        TypeReference(Coverage)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Required to allow the adjudicator to locate the correct policy and history within their information system.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        444. ClaimResponse.insurance.businessArrangement
                                        Definition

                                        A business agreement number established between the provider and the insurer for special business processing purposes.

                                        ShortAdditional provider contract number
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        446. ClaimResponse.insurance.claimResponse
                                        Definition

                                        The result of the adjudication of the line items for the Coverage specified in this insurance.

                                        ShortAdjudication results
                                        Comments

                                        Must not be specified when 'focal=true' for this insurance.

                                        Control0..1
                                        TypeReference(ClaimResponse)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        448. ClaimResponse.error
                                        Definition

                                        Errors encountered during the processing of the adjudication.

                                        ShortError Information
                                        Comments

                                        Must be populated when .outcome = 'error'

                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

                                        Need to communicate processing issues to the requestor.

                                        LabelError Information
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        450. ClaimResponse.error.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        452. ClaimResponse.error.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        454. ClaimResponse.error.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        456. ClaimResponse.error.itemSequence
                                        Definition

                                        The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

                                        ShortItem sequence number
                                        Control0..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Provides references to the claim items.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        458. ClaimResponse.error.detailSequence
                                        Definition

                                        The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

                                        ShortDetail sequence number
                                        Control0..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Provides references to the claim details within the claim item.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        460. ClaimResponse.error.subDetailSequence
                                        Definition

                                        The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

                                        ShortSubdetail sequence number
                                        Control0..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Requirements

                                        Provides references to the claim sub-details within the claim detail.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        462. ClaimResponse.error.code
                                        Definition

                                        A code identifying the reason that processing could not be completed.

                                        ShortReject Reason
                                        Control1..1
                                        BindingThe codes SHOULD be taken from RTPBC Error Code Value Set
                                        (preferred to http://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-error-code)

                                        RTPBC Error Codes

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

                                        Required to convey processing errors.

                                        LabelReject Reason
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        464. ClaimResponse.error.code.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        466. ClaimResponse.error.code.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        SlicingThis element introduces a set of slices on ClaimResponse.error.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 468. ClaimResponse.error.code.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control1..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          470. ClaimResponse.error.code.coding.id
                                          Definition

                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          472. ClaimResponse.error.code.coding.extension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                          ShortAdditional content defined by implementations
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on ClaimResponse.error.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 474. ClaimResponse.error.code.coding.system
                                            Definition

                                            The identification of the code system that defines the meaning of the symbol in the code.

                                            ShortIdentity of the terminology system
                                            Comments

                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

                                            Need to be unambiguous about the source of the definition of the symbol.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            476. ClaimResponse.error.code.coding.version
                                            Definition

                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                            ShortVersion of the system - if relevant
                                            Comments

                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            478. ClaimResponse.error.code.coding.code
                                            Definition

                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                            ShortReject Code
                                            Control1..1
                                            Typecode
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

                                            Need to refer to a particular code in the system.

                                            LabelReject Code
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            480. ClaimResponse.error.code.coding.display
                                            Definition

                                            A representation of the meaning of the code in the system, following the rules of the system.

                                            ShortRepresentation defined by the system
                                            Control1..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            482. ClaimResponse.error.code.coding.userSelected
                                            Definition

                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                            ShortIf this coding was chosen directly by the user
                                            Comments

                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                            Control0..1
                                            Typeboolean
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            484. ClaimResponse.error.code.text
                                            Definition

                                            Clarification of the reject cause.

                                            ShortReject Message
                                            Comments

                                            Very often the text is the same as a displayName of one of the codings.

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                            LabelReject Message
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))