CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
2.1.0 - STU 2.1  flag

CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®), published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-bb/ and changes regularly. See the Directory of published versions

Resource Profile: C4BB ExplanationOfBenefit Pharmacy

Official URL: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy Version: 2.1.0
Standards status: Trial-use Computable Name: C4BBExplanationOfBenefitPharmacy

This profile is used for Explanation of Benefits (EOBs) based on claims submitted by retail pharmacies. The claims data is based on submission standards adopted by the Department of Health and Human Services defined by NCPDP (National Council for Prescription Drug Program) The profile has requirements for financial data.

Notes on Fields

  • The EOB FHIR Resource defines a comprehensive set of data elements.  Many of them are not relevant to this use case.  When reviewing the Profile Snapshot, several data elements previously hidden are now exposed.  Fields intended for consideration to be provided in the API are marked as Must Support; i.e., a red S or have a minimum cardinality of 1.  All other data elements are not expected to be sent by a Responder; if they are sent a Requestor can choose to ignore them
  • CPCDS data elements are mapped to EOB header or EOB.item data elements in alignment with claims submission standards.  Line item amounts, amount types and the in network or out of network payment status of the line are to be provided in EOB.item.  Total amounts and amount types of the claim are to be provided in EOB.total.
  • ExplanationOfBenefit.item.productOrService:  values are NDC Codes when Compound Code (MapID 78) = 0 or 1.  When the Compound Code = 2, productOrService = "compound" and map the ingredient to ExplanationOfBenefit.item.detail.productOrService
  • ExplanationOfBenefit.item.productOrService and item.detail.productOrService: Payers shall provide an 11-digit NDC. For additional information, reference the Other useful Information in the HL7 Terminology Authority - External Terminologies - NDC Confluence site, https://confluence.hl7.org/pages/viewpage.action?pageId=97453858
  • ExplanationOfBenefit.item.quantity:  populate for all Compound Code values.  When the Compound Code = 2, if available, map the ingredient to ExplanationOfBenefit.item.detail.quantity
  • ExplanationOfBenefit.item.adjudication.amount:  Eligible amount = ingredient cost + dispensing fee + sales tax + vaccine administration fee.  Excludes manufacturer discounts.  If benefit payment status code = 'Y', discount = submitted – noncovered – eligible; otherwise discount = 0.  The subscriber pays the member liability = deductible + coinsurance + copay + noncovered.  (part of the member liability may have already been paid to the provider as paidbypatient).  The eligible amount - the member liability is the payment amount to the provider (paidtoprovider). 
  • ExplanationOfBenefit.total.amount:  Eligible amount = ingredient cost + dispensing fee + sales tax + vaccine administration fee.  Excludes manufacturer discounts.  If benefit payment status code = 'Y', discount = submitted – noncovered – eligible; otherwise discount = 0.  The subscriber pays the member liability = deductible + coinsurance + copay + noncovered.  (part of the member liability may have already been paid to the provider as paidbypatient).  The eligible amount - the member liability is the payment amount to the provider (paidtoprovider). 
  • ExplanationOfBenefit.adjudication[benefitpaymentstatus]:  in network or out of network payment status for the claim
  • ExplanationOfBenefit.adjudication elements may contain slices for both billing network status (billingnetworkstatus) and benefit payment status (benefitpaymentstatus) which each contain a reason code bound to very similar ValueSets that indicate network status. The billing network status indicates the general relationship (often a contract status) the billing provider has with the payer. The benefit payment status indicates how the service or product is covered (in or out of network) in context to its provisioning. These two values may be different.
    An example of this is where an in network provider that has billed for a service that is not within the scope of the contract of service with the payer.
  • The CPCDS data elements are defined in the data element comments.  The numbers, e.g. (1), following the data element descriptions in the comments correlate to the MapID in the CPCDS Data Dictionary and the Mapping Worksheet as described here.
  • meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics (for example, inpatient or outpatient). Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit C 0..* C4BBExplanationOfBenefitPharmacyBasis Explanation of Benefit resource
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
EOB-pharmacy-meta-profile-version: Pharmacy EOB: meta.profile with canonical and major.minor. version required.
... meta SΣ 1..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:uniqueclaimid S 1..1 Identifier Unique Claim Identifier
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: uc
..... value SΣ 1..1 string Unique Claim Identifier
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: ExplanationOfBenefitStatus (required): A code specifying the state of the resource instance.


ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (required)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: pharmacy
... use SΣ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Complete, proposed, exploratory, other.


