CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
2.1.0 - STU 2.1 United States of America 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 Inpatient Institutional

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

The profile is used for Explanation of Benefits (EOBs) based on claims submitted by clinics, hospitals, skilled nursing facilities and other institutions for inpatient services, which may include the use of equipment and supplies, laboratory services, radiology services and other charges. Inpatient claims are submitted for services rendered at an institution as part of an overnight stay. The claims data is based on the institutional claim format UB-04, submission standards adopted by the Department of Health and Human Services. 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 and amount types are to be provided in EOB.item.  If a Payer does not have line item amounts, provide the claim amounts and amount types in the EOB header data elements.  Total amounts and amount types of the claim are to be provided in EOB.total.
  • The determination of inpatient vs. outpatient institutional claims is defined by the Type of Bill. The NUBC manual defines which TOBs are inpatient vs outpatient.
  • A CPT / HCPCS code may not be available on an inpatient institutional claim. The cardinality of the HL7 base EOB Resource for item.productOrService is 1..1 if .item is provided.  Since .item.revenue is required it means that item.productOrService must be populated.  Since the profile is not able to relax the cardinality of the resource, it is recommended payers provide a data absent reason when a CPT / HCPCS code is not available.
  • .diagnosis:  ICD-10 / ICD-9 diagnosis codes are defined as CodeableConcepts
  • .diagnosis.sequence rule:  diagnosis.sequence values do not necessarily indicate any order in which the diagnosis was reported or identified.  client app implementations should not assign any significance to the sequence values.  client app implementations should use the values of diagnosis.type to identify primary, secondary, etc. 
  • .procedure:  ICD-10 / ICD-9 procedure codes are defined as CodeableConcepts
  • .procedure.sequence rule:  procedure.sequence values do not necessarily indicate any order in which the procedure occurred.  client app implementations should not assign any significance to the sequence values.  client app implementations should use the values of procedure.type to identify primary and secondary procedures
  • .supportingInfo[DRG]:  DRGs require the DRG system; i.e., MS-DRG / AP-DRG / APR-DRG, the DRG version and the code value
  • .adjudication.amount (populate only if item.adjudication is not available):  Eligible amount = submitted amount - the noncovered amount - discount.  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) or the subscriber (paidtopatient)
  • .item.adjudication.amount:  Eligible amount = submitted amount - the noncovered amount - discount.  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) or the subscriber (paidtopatient)
  • .total.amount:  Eligible amount = submitted amount - the noncovered amount - discount.  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) or the subscriber (paidtopatient)
  • .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.

This structure is derived from C4BBExplanationOfBenefitInpatientInstitutionalBasis

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit C 0..* C4BBExplanationOfBenefitInpatientInstitutionalBasis Explanation of Benefit resource
EOB-institutional-inpatient-meta-profile-version: Institutional Inpatient EOB: meta.profile with canonical and major.minor. version required.
EOB-institutional-item-or-header-adjudication: Institutional EOB: Should have adjudication with adjudicationamounttype slice at the item or header level, but not both
... item C 1..* BackboneElement Product or service provided
adjudication-has-amount-type-slice: If Adjudication is present, it must have at least one adjudicationamounttype slice
.... Slices for adjudication Content/Rules for all slices
..... adjudication:adjudicationamounttype S 0..* BackboneElement Line level adjudication type and amount
...... category 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
...... amount S 1..1 Money Monetary amount
... Slices for adjudication Content/Rules for all slices
.... adjudication:adjudicationamounttype S 0..* BackboneElement Claim level adjudication type and amount
..... category 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
..... amount 1..1 Money Monetary amount
... Slices for total S 1..* BackboneElement Adjudication totals
Slice: Unordered, Open by value:category
.... total:All Slices Content/Rules for all slices
..... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Total Category Discriminator Value Set (extensible)
..... amount 1..1 Money Financial total for the category
.... total:adjudicationamounttype S 1..* BackboneElement Total adjudication type and amount
..... category 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
..... amount S 1..1 Money Financial total for the category

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ExplanationOfBenefit.item.adjudication:adjudicationamounttype.categoryrequiredC4BBAdjudication
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication
from this IG
ExplanationOfBenefit.adjudication:adjudicationamounttype.categoryrequiredC4BBAdjudication
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication
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

Constraints