ele-1: All FHIR elements must have a @value or children
Required Pattern: claim
... patient SΣ 1..1 Reference(C4BB Patient) The recipient of the products and services
ele-1: All FHIR elements must have a @value or children
... billablePeriod SΣ 1..1 Period Relevant time frame for the claim
ele-1: All FHIR elements must have a @value or children
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
... created SΣ 1..1 dateTime Response creation date
ele-1: All FHIR elements must have a @value or children
... insurer SΣ 1..1 Reference(C4BB Organization) Party responsible for reimbursement
ele-1: All FHIR elements must have a @value or children
... provider SΣ 1..1 Reference(C4BB Organization | C4BB Practitioner) Party responsible for the claim
ele-1: All FHIR elements must have a @value or children
... related S 0..* BackboneElement Prior or corollary claims
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... relationship S 1..1 CodeableConcept How the reference claim is related
Binding: C4BB Related Claim Relationship Codes Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... reference S 1..1 Identifier File or case reference
ele-1: All FHIR elements must have a @value or children
... payee SC 0..1 BackboneElement Recipient of benefits payable
ele-1: All FHIR elements must have a @value or children
EOB-payee-other-type-requires-party: Base EOB: if payee type is other, payee party is required
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type S 1..1 CodeableConcept Category of recipient
Binding: C4BB Payee Type Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... party S 0..1 Reference(C4BB Organization | C4BB Patient | C4BB Practitioner | C4BB RelatedPerson) Recipient reference
ele-1: All FHIR elements must have a @value or children
... outcome SΣ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.


ele-1: All FHIR elements must have a @value or children
... careTeam SC 0..* BackboneElement Care Team members
ele-1: All FHIR elements must have a @value or children
EOB-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner
EOB-pharm-careTeam-organization: Pharmacy EOB: Careteam roles refer to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence 1..1 positiveInt Order of care team
ele-1: All FHIR elements must have a @value or children
.... provider S 1..1 Reference(C4BB Organization | C4BB Practitioner) Practitioner or organization
ele-1: All FHIR elements must have a @value or children
.... role S 1..1 CodeableConcept Function within the team
Binding: C4BB Claim Pharmacy CareTeam Role Value Set (required)
ele-1: All FHIR elements must have a @value or children
... Slices for supportingInfo S 4..* BackboneElement Supporting information
Slice: Unordered, Open by value:category
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:dayssupply S 1..1 BackboneElement Days supply
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: dayssupply
..... value[x] S 1..1 Quantity Data to be provided
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:dawcode S 1..1 BackboneElement Dispense and written product selection code
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: dawcode
..... code S 1..1 CodeableConcept Type of information
Binding: NCPDP Dispense As Written (DAW)/Product Selection Code Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:refillNum S 1..1 BackboneElement The number fill of the claim dispensed supply
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: refillnum
..... value[x] S 1..1 Quantity Data to be provided
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:refillsAuthorized S 1..1 BackboneElement Number or refills authorized by prescriber
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: refillsauthorized
..... value[x] S 1..1 Quantity Data to be provided
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:brandgenericindicator S 0..1 BackboneElement Plan reported brand or generic drug indicator
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: brandgenericindicator
..... code S 1..1 CodeableConcept Type of information
Binding: NCPDP Brand Generic Indicator Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:rxoriginCode S 0..1 BackboneElement Prescription origin code
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rxorigincode
..... code S 1..1 CodeableConcept Type of information
Binding: NCPDP Prescription Origin Code Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:clmrecvddate S 0..1 BackboneElement Claim received date
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: clmrecvddate
..... timing[x] S 1..1 date When it occurred
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:compoundcode S 0..1 BackboneElement Code indicating whether or not the prescription is a compound
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Information instance identifier
ele-1: All FHIR elements must have a @value or children
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: compoundcode
..... code S 1..1 CodeableConcept Type of information
Binding: NCPDP Compound Code Value Set (required)
ele-1: All FHIR elements must have a @value or children
... insurance SΣC 1..* BackboneElement Patient insurance information
ele-1: All FHIR elements must have a @value or children
EOB-insurance-focal: EOB.insurance: at most one with focal = true
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... focal SΣ 1..1 boolean Coverage to be used for adjudication
ele-1: All FHIR elements must have a @value or children
.... coverage SΣ 1..1 Reference(C4BB Coverage) Insurance information
ele-1: All FHIR elements must have a @value or children
... item S 1..* BackboneElement Product or service provided
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence S 1..1 positiveInt Item instance identifier
ele-1: All FHIR elements must have a @value or children
.... productOrService S 1..1 CodeableConcept Billing, service, product, or drug code
Binding: NDC or Compound Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... serviced[x] S 1..1 date Date or dates of service or product delivery
ele-1: All FHIR elements must have a @value or children
.... quantity S 0..1 SimpleQuantity Count of products or services
ele-1: All FHIR elements must have a @value or children
.... noteNumber S 0..* positiveInt Applicable note numbers
ele-1: All FHIR elements must have a @value or children
.... Slices for adjudication S 1..* BackboneElement Adjudication details
Slice: Unordered, Open by value:category
ele-1: All FHIR elements must have a @value or children
..... adjudication:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
..... adjudication:rejectreason S 0..1 BackboneElement Reason codes used to interpret the Non-Covered Amount (92)
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: rejectreason
...... reason S 1..1 CodeableConcept Explanation of adjudication outcome
Binding: NCPDP Reject Code Value Set (required)
ele-1: All FHIR elements must have a @value or children
..... adjudication:adjudicationamounttype S 1..* BackboneElement Line level adjudication type and amount
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
ele-1: All FHIR elements must have a @value or children
...... amount S 1..1 Money Monetary amount
ele-1: All FHIR elements must have a @value or children
.... detail S 0..* BackboneElement Additional items
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... sequence 1..1 positiveInt Product or service provided
ele-1: All FHIR elements must have a @value or children
..... productOrService S 1..1 CodeableConcept Billing, service, product, or drug code
Binding: National Drug Code (NDC) Value Set (required)
ele-1: All FHIR elements must have a @value or children
..... quantity S 0..1 SimpleQuantity Count of products or services
ele-1: All FHIR elements must have a @value or children
... Slices for adjudication S 1..* BackboneElement Header-level adjudication
Slice: Unordered, Open by value:category
ele-1: All FHIR elements must have a @value or children
.... adjudication:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
.... adjudication:billingnetworkstatus S 0..1 BackboneElement Billing provider networking status
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: billingnetworkstatus
..... reason S 1..1 CodeableConcept Explanation of adjudication outcome
Binding: C4BB Payer Provider Network Status Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... adjudication:benefitpaymentstatus S 1..1 BackboneElement Indicates the in network or out of network payment status of the claim. (142)
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: benefitpaymentstatus
..... reason S 1..1 CodeableConcept Explanation of adjudication outcome
Binding: C4BB Payer Benefit Payment Status Value Set (required)
ele-1: All FHIR elements must have a @value or children
... Slices for total SΣ 1..* BackboneElement Adjudication totals
Slice: Unordered, Open by value:category
ele-1: All FHIR elements must have a @value or children
.... total:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category SΣ 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Total Category Discriminator Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
..... amount SΣ 1..1 Money Financial total for the category
ele-1: All FHIR elements must have a @value or children
.... total:adjudicationamounttype SΣ 1..* BackboneElement Total adjudication type and amount
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category SΣ 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
ele-1: All FHIR elements must have a @value or children
..... amount SΣ 1..1 Money Financial total for the category
ele-1: All FHIR elements must have a @value or children
... payment S 0..1 BackboneElement Payment Details
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type S 0..1 CodeableConcept Partial or complete payment
Binding: C4BB Payer Claim Payment Status Code Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... date S 0..1 date Expected date of payment
ele-1: All FHIR elements must have a @value or children
... processNote S 0..* BackboneElement Note concerning adjudication
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text S 0..1 string Note explanatory text
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ExplanationOfBenefit.identifier:uniqueclaimid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ExplanationOfBenefit.identifier:uniqueclaimid.typeextensiblePattern: uc
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ExplanationOfBenefit.statusrequiredExplanationOfBenefitStatus
http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1
from the FHIR Standard
ExplanationOfBenefit.typerequiredPattern: pharmacy
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ExplanationOfBenefit.userequiredPattern: claim
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
ExplanationOfBenefit.related.relationshiprequiredC4BBRelatedClaimRelationshipCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBRelatedClaimRelationshipCodes
from this IG
ExplanationOfBenefit.payee.typerequiredC4BBPayeeType
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayeeType
from this IG
ExplanationOfBenefit.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
from the FHIR Standard
ExplanationOfBenefit.careTeam.rolerequiredC4BBClaimPharmacyTeamRole
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole
from this IG
ExplanationOfBenefit.supportingInfo.categoryextensibleC4BBSupportingInfoType (a valid code from C4BB Supporting Info Type Code System)
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:dayssupply.categoryextensiblePattern: dayssupply
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:dawcode.categoryextensiblePattern: dawcode
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:dawcode.coderequiredNCPDPDispensedAsWrittenOrProductSelectionCode
http://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode
from this IG
ExplanationOfBenefit.supportingInfo:refillNum.categoryextensiblePattern: refillnum
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:refillsAuthorized.categoryextensiblePattern: refillsauthorized
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:brandgenericindicator.categoryextensiblePattern: brandgenericindicator
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:brandgenericindicator.coderequiredNCPDPBrandGenericIndicator
http://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator
from this IG
ExplanationOfBenefit.supportingInfo:rxoriginCode.categoryextensiblePattern: rxorigincode
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:rxoriginCode.coderequiredNCPDPPrescriptionOriginCode
http://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode
from this IG
ExplanationOfBenefit.supportingInfo:clmrecvddate.categoryextensiblePattern: clmrecvddate
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:compoundcode.categoryextensiblePattern: compoundcode
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:compoundcode.coderequiredNCPDPCompoundCode
http://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode
from this IG
ExplanationOfBenefit.item.productOrServicerequiredFDANDCOrCompound
http://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound
from this IG
ExplanationOfBenefit.item.adjudication.categoryextensibleC4BBAdjudicationCategoryDiscriminator
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.item.adjudication:rejectreason.categoryextensiblePattern: rejectreason
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.item.adjudication:rejectreason.reasonrequiredNCPDPRejectCode
http://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode
from this IG
ExplanationOfBenefit.item.adjudication:adjudicationamounttype.categoryrequiredC4BBAdjudication
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication
from this IG
ExplanationOfBenefit.item.detail.productOrServicerequiredFDANationalDrugCode
http://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode
from this IG
ExplanationOfBenefit.adjudication.categoryextensibleC4BBAdjudicationCategoryDiscriminator
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.adjudication:billingnetworkstatus.categoryextensiblePattern: billingnetworkstatus
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.adjudication:billingnetworkstatus.reasonrequiredC4BBPayerProviderNetworkStatus
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus
from this IG
ExplanationOfBenefit.adjudication:benefitpaymentstatus.categoryextensiblePattern: benefitpaymentstatus
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reasonrequiredC4BBPayerBenefitPaymentStatus
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus
from this IG
ExplanationOfBenefit.total.categoryextensibleC4BBTotalCategoryDiscriminator
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBTotalCategoryDiscriminator
from this IG
ExplanationOfBenefit.total:adjudicationamounttype.categoryrequiredC4BBAdjudication
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication
from this IG
ExplanationOfBenefit.payment.typerequiredC4BBPayerClaimPaymentStatusCode
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerClaimPaymentStatusCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EOB-pharmacy-meta-profile-versionwarningExplanationOfBenefitPharmacy EOB: meta.profile with canonical and major.minor. version required.
: meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy|2.1'))

 

Other representations of profile: CSV, Excel, Schematron