IdGradePath(s)DetailsRequirements
EOB-institutional-inpatient-meta-profile-versionwarningExplanationOfBenefitInstitutional Inpatient 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-Inpatient-Institutional|2.1'))
EOB-institutional-item-or-header-adjudicationerrorExplanationOfBenefitInstitutional EOB: Should have adjudication with adjudicationamounttype slice at the item or header level, but not both
: adjudication.where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists() != item.adjudication.where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists()
adjudication-has-amount-type-sliceerrorExplanationOfBenefit.itemIf Adjudication is present, it must have at least one adjudicationamounttype slice
: (adjudication.exists().not() or adjudication.where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit C 0..* C4BBExplanationOfBenefitInpatientInstitutionalBasis Explanation of Benefit resource
EOB-inst-pointoforigin: Where Admission Type and Point of Origin slices exist, if Type of Admission code is Newborn, Point of Origin must be from Point of Origin - Newborn CodeSystem or Type of Admission is not Newborn and Point of Origin must be from Point of Origin Nonnewborn CodeSystem.
EOB-institutional-inpatient-meta-profile-version: Institutional Inpatient EOB: meta.profile with canonical and major.minor. version required.
EOB-institutional-item-or-header-adjudication: Institutional EOB: Should have adjudication with adjudicationamounttype slice at the item or header level, but not both
... meta SΣ 1..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version last changed
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:uniqueclaimid S 1..1 Identifier Unique Claim Identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... 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.


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
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.

... type SΣ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (required)
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: institutional
... subType S 1..1 CodeableConcept More granular claim type
Binding: C4BB Institutional Claim SubType Value Set (required)
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/C4BBInstitutionalClaimSubType
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: inpatient
... use SΣ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Complete, proposed, exploratory, other.


Required Pattern: claim
... patient SΣ 1..1 Reference(C4BB Patient) The recipient of the products and services
... billablePeriod SΣ 1..1 Period Relevant time frame for the claim
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... created SΣ 1..1 dateTime Response creation date
... insurer SΣ 1..1 Reference(C4BB Organization) Party responsible for reimbursement
... provider SΣ 1..1 Reference(C4BB Organization) Party responsible for the claim
... related S 0..* BackboneElement Prior or corollary claims
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..1 CodeableConcept How the reference claim is related
Binding: C4BB Related Claim Relationship Codes Value Set (required)
.... reference S 1..1 Identifier File or case reference
... payee SC 0..1 BackboneElement Recipient of benefits payable
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
.... type S 1..1 CodeableConcept Category of recipient
Binding: C4BB Payee Type Value Set (required)
.... party S 0..1 Reference(C4BB Organization | C4BB Patient | C4BB Practitioner | C4BB RelatedPerson) Recipient reference
... outcome SΣ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... careTeam SC 0..* BackboneElement Care Team members
EOB-inst-careTeam-practitioner: Institutional EOB: Careteam roles refer to a practitioner
EOB-inst-careTeam-organization: Institutional EOB: Careteam roles refer to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Order of care team
.... provider S 1..1 Reference(C4BB Organization | C4BB Practitioner) Practitioner or organization
.... role S 1..1 CodeableConcept Function within the team
Binding: C4BB Claim Institutional Care Team Role Value Set (required)
... Slices for supportingInfo S 1..* BackboneElement Supporting information
Slice: Unordered, Open by value:category
.... supportingInfo:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
.... supportingInfo:admissionperiod S 1..1 BackboneElement Admission Period
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: admissionperiod
..... Slices for timing[x] 1..1 Period When it occurred
Slice: Unordered, Closed by type:$this
...... timing[x]:timingPeriod S 1..1 Period When it occurred
.... supportingInfo:clmrecvddate S 0..1 BackboneElement Claim received date
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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
.... supportingInfo:typeofbill S 0..1 BackboneElement Type of bill
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: typeofbill
..... code S 1..1 CodeableConcept Type of information
Binding: NUBC Type of Bill Codes Value Set (required)
.... supportingInfo:pointoforigin S 0..1 BackboneElement Point of origin for admission
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: pointoforigin
..... code S 1..1 CodeableConcept Type of information
Binding: NUBC Point Of Origin Value Set (required)
.... supportingInfo:admtype S 0..1 BackboneElement Admission type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: admtype
..... code S 1..1 CodeableConcept Type of information
Binding: NUBC Priority (Type) of Admission or Visit Value Set (required)
.... supportingInfo:discharge-status S 0..1 BackboneElement Discharge status
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: discharge-status
..... code S 1..1 CodeableConcept Type of information
Binding: NUBC Patient Discharge Status Codes Value Set (required)
.... supportingInfo:drg S 0..1 BackboneElement Diagnosis Related Group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: drg
..... code S 1..1 CodeableConcept Type of information
Binding: MS-DRGs - AP-DRGs - APR-DRGs Value Set (extensible)
.... supportingInfo:medicalrecordnumber S 0..1 BackboneElement Medical record number
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: medicalrecordnumber
..... Slices for value[x] 1..1 string Data to be provided
Slice: Unordered, Closed by type:$this
...... value[x]:valueString S 1..1 string Data to be provided
.... supportingInfo:patientaccountnumber S 0..1 BackboneElement Patient account number
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
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: patientaccountnumber
..... Slices for value[x] 1..1 string Data to be provided
Slice: Unordered, Closed by type:$this
...... value[x]:valueString S 1..1 string Data to be provided
... diagnosis S 1..* BackboneElement Pertinent diagnosis information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Diagnosis instance identifier
.... diagnosis[x] S 1..1 CodeableConcept Nature of illness or problem
Binding: Diagnosis Codes - International Classification of Diseases, Clinical Modification (ICD-9-CM, ICD-10-CM) Value Set (required)
.... type S 1..1 CodeableConcept Timing or nature of the diagnosis
Binding: C4BB Claim Inpatient Institutional Diagnosis Type Value Set (required)
.... onAdmission S 0..1 CodeableConcept Present on admission
Binding: CMS Present On Admission Indicator Codes Value Set (required)
... procedure S 0..* BackboneElement Clinical procedures performed
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Procedure instance identifier
.... type S 1..1 CodeableConcept Category of Procedure
Binding: C4BB Claim Procedure Type Value Set (required)
.... date S 0..1 dateTime When the procedure was performed
.... procedure[x] S 1..1 CodeableConcept Specific clinical procedure
Binding: Procedure Codes - International Classification of Diseases, Ninth Revision, Clinical Modification (ICD-9-CM) - ICD-10 Procedure Value Set (required)
... insurance SΣC 1..* BackboneElement Patient insurance information
EOB-insurance-focal: EOB.insurance: at most one with focal = true
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... focal SΣ 1..1 boolean Coverage to be used for adjudication
.... coverage SΣ 1..1 Reference(C4BB Coverage) Insurance information
... item SC 1..* BackboneElement Product or service provided
adjudication-has-amount-type-slice: If Adjudication is present, it must have at least one adjudicationamounttype slice
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence S 1..1 positiveInt Item instance identifier
.... revenue S 1..1 CodeableConcept Revenue or cost center code
Binding: NUBC Revenue Codes Value Set (required)
.... productOrService S 1..1 CodeableConcept Billing, service, product, or drug code
Binding: Procedure Codes - AMA CPT - CMS HCPCS - CMS HIPPS Value Set (required)
.... modifier S 0..* CodeableConcept Product or service billing modifiers
Binding: Procedure Modifier Codes - AMA CPT - CMS HCPCS Value Set (required)
.... quantity S 0..1 SimpleQuantity Count of products or services
.... noteNumber S 0..* positiveInt Applicable note numbers
.... Slices for adjudication S 0..* BackboneElement Adjudication details
Slice: Unordered, Open by value:category
..... adjudication:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
..... adjudication:adjustmentreason S 0..* BackboneElement Reason codes used to interpret the Non-Covered Amount (92)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


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: adjustmentreason
...... reason S 1..1 CodeableConcept Explanation of adjudication outcome
Binding: X12 Claim Adjustment Reason Codes - Remittance Advice Remark Codes Value Set (required)
..... adjudication:allowedunits S 0..1 BackboneElement The quantity of units, times, days, visits, services, or treatments for the service described by the HCPCS code, revenue code or procedure code, submitted by the provider. (149)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


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: allowedunits
...... value S 1..1 decimal Non-monitary value
..... adjudication:adjudicationamounttype S 0..* BackboneElement Line level adjudication type and amount
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
...... amount S 1..1 Money Monetary amount
... Slices for adjudication S 1..* BackboneElement Header-level adjudication
Slice: Unordered, Open by value:category
.... adjudication:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Category Discriminator Value Set (extensible)
.... adjudication:billingnetworkstatus S 0..1 BackboneElement Billing provider network status
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


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)
.... adjudication:benefitpaymentstatus S 1..1 BackboneElement Indicates the in network or out of network payment status of the claim. (142)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


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)
.... adjudication:adjustmentreason S 0..* BackboneElement Reason codes used to interpret the Non-Covered Amount (92)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


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: adjustmentreason
..... reason S 1..1 CodeableConcept Explanation of adjudication outcome
Binding: X12 Claim Adjustment Reason Codes - Remittance Advice Remark Codes Value Set (required)
.... adjudication:adjudicationamounttype S 0..* BackboneElement Claim level adjudication type and amount
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category S 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
..... amount 1..1 Money Monetary amount
... Slices for total SΣ 1..* BackboneElement Adjudication totals
Slice: Unordered, Open by value:category
.... total:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category SΣ 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Total Category Discriminator Value Set (extensible)
..... amount Σ 1..1 Money Financial total for the category
.... total:adjudicationamounttype SΣ 1..* BackboneElement Total adjudication type and amount
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category Σ 1..1 CodeableConcept Type of adjudication information
Binding: C4BB Adjudication Value Set (required)
..... amount SΣ 1..1 Money Financial total for the category
... payment S 0..1 BackboneElement Payment Details
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 0..1 CodeableConcept Partial or complete payment
Binding: C4BB Payer Claim Payment Status Code Value Set (required)
.... date S 0..1 date Expected date of payment
... processNote S 0..* BackboneElement Note concerning adjudication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Note explanatory text

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: institutional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ExplanationOfBenefit.subTyperequiredPattern: inpatient
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBInstitutionalClaimSubType
from this IG
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.rolerequiredC4BBClaimInstitutionalCareTeamRole
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInstitutionalCareTeamRole
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:admissionperiod.categoryextensiblePattern: admissionperiod
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:clmrecvddate.categoryextensiblePattern: clmrecvddate
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:typeofbill.categoryextensiblePattern: typeofbill
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:typeofbill.coderequiredAHANUBCTypeOfBill
http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCTypeOfBill
from this IG
ExplanationOfBenefit.supportingInfo:pointoforigin.categoryextensiblePattern: pointoforigin
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:pointoforigin.coderequiredAHANUBCPointOfOriginForAdmissionOrVisit
http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPointOfOriginForAdmissionOrVisit
from this IG
ExplanationOfBenefit.supportingInfo:admtype.categoryextensiblePattern: admtype
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:admtype.coderequiredAHANUBCPriorityTypeOfAdmissionOrVisit
http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPriorityTypeOfAdmissionOrVisit
from this IG
ExplanationOfBenefit.supportingInfo:discharge-status.categoryextensiblePattern: discharge-status
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:discharge-status.coderequiredAHANUBCPatientDischargeStatus
http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPatientDischargeStatus
from this IG
ExplanationOfBenefit.supportingInfo:drg.categoryextensiblePattern: drg
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:drg.codeextensibleCMSMS3MAPAPRDRG
http://hl7.org/fhir/us/carin-bb/ValueSet/CMSMS3MAPAPRDRG
from this IG
ExplanationOfBenefit.supportingInfo:medicalrecordnumber.categoryextensiblePattern: medicalrecordnumber
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.supportingInfo:patientaccountnumber.categoryextensiblePattern: patientaccountnumber
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType
from this IG
ExplanationOfBenefit.diagnosis.diagnosis[x]requiredCDCICD910CMDiagnosisCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/CDCICD910CMDiagnosisCodes
from this IG
ExplanationOfBenefit.diagnosis.typerequiredC4BBClaimInpatientInstitutionalDiagnosisType
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInpatientInstitutionalDiagnosisType
from this IG
ExplanationOfBenefit.diagnosis.onAdmissionrequiredCMSPresentOnAdmissionIndicator
http://hl7.org/fhir/us/carin-bb/ValueSet/CMSPresentOnAdmissionIndicator
from this IG
ExplanationOfBenefit.procedure.typerequiredC4BBClaimProcedureType (a valid code from C4BB Claim Procedure Type Code System)
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimProcedureType
from this IG
ExplanationOfBenefit.procedure.procedure[x]requiredCMSICD910PCSProcedureCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/CMSICD910PCSProcedureCodes
from this IG
ExplanationOfBenefit.item.revenuerequiredAHANUBCRevenueCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCRevenueCodes
from this IG
ExplanationOfBenefit.item.productOrServicerequiredC4BBEOBInstitutionalProcedureCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBEOBInstitutionalProcedureCodes
from this IG
ExplanationOfBenefit.item.modifierrequiredAMACPTCMSHCPCSModifiers
http://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers
from this IG
ExplanationOfBenefit.item.adjudication.categoryextensibleC4BBAdjudicationCategoryDiscriminator
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.item.adjudication:adjustmentreason.categoryexamplePattern: adjustmentreason
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ExplanationOfBenefit.item.adjudication:adjustmentreason.reasonrequiredX12ClaimAdjustmentReasonCodesCMSRemittanceAdviceRemarkCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/X12ClaimAdjustmentReasonCodesCMSRemittanceAdviceRemarkCodes
from this IG
ExplanationOfBenefit.item.adjudication:allowedunits.categoryexamplePattern: allowedunits
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ExplanationOfBenefit.item.adjudication:adjudicationamounttype.categoryrequiredC4BBAdjudication
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication
from this IG
ExplanationOfBenefit.adjudication.categoryextensibleC4BBAdjudicationCategoryDiscriminator
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator
from this IG
ExplanationOfBenefit.adjudication:billingnetworkstatus.categoryexamplePattern: billingnetworkstatus
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ExplanationOfBenefit.adjudication:billingnetworkstatus.reasonrequiredC4BBPayerProviderNetworkStatus
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus
from this IG
ExplanationOfBenefit.adjudication:benefitpaymentstatus.categoryexamplePattern: benefitpaymentstatus
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reasonrequiredC4BBPayerBenefitPaymentStatus
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus
from this IG
ExplanationOfBenefit.adjudication:adjustmentreason.categoryexamplePattern: adjustmentreason
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ExplanationOfBenefit.adjudication:adjustmentreason.reasonrequiredX12ClaimAdjustmentReasonCodesCMSRemittanceAdviceRemarkCodes
http://hl7.org/fhir/us/carin-bb/ValueSet/X12ClaimAdjustmentReasonCodesCMSRemittanceAdviceRemarkCodes
from this IG
ExplanationOfBenefit.adjudication:adjudicationamounttype.categoryrequiredC4BBAdjudication
http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication
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-institutional-inpatient-meta-profile-versionwarningExplanationOfBenefitInstitutional Inpatient 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-Inpatient-Institutional|2.1'))
EOB-institutional-item-or-header-adjudicationerrorExplanationOfBenefitInstitutional EOB: Should have adjudication with adjudicationamounttype slice at the item or header level, but not both
: adjudication.where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists() != item.adjudication.where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists()
adjudication-has-amount-type-sliceerrorExplanationOfBenefit.itemIf Adjudication is present, it must have at least one adjudicationamounttype slice
: (adjudication.exists().not() or adjudication.where(category.memberOf('http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudication')).exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit C 0..* C4BBExplanationOfBenefitInpatientInstitutionalBasis Explanation of Benefit resource
EOB-inst-pointoforigin: Where Admission Type and Point of Origin slices exist, if Type of Admission code is Newborn, Point of Origin must be from Point of Origin - Newborn CodeSystem or Type of Admission is not Newborn and Point of Origin must be from Point of Origin Nonnewborn CodeSystem.
EOB-institutional-inpatient-meta-profile-version: Institutional Inpatient EOB: meta.profile with canonical and major.minor. version required.
EOB-institutional-item-or-header-adjudication: Institutional EOB: Should have adjudication with adjudicationamounttype slice at the item or header level, but not both
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Business Identifier for the resource
Slice: Unordered, Open by value:type
.... identifier:uniqueclaimid S 1..1 Identifier Unique Claim Identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: uc
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Unique Claim Identifier
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: ExplanationOfBenefitStatus (required): A code specifying the state of the resource instance.

... type SΣ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subType S 1..1 CodeableConcept More granular claim type
Binding: C4BB Institutional Claim SubType Value Set (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBInstitutionalClaimSubType
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: inpatient
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... use SΣ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Complete, proposed, exploratory, other.


Required Pattern: claim
... patient SΣ 1..1 Reference(C4BB Patient) The recipient of the products and services
... billablePeriod SΣ 1..1 Period Relevant time frame for the claim
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... created SΣ 1..1 dateTime Response creation date
... enterer 0..1 Reference(Practitioner | PractitionerRole) Author of the claim
... insurer SΣ 1..1 Reference(C4BB Organization) Party responsible for reimbursement
... provider SΣ 1..1 Reference(C4BB Organization) Party responsible for the claim
... priority 0..1 CodeableConcept Desired processing urgency
Binding: ProcessPriorityCodes (required)
... fundsReserveRequested 0..1 CodeableConcept For whom to reserve funds
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... fundsReserve 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... related S 0..* BackboneElement Prior or corollary claims
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... claim 0..1 Reference(Claim) Reference to the related claim
.... relationship S 1..1 CodeableConcept How the reference claim is related
Binding: C4BB Related Claim Relationship Codes Value Set (required)
.... reference S 1..1 Identifier File or case reference
... prescription 0..1 Reference(MedicationRequest | VisionPrescription) Prescription authorizing services or products
... originalPrescription 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller
... payee SC 0..1 BackboneElement Recipient of benefits payable
EOB-payee-other-type-requires-party: Base EOB: if payee type is other, payee party is required
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Category of recipient
Binding: C4BB Payee Type Value Set (required)
.... party S 0..1 Reference(C4BB Organization | C4BB Patient | C4BB Practitioner | C4BB RelatedPerson) Recipient reference
... referral 0..1 Reference(ServiceRequest) Treatment Referral
... facility 0..1 Reference(Location) Servicing Facility
... claim 0..1 Reference(Claim) Claim reference
... claimResponse 0..1 Reference(ClaimResponse) Claim response reference
... outcome SΣ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition 0..1 string Disposition Message
... preAuthRef 0..* string Preauthorization reference
... preAuthRefPeriod 0..* Period Preauthorization in-effect period
... careTeam SC 0..* BackboneElement Care Team members
EOB-inst-careTeam-practitioner: Institutional EOB: Careteam roles refer to a practitioner
EOB-inst-careTeam-organization: Institutional EOB: Careteam roles refer to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Order of care team
.... provider S 1..1 Reference(C4BB Organization | C4BB Practitioner) Practitioner or organization
.... responsible 0..1 boolean Indicator of the lead practitioner
.... role S 1..1 CodeableConcept Function within the team
Binding: C4BB Claim Institutional Care Team Role Value Set (required)
.... qualification 0..1 CodeableConcept Practitioner credential or specialization
Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications.

... Slices for supportingInfo S 1..* BackboneElement Supporting information
Slice: Unordered, Open by value:category
.... supportingInfo:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
..... code 0..1 CodeableConcept Type of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

..... timing[x] 0..1 When it occurred
...... timingDate date
...... timingPeriod Period
..... value[x] 0..1 Data to be provided
...... valueBoolean boolean
...... valueString string
...... valueQuantity Quantity
...... valueAttachment Attachment
...... valueReference Reference(Resource)
..... reason 0..1 Coding Explanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

.... supportingInfo:admissionperiod S 1..1 BackboneElement Admission Period
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: admissionperiod
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... code 0..1 CodeableConcept Type of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

..... Slices for timing[x] 1..1 Period When it occurred
Slice: Unordered, Closed by type:$this
...... timing[x]:timingPeriod S 1..1 Period When it occurred
..... value[x] 0..1 Data to be provided
...... valueBoolean boolean
...... valueString string
...... valueQuantity Quantity
...... valueAttachment Attachment
...... valueReference Reference(Resource)
..... reason 0..1 Coding Explanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

.... supportingInfo:clmrecvddate S 0..1 BackboneElement Claim received date
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: clmrecvddate
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... code 0..1 CodeableConcept Type of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

..... timing[x] S 1..1 date When it occurred
..... value[x] 0..1 Data to be provided
...... valueBoolean boolean
...... valueString string
...... valueQuantity Quantity
...... valueAttachment Attachment
...... valueReference Reference(Resource)
..... reason 0..1 Coding Explanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

.... supportingInfo:typeofbill S 0..1 BackboneElement Type of bill
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: typeofbill
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... code S 1..1 CodeableConcept Type of information
Binding: NUBC Type of Bill Codes Value Set (required)
..... timing[x] 0..1 When it occurred
...... timingDate date
...... timingPeriod Period
..... value[x] 0..1 Data to be provided
...... valueBoolean boolean
...... valueString string
...... valueQuantity Quantity
...... valueAttachment Attachment
...... valueReference Reference(Resource)
..... reason 0..1 Coding Explanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

.... supportingInfo:pointoforigin S 0..1 BackboneElement Point of origin for admission
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... sequence 1..1 positiveInt Information instance identifier
..... category S 1..1 CodeableConcept Classification of the supplied information
Binding: C4BB SupportingInfo Type Value Set (extensible)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: pointoforigin
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... code S 1..1 CodeableConcept Type of information
Binding: NUBC Point Of Origin Value Set (required)
..... timing[x] 0..1 When it occurred
...... timingDate date
...... timingPeriod Period
..... value[x] 0..1 Data to be provided
...... valueBoolean boolean
...... valueString string
......