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
Official URL: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy-Basis | Version: 2.1.0 | |||
Standards status: Trial-use | Computable Name: C4BBExplanationOfBenefitPharmacyBasis |
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 basis profile does not have requirements for financial data.
This profile is defines the base requirements for a Pharmacy ExplanationOfBenefit. All of the requirements are an exact subset of the original profile from earlier versions with only the financial data element requirements removed in order to address the use case of sharing Non-Financial Claims Data that enables other FHIR Implementation Guides to support communication of ExplanationOfBenefit data without financial data. These profiles are not expected to be implemented directly within the context of the consumer directed data exchange use case defined by this guide, but rather from within the context in which external guides may define (e.g. Provider Access API of PDEX).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from C4BBExplanationOfBenefit
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | C4BBExplanationOfBenefit | Explanation of Benefit resource | |
identifier | S | 1..* | Identifier | Business Identifier for the resource |
type | 1..1 | CodeableConcept | Category or discipline 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 | |
created | S | 1..1 | dateTime | Response creation date |
careTeam | C | 0..* | BackboneElement | Care Team members EOB-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner EOB-pharm-careTeam-organization: Pharmacy EOB: Careteam roles refer to an organization |
role | 1..1 | CodeableConcept | Function within the team Binding: C4BB Claim Pharmacy CareTeam Role Value Set (required) | |
Slices for supportingInfo | 4..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category | |
supportingInfo:dayssupply | S | 1..1 | BackboneElement | Days supply |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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 |
supportingInfo:dawcode | S | 1..1 | BackboneElement | Dispense and written product selection code |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
supportingInfo:refillNum | S | 1..1 | BackboneElement | The number fill of the claim dispensed supply |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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 |
supportingInfo:refillsAuthorized | 1..1 | BackboneElement | Number or refills authorized by prescriber | |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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 |
supportingInfo:brandgenericindicator | S | 0..1 | BackboneElement | Plan reported brand or generic drug indicator |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
supportingInfo:rxoriginCode | S | 0..1 | BackboneElement | Prescription origin code |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
supportingInfo:clmrecvddate | S | 0..1 | BackboneElement | Claim received date |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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:compoundcode | S | 0..1 | BackboneElement | Code indicating whether or not the prescription is a compound |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
item | ||||
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: NDC or Compound Value Set (required) |
serviced[x] | S | 1..1 | date | Date or dates of service or product delivery |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
Slices for adjudication | S | 0..* | BackboneElement | Adjudication details Slice: Unordered, Open by value:category |
adjudication:All Slices | Content/Rules for all slices | |||
category | 1..1 | CodeableConcept | Type of adjudication information Binding: C4BB Adjudication Category Discriminator Value Set (extensible) | |
adjudication:rejectreason | S | 0..1 | BackboneElement | Reason codes used to interpret the Non-Covered Amount (92) |
category | 1..1 | CodeableConcept | Type of adjudication information 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) |
detail | S | 0..* | BackboneElement | Additional items |
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: National Drug Code (NDC) Value Set (required) |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
Slices for adjudication | S | 1..* | BackboneElement | Header-level adjudication Slice: Unordered, Open by value:category |
adjudication:All Slices | Content/Rules for all slices | |||
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 networking status |
category | 1..1 | CodeableConcept | Type of adjudication information 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) |
category | 1..1 | CodeableConcept | Type of adjudication information 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) |
total | ||||
amount | S | 1..1 | Money | Financial total for the category |
payment | ||||
date | S | 0..1 | date | Expected date of payment |
processNote | ||||
text | S | 0..1 | string | Note explanatory text |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ExplanationOfBenefit.careTeam.role | required | C4BBClaimPharmacyTeamRolehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole from this IG | |
ExplanationOfBenefit.supportingInfo:dawcode.code | required | NCPDPDispensedAsWrittenOrProductSelectionCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode from this IG | |
ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | required | NCPDPBrandGenericIndicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator from this IG | |
ExplanationOfBenefit.supportingInfo:rxoriginCode.code | required | NCPDPPrescriptionOriginCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode from this IG | |
ExplanationOfBenefit.supportingInfo:compoundcode.code | required | NCPDPCompoundCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode from this IG | |
ExplanationOfBenefit.item.productOrService | required | FDANDCOrCompoundhttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound from this IG | |
ExplanationOfBenefit.item.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.item.adjudication:rejectreason.reason | required | NCPDPRejectCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode from this IG | |
ExplanationOfBenefit.item.detail.productOrService | required | FDANationalDrugCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode from this IG | |
ExplanationOfBenefit.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | required | C4BBPayerProviderNetworkStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus from this IG | |
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | required | C4BBPayerBenefitPaymentStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus from this IG |
Id | Grade | Path(s) | Details | Requirements |
EOB-pharm-careTeam-organization | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to an organization : ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies provider.all(resolve() is Organization) ) | |
EOB-pharm-careTeam-practitioner | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to a practitioner : ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies provider.all(resolve() is Organization) ) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | C4BBExplanationOfBenefit | 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 | |
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 |
Slices for identifier | S | 1..* | Identifier | Business Identifier for the resource Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
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 | 0..* | 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: AdjudicationValueCodes (example): The adjudication codes. 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 |
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 | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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 | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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 |
total | Σ | 0..* | BackboneElement | Adjudication totals 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 | Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ExplanationOfBenefit.identifier:uniqueclaimid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.identifier:uniqueclaimid.type | extensible | Pattern: uchttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
ExplanationOfBenefit.status | required | ExplanationOfBenefitStatushttp://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.type | required | Pattern: pharmacyhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | |
ExplanationOfBenefit.use | required | Pattern: claimhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.related.relationship | required | C4BBRelatedClaimRelationshipCodeshttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBRelatedClaimRelationshipCodes from this IG | |
ExplanationOfBenefit.payee.type | required | C4BBPayeeTypehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayeeType from this IG | |
ExplanationOfBenefit.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.careTeam.role | required | C4BBClaimPharmacyTeamRolehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole from this IG | |
ExplanationOfBenefit.supportingInfo.category | extensible | C4BBSupportingInfoType (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.category | extensible | Pattern: dayssupplyhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:dawcode.category | extensible | Pattern: dawcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:dawcode.code | required | NCPDPDispensedAsWrittenOrProductSelectionCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode from this IG | |
ExplanationOfBenefit.supportingInfo:refillNum.category | extensible | Pattern: refillnumhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | extensible | Pattern: refillsauthorizedhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | extensible | Pattern: brandgenericindicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | required | NCPDPBrandGenericIndicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator from this IG | |
ExplanationOfBenefit.supportingInfo:rxoriginCode.category | extensible | Pattern: rxorigincodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:rxoriginCode.code | required | NCPDPPrescriptionOriginCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode from this IG | |
ExplanationOfBenefit.supportingInfo:clmrecvddate.category | extensible | Pattern: clmrecvddatehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:compoundcode.category | extensible | Pattern: compoundcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:compoundcode.code | required | NCPDPCompoundCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode from this IG | |
ExplanationOfBenefit.item.productOrService | required | FDANDCOrCompoundhttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound from this IG | |
ExplanationOfBenefit.item.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.item.adjudication:rejectreason.category | example | Pattern: rejectreasonhttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.item.adjudication:rejectreason.reason | required | NCPDPRejectCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode from this IG | |
ExplanationOfBenefit.item.detail.productOrService | required | FDANationalDrugCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode from this IG | |
ExplanationOfBenefit.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.adjudication:billingnetworkstatus.category | example | Pattern: billingnetworkstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | required | C4BBPayerProviderNetworkStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus from this IG | |
ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | example | Pattern: benefitpaymentstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | required | C4BBPayerBenefitPaymentStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus from this IG | |
ExplanationOfBenefit.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.payment.type | required | C4BBPayerClaimPaymentStatusCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerClaimPaymentStatusCode from this IG |
Id | Grade | Path(s) | Details | Requirements |
EOB-pharm-careTeam-organization | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to an organization : ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies provider.all(resolve() is Organization) ) | |
EOB-pharm-careTeam-practitioner | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to a practitioner : ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies provider.all(resolve() is Organization) ) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ExplanationOfBenefit | 0..* | C4BBExplanationOfBenefit | Explanation of Benefit resource | |||||
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.
| |||||
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: pharmacy | |||||
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 | 0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
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 | Σ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 | C4BB Practitioner) | 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-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner EOB-pharm-careTeam-organization: Pharmacy 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 Pharmacy CareTeam Role Value Set (required) | ||||
qualification | 0..1 | CodeableConcept | Practitioner credential or specialization Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications. | |||||
Slices for supportingInfo | S | 4..* | 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:dayssupply | S | 1..1 | BackboneElement | Days supply | ||||
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: dayssupply | |||||
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] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | S | 1..1 | Quantity | Data to be provided | ||||
reason | 0..1 | Coding | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
supportingInfo:dawcode | S | 1..1 | BackboneElement | Dispense and written product selection code | ||||
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: dawcode | |||||
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: NCPDP Dispense As Written (DAW)/Product Selection Code 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:refillNum | S | 1..1 | BackboneElement | The number fill of the claim dispensed supply | ||||
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: refillnum | |||||
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] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | S | 1..1 | Quantity | Data to be provided | ||||
reason | 0..1 | Coding | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
supportingInfo:refillsAuthorized | S | 1..1 | BackboneElement | Number or refills authorized by prescriber | ||||
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: refillsauthorized | |||||
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] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | S | 1..1 | Quantity | Data to be provided | ||||
reason | 0..1 | Coding | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
supportingInfo:brandgenericindicator | S | 0..1 | BackboneElement | Plan reported brand or generic drug indicator | ||||
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: brandgenericindicator | |||||
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: NCPDP Brand Generic Indicator 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:rxoriginCode | S | 0..1 | BackboneElement | Prescription origin code | ||||
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: rxorigincode | |||||
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: NCPDP Prescription Origin Code 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: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:compoundcode | S | 0..1 | BackboneElement | Code indicating whether or not the prescription is a compound | ||||
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: compoundcode | |||||
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: NCPDP Compound Code 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. | |||||
diagnosis | 0..* | BackboneElement | Pertinent diagnosis information | |||||
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 | Diagnosis instance identifier | |||||
diagnosis[x] | 1..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||||||
diagnosisCodeableConcept | CodeableConcept | |||||||
diagnosisReference | Reference(Condition) | |||||||
type | 0..* | CodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. | |||||
onAdmission | 0..1 | CodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. | |||||
packageCode | 0..1 | CodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. | |||||
procedure | 0..* | BackboneElement | Clinical procedures performed | |||||
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 | Procedure instance identifier | |||||
type | 0..* | CodeableConcept | Category of Procedure Binding: ExampleProcedureTypeCodes (example): Example procedure type codes. | |||||
date | 0..1 | dateTime | When the procedure was performed | |||||
procedure[x] | 1..1 | Specific clinical procedure Binding: ICD-10ProcedureCodes (example): ICD10 Procedure codes. | ||||||
procedureCodeableConcept | CodeableConcept | |||||||
procedureReference | Reference(Procedure) | |||||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
precedence | 0..1 | positiveInt | Precedence (primary, secondary, etc.) | |||||
insurance | SΣC | 1..* | BackboneElement | Patient insurance information EOB-insurance-focal: EOB.insurance: at most one with focal = true | ||||
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 | ||||
focal | SΣ | 1..1 | boolean | Coverage to be used for adjudication | ||||
coverage | SΣ | 1..1 | Reference(C4BB Coverage) | Insurance information | ||||
preAuthRef | 0..* | string | Prior authorization reference number | |||||
accident | 0..1 | BackboneElement | Details of the event | |||||
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 | ||||
date | 0..1 | date | When the incident occurred | |||||
type | 0..1 | CodeableConcept | The nature of the accident Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc. | |||||
location[x] | 0..1 | Where the event occurred | ||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
item | S | 1..* | BackboneElement | Product or service provided | ||||
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 | S | 1..1 | positiveInt | Item instance identifier | ||||
careTeamSequence | 0..* | positiveInt | Applicable care team members | |||||
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |||||
procedureSequence | 0..* | positiveInt | Applicable procedures | |||||
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: NDC or Compound Value Set (required) | ||||
modifier | 0..* | CodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
serviced[x] | S | 1..1 | date | Date or dates of service or product delivery | ||||
location[x] | 0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place where the service is rendered. | ||||||
locationCodeableConcept | CodeableConcept | |||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
quantity | S | 0..1 | SimpleQuantity | Count of products or services | ||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
bodySite | 0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
subSite | 0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |||||
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 | |||||||
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 | ||||
category | S | 1..1 | CodeableConcept | Type of adjudication information Binding: C4BB Adjudication Category Discriminator Value Set (extensible) | ||||
reason | 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): Adjudication reason codes. | |||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
adjudication:rejectreason | S | 0..1 | BackboneElement | Reason codes used to interpret the Non-Covered Amount (92) | ||||
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 | ||||
category | S | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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/C4BBAdjudicationDiscriminator | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rejectreason | |||||
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 | |||||
reason | S | 1..1 | CodeableConcept | Explanation of adjudication outcome Binding: NCPDP Reject Code Value Set (required) | ||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
detail | S | 0..* | BackboneElement | Additional items | ||||
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 | Product or service provided | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: National Drug Code (NDC) Value Set (required) | ||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | S | 0..1 | SimpleQuantity | Count of products or services | ||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Detail level adjudication details | |||||
subDetail | 0..* | BackboneElement | Additional items | |||||
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 | Product or service provided | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Subdetail level adjudication details | |||||
addItem | 0..* | BackboneElement | Insurer added line items | |||||
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 | ||||
itemSequence | 0..* | positiveInt | Item sequence number | |||||
detailSequence | 0..* | positiveInt | Detail sequence number | |||||
subDetailSequence | 0..* | positiveInt | Subdetail sequence number | |||||
provider | 0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
serviced[x] | 0..1 | Date or dates of service or product delivery | ||||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
location[x] | 0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place where the service is rendered. | ||||||
locationCodeableConcept | CodeableConcept | |||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
bodySite | 0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
subSite | 0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Added items adjudication | |||||
detail | 0..* | BackboneElement | Insurer added line items | |||||
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 | ||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Added items adjudication | |||||
subDetail | 0..* | BackboneElement | Insurer added line items | |||||
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 | ||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Added items adjudication | |||||
Slices for adjudication | S | 1..* | BackboneElement | Header-level adjudication Slice: Unordered, Open by value:category | ||||
adjudication: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 | ||||
category | S | 1..1 | CodeableConcept | Type of adjudication information Binding: C4BB Adjudication Category Discriminator Value Set (extensible) | ||||
reason | 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): Adjudication reason codes. | |||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
adjudication:billingnetworkstatus | S | 0..1 | BackboneElement | Billing provider networking status | ||||
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 | ||||
category | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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/C4BBAdjudicationDiscriminator | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: billingnetworkstatus | |||||
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 | |||||
reason | S | 1..1 | CodeableConcept | Explanation of adjudication outcome Binding: C4BB Payer Provider Network Status Value Set (required) | ||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
adjudication:benefitpaymentstatus | S | 1..1 | BackboneElement | Indicates the in network or out of network payment status of the claim. (142) | ||||
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 | ||||
category | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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/C4BBAdjudicationDiscriminator | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: benefitpaymentstatus | |||||
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 | |||||
reason | S | 1..1 | CodeableConcept | Explanation of adjudication outcome Binding: C4BB Payer Benefit Payment Status Value Set (required) | ||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
total | Σ | 0..* | BackboneElement | Adjudication totals | ||||
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 | ||||
category | Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | ||||
amount | SΣ | 1..1 | Money | Financial total for the category | ||||
payment | S | 0..1 | BackboneElement | Payment Details | ||||
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 | 0..1 | CodeableConcept | Partial or complete payment Binding: C4BB Payer Claim Payment Status Code Value Set (required) | ||||
adjustment | 0..1 | Money | Payment adjustment for non-claim issues | |||||
adjustmentReason | 0..1 | CodeableConcept | Explanation for the variance Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes. | |||||
date | S | 0..1 | date | Expected date of payment | ||||
amount | 0..1 | Money | Payable amount after adjustment | |||||
identifier | 0..1 | Identifier | Business identifier for the payment | |||||
formCode | 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |||||
form | 0..1 | Attachment | Printed reference or actual form | |||||
processNote | S | 0..* | BackboneElement | Note concerning adjudication | ||||
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 | ||||
number | 0..1 | positiveInt | Note instance identifier | |||||
type | 0..1 | code | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
text | S | 0..1 | string | Note explanatory text | ||||
language | 0..1 | CodeableConcept | Language of the text Binding: CommonLanguages (preferred): A human language.
| |||||
benefitPeriod | 0..1 | Period | When the benefits are applicable | |||||
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |||||
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 | ||||
category | 1..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
excluded | 0..1 | boolean | Excluded from the plan | |||||
name | 0..1 | string | Short name for the benefit | |||||
description | 0..1 | string | Description of the benefit or services covered | |||||
network | 0..1 | CodeableConcept | In or out of network Binding: NetworkTypeCodes (example): Code to classify in or out of network services. | |||||
unit | 0..1 | CodeableConcept | Individual or family Binding: UnitTypeCodes (example): Unit covered/serviced - individual or family. | |||||
term | 0..1 | CodeableConcept | Annual or lifetime Binding: BenefitTermCodes (example): Coverage unit - annual, lifetime. | |||||
financial | 0..* | BackboneElement | Benefit Summary | |||||
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 | 1..1 | CodeableConcept | Benefit classification Binding: BenefitTypeCodes (example): Deductable, visits, co-pay, etc. | |||||
allowed[x] | 0..1 | Benefits allowed | ||||||
allowedUnsignedInt | unsignedInt | |||||||
allowedString | string | |||||||
allowedMoney | Money | |||||||
used[x] | 0..1 | Benefits used | ||||||
usedUnsignedInt | unsignedInt | |||||||
usedMoney | Money | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ExplanationOfBenefit.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ExplanationOfBenefit.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
ExplanationOfBenefit.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ExplanationOfBenefit.identifier:uniqueclaimid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.identifier:uniqueclaimid.type | extensible | Pattern: uchttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ExplanationOfBenefit.status | required | ExplanationOfBenefitStatushttp://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.type | required | Pattern: pharmacyhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | ||||
ExplanationOfBenefit.subType | example | ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype from the FHIR Standard | ||||
ExplanationOfBenefit.use | required | Pattern: claimhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.priority | required | ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | ||||
ExplanationOfBenefit.fundsReserveRequested | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
ExplanationOfBenefit.fundsReserve | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
ExplanationOfBenefit.related.relationship | required | C4BBRelatedClaimRelationshipCodeshttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBRelatedClaimRelationshipCodes from this IG | ||||
ExplanationOfBenefit.payee.type | required | C4BBPayeeTypehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayeeType from this IG | ||||
ExplanationOfBenefit.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.careTeam.role | required | C4BBClaimPharmacyTeamRolehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole from this IG | ||||
ExplanationOfBenefit.careTeam.qualification | example | ExampleProviderQualificationCodeshttp://hl7.org/fhir/ValueSet/provider-qualification from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo.category | extensible | C4BBSupportingInfoType (a valid code from C4BB Supporting Info Type Code System)http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:dayssupply.category | extensible | Pattern: dayssupplyhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:dayssupply.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:dayssupply.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:dawcode.category | extensible | Pattern: dawcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:dawcode.code | required | NCPDPDispensedAsWrittenOrProductSelectionCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode from this IG | ||||
ExplanationOfBenefit.supportingInfo:dawcode.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillNum.category | extensible | Pattern: refillnumhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:refillNum.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillNum.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | extensible | Pattern: refillsauthorizedhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:refillsAuthorized.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillsAuthorized.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | extensible | Pattern: brandgenericindicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | required | NCPDPBrandGenericIndicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator from this IG | ||||
ExplanationOfBenefit.supportingInfo:brandgenericindicator.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:rxoriginCode.category | extensible | Pattern: rxorigincodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:rxoriginCode.code | required | NCPDPPrescriptionOriginCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode from this IG | ||||
ExplanationOfBenefit.supportingInfo:rxoriginCode.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:clmrecvddate.category | extensible | Pattern: clmrecvddatehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:clmrecvddate.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:clmrecvddate.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:compoundcode.category | extensible | Pattern: compoundcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:compoundcode.code | required | NCPDPCompoundCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode from this IG | ||||
ExplanationOfBenefit.supportingInfo:compoundcode.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.diagnosis[x] | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.type | example | ExampleDiagnosisTypeCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosistype from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.onAdmission | example | ExampleDiagnosisOnAdmissionCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.packageCode | example | ExampleDiagnosisRelatedGroupCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup from the FHIR Standard | ||||
ExplanationOfBenefit.procedure.type | example | ExampleProcedureTypeCodeshttp://hl7.org/fhir/ValueSet/ex-procedure-type from the FHIR Standard | ||||
ExplanationOfBenefit.procedure.procedure[x] | example | ICD-10ProcedureCodeshttp://hl7.org/fhir/ValueSet/icd-10-procedures from the FHIR Standard | ||||
ExplanationOfBenefit.accident.type | extensible | ActIncidentCodehttp://terminology.hl7.org/ValueSet/v3-ActIncidentCode | ||||
ExplanationOfBenefit.item.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
ExplanationOfBenefit.item.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.item.productOrService | required | FDANDCOrCompoundhttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound from this IG | ||||
ExplanationOfBenefit.item.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.item.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.item.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
ExplanationOfBenefit.item.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
ExplanationOfBenefit.item.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
ExplanationOfBenefit.item.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | ||||
ExplanationOfBenefit.item.adjudication.reason | example | AdjudicationReasonCodeshttp://hl7.org/fhir/ValueSet/adjudication-reason from the FHIR Standard | ||||
ExplanationOfBenefit.item.adjudication:rejectreason.category | example | Pattern: rejectreasonhttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.item.adjudication:rejectreason.reason | required | NCPDPRejectCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode from this IG | ||||
ExplanationOfBenefit.item.detail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.productOrService | required | FDANationalDrugCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode from this IG | ||||
ExplanationOfBenefit.item.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | ||||
ExplanationOfBenefit.adjudication.reason | example | AdjudicationReasonCodeshttp://hl7.org/fhir/ValueSet/adjudication-reason from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication:billingnetworkstatus.category | example | Pattern: billingnetworkstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | required | C4BBPayerProviderNetworkStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus from this IG | ||||
ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | example | Pattern: benefitpaymentstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | required | C4BBPayerBenefitPaymentStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus from this IG | ||||
ExplanationOfBenefit.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.payment.type | required | C4BBPayerClaimPaymentStatusCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerClaimPaymentStatusCode from this IG | ||||
ExplanationOfBenefit.payment.adjustmentReason | example | PaymentAdjustmentReasonCodeshttp://hl7.org/fhir/ValueSet/payment-adjustment-reason from the FHIR Standard | ||||
ExplanationOfBenefit.formCode | example | Form Codeshttp://hl7.org/fhir/ValueSet/forms from the FHIR Standard | ||||
ExplanationOfBenefit.processNote.type | required | NoteTypehttp://hl7.org/fhir/ValueSet/note-type|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.processNote.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ExplanationOfBenefit.benefitBalance.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.network | example | NetworkTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-network from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.unit | example | UnitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-unit from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.term | example | BenefitTermCodeshttp://hl7.org/fhir/ValueSet/benefit-term from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.financial.type | example | BenefitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
EOB-pharm-careTeam-organization | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to an organization : ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies provider.all(resolve() is Organization) ) | |
EOB-pharm-careTeam-practitioner | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to a practitioner : ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies provider.all(resolve() is Organization) ) |
This structure is derived from C4BBExplanationOfBenefit
Summary
Mandatory: 12 elements(7 nested mandatory elements)
Must-Support: 43 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from C4BBExplanationOfBenefit
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | C4BBExplanationOfBenefit | Explanation of Benefit resource | |
identifier | S | 1..* | Identifier | Business Identifier for the resource |
type | 1..1 | CodeableConcept | Category or discipline 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 | |
created | S | 1..1 | dateTime | Response creation date |
careTeam | C | 0..* | BackboneElement | Care Team members EOB-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner EOB-pharm-careTeam-organization: Pharmacy EOB: Careteam roles refer to an organization |
role | 1..1 | CodeableConcept | Function within the team Binding: C4BB Claim Pharmacy CareTeam Role Value Set (required) | |
Slices for supportingInfo | 4..* | BackboneElement | Supporting information Slice: Unordered, Open by value:category | |
supportingInfo:dayssupply | S | 1..1 | BackboneElement | Days supply |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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 |
supportingInfo:dawcode | S | 1..1 | BackboneElement | Dispense and written product selection code |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
supportingInfo:refillNum | S | 1..1 | BackboneElement | The number fill of the claim dispensed supply |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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 |
supportingInfo:refillsAuthorized | 1..1 | BackboneElement | Number or refills authorized by prescriber | |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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 |
supportingInfo:brandgenericindicator | S | 0..1 | BackboneElement | Plan reported brand or generic drug indicator |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
supportingInfo:rxoriginCode | S | 0..1 | BackboneElement | Prescription origin code |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
supportingInfo:clmrecvddate | S | 0..1 | BackboneElement | Claim received date |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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:compoundcode | S | 0..1 | BackboneElement | Code indicating whether or not the prescription is a compound |
category | S | 1..1 | CodeableConcept | Classification of the supplied information 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) |
item | ||||
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: NDC or Compound Value Set (required) |
serviced[x] | S | 1..1 | date | Date or dates of service or product delivery |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
Slices for adjudication | S | 0..* | BackboneElement | Adjudication details Slice: Unordered, Open by value:category |
adjudication:All Slices | Content/Rules for all slices | |||
category | 1..1 | CodeableConcept | Type of adjudication information Binding: C4BB Adjudication Category Discriminator Value Set (extensible) | |
adjudication:rejectreason | S | 0..1 | BackboneElement | Reason codes used to interpret the Non-Covered Amount (92) |
category | 1..1 | CodeableConcept | Type of adjudication information 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) |
detail | S | 0..* | BackboneElement | Additional items |
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: National Drug Code (NDC) Value Set (required) |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
Slices for adjudication | S | 1..* | BackboneElement | Header-level adjudication Slice: Unordered, Open by value:category |
adjudication:All Slices | Content/Rules for all slices | |||
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 networking status |
category | 1..1 | CodeableConcept | Type of adjudication information 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) |
category | 1..1 | CodeableConcept | Type of adjudication information 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) |
total | ||||
amount | S | 1..1 | Money | Financial total for the category |
payment | ||||
date | S | 0..1 | date | Expected date of payment |
processNote | ||||
text | S | 0..1 | string | Note explanatory text |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ExplanationOfBenefit.careTeam.role | required | C4BBClaimPharmacyTeamRolehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole from this IG | |
ExplanationOfBenefit.supportingInfo:dawcode.code | required | NCPDPDispensedAsWrittenOrProductSelectionCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode from this IG | |
ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | required | NCPDPBrandGenericIndicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator from this IG | |
ExplanationOfBenefit.supportingInfo:rxoriginCode.code | required | NCPDPPrescriptionOriginCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode from this IG | |
ExplanationOfBenefit.supportingInfo:compoundcode.code | required | NCPDPCompoundCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode from this IG | |
ExplanationOfBenefit.item.productOrService | required | FDANDCOrCompoundhttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound from this IG | |
ExplanationOfBenefit.item.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.item.adjudication:rejectreason.reason | required | NCPDPRejectCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode from this IG | |
ExplanationOfBenefit.item.detail.productOrService | required | FDANationalDrugCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode from this IG | |
ExplanationOfBenefit.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | required | C4BBPayerProviderNetworkStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus from this IG | |
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | required | C4BBPayerBenefitPaymentStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus from this IG |
Id | Grade | Path(s) | Details | Requirements |
EOB-pharm-careTeam-organization | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to an organization : ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies provider.all(resolve() is Organization) ) | |
EOB-pharm-careTeam-practitioner | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to a practitioner : ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies provider.all(resolve() is Organization) ) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExplanationOfBenefit | 0..* | C4BBExplanationOfBenefit | 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 | |
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 |
Slices for identifier | S | 1..* | Identifier | Business Identifier for the resource Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
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 | 0..* | 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: AdjudicationValueCodes (example): The adjudication codes. 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 |
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 | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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 | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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 |
total | Σ | 0..* | BackboneElement | Adjudication totals 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 | Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ExplanationOfBenefit.identifier:uniqueclaimid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.identifier:uniqueclaimid.type | extensible | Pattern: uchttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
ExplanationOfBenefit.status | required | ExplanationOfBenefitStatushttp://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.type | required | Pattern: pharmacyhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | |
ExplanationOfBenefit.use | required | Pattern: claimhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.related.relationship | required | C4BBRelatedClaimRelationshipCodeshttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBRelatedClaimRelationshipCodes from this IG | |
ExplanationOfBenefit.payee.type | required | C4BBPayeeTypehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayeeType from this IG | |
ExplanationOfBenefit.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | |
ExplanationOfBenefit.careTeam.role | required | C4BBClaimPharmacyTeamRolehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole from this IG | |
ExplanationOfBenefit.supportingInfo.category | extensible | C4BBSupportingInfoType (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.category | extensible | Pattern: dayssupplyhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:dawcode.category | extensible | Pattern: dawcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:dawcode.code | required | NCPDPDispensedAsWrittenOrProductSelectionCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode from this IG | |
ExplanationOfBenefit.supportingInfo:refillNum.category | extensible | Pattern: refillnumhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | extensible | Pattern: refillsauthorizedhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | extensible | Pattern: brandgenericindicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | required | NCPDPBrandGenericIndicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator from this IG | |
ExplanationOfBenefit.supportingInfo:rxoriginCode.category | extensible | Pattern: rxorigincodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:rxoriginCode.code | required | NCPDPPrescriptionOriginCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode from this IG | |
ExplanationOfBenefit.supportingInfo:clmrecvddate.category | extensible | Pattern: clmrecvddatehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:compoundcode.category | extensible | Pattern: compoundcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | |
ExplanationOfBenefit.supportingInfo:compoundcode.code | required | NCPDPCompoundCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode from this IG | |
ExplanationOfBenefit.item.productOrService | required | FDANDCOrCompoundhttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound from this IG | |
ExplanationOfBenefit.item.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.item.adjudication:rejectreason.category | example | Pattern: rejectreasonhttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.item.adjudication:rejectreason.reason | required | NCPDPRejectCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode from this IG | |
ExplanationOfBenefit.item.detail.productOrService | required | FDANationalDrugCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode from this IG | |
ExplanationOfBenefit.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | |
ExplanationOfBenefit.adjudication:billingnetworkstatus.category | example | Pattern: billingnetworkstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | required | C4BBPayerProviderNetworkStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus from this IG | |
ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | example | Pattern: benefitpaymentstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | required | C4BBPayerBenefitPaymentStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus from this IG | |
ExplanationOfBenefit.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ExplanationOfBenefit.payment.type | required | C4BBPayerClaimPaymentStatusCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerClaimPaymentStatusCode from this IG |
Id | Grade | Path(s) | Details | Requirements |
EOB-pharm-careTeam-organization | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to an organization : ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies provider.all(resolve() is Organization) ) | |
EOB-pharm-careTeam-practitioner | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to a practitioner : ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies provider.all(resolve() is Organization) ) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ExplanationOfBenefit | 0..* | C4BBExplanationOfBenefit | Explanation of Benefit resource | |||||
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.
| |||||
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: pharmacy | |||||
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 | 0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
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 | Σ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 | C4BB Practitioner) | 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-pharm-careTeam-practitioner: Pharmacy EOB: Careteam roles refer to a practitioner EOB-pharm-careTeam-organization: Pharmacy 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 Pharmacy CareTeam Role Value Set (required) | ||||
qualification | 0..1 | CodeableConcept | Practitioner credential or specialization Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications. | |||||
Slices for supportingInfo | S | 4..* | 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:dayssupply | S | 1..1 | BackboneElement | Days supply | ||||
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: dayssupply | |||||
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] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | S | 1..1 | Quantity | Data to be provided | ||||
reason | 0..1 | Coding | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
supportingInfo:dawcode | S | 1..1 | BackboneElement | Dispense and written product selection code | ||||
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: dawcode | |||||
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: NCPDP Dispense As Written (DAW)/Product Selection Code 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:refillNum | S | 1..1 | BackboneElement | The number fill of the claim dispensed supply | ||||
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: refillnum | |||||
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] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | S | 1..1 | Quantity | Data to be provided | ||||
reason | 0..1 | Coding | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
supportingInfo:refillsAuthorized | S | 1..1 | BackboneElement | Number or refills authorized by prescriber | ||||
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: refillsauthorized | |||||
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] | 0..1 | When it occurred | ||||||
timingDate | date | |||||||
timingPeriod | Period | |||||||
value[x] | S | 1..1 | Quantity | Data to be provided | ||||
reason | 0..1 | Coding | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
supportingInfo:brandgenericindicator | S | 0..1 | BackboneElement | Plan reported brand or generic drug indicator | ||||
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: brandgenericindicator | |||||
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: NCPDP Brand Generic Indicator 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:rxoriginCode | S | 0..1 | BackboneElement | Prescription origin code | ||||
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: rxorigincode | |||||
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: NCPDP Prescription Origin Code 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: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:compoundcode | S | 0..1 | BackboneElement | Code indicating whether or not the prescription is a compound | ||||
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: compoundcode | |||||
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: NCPDP Compound Code 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. | |||||
diagnosis | 0..* | BackboneElement | Pertinent diagnosis information | |||||
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 | Diagnosis instance identifier | |||||
diagnosis[x] | 1..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||||||
diagnosisCodeableConcept | CodeableConcept | |||||||
diagnosisReference | Reference(Condition) | |||||||
type | 0..* | CodeableConcept | Timing or nature of the diagnosis Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge. | |||||
onAdmission | 0..1 | CodeableConcept | Present on admission Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission. | |||||
packageCode | 0..1 | CodeableConcept | Package billing code Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis. | |||||
procedure | 0..* | BackboneElement | Clinical procedures performed | |||||
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 | Procedure instance identifier | |||||
type | 0..* | CodeableConcept | Category of Procedure Binding: ExampleProcedureTypeCodes (example): Example procedure type codes. | |||||
date | 0..1 | dateTime | When the procedure was performed | |||||
procedure[x] | 1..1 | Specific clinical procedure Binding: ICD-10ProcedureCodes (example): ICD10 Procedure codes. | ||||||
procedureCodeableConcept | CodeableConcept | |||||||
procedureReference | Reference(Procedure) | |||||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
precedence | 0..1 | positiveInt | Precedence (primary, secondary, etc.) | |||||
insurance | SΣC | 1..* | BackboneElement | Patient insurance information EOB-insurance-focal: EOB.insurance: at most one with focal = true | ||||
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 | ||||
focal | SΣ | 1..1 | boolean | Coverage to be used for adjudication | ||||
coverage | SΣ | 1..1 | Reference(C4BB Coverage) | Insurance information | ||||
preAuthRef | 0..* | string | Prior authorization reference number | |||||
accident | 0..1 | BackboneElement | Details of the event | |||||
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 | ||||
date | 0..1 | date | When the incident occurred | |||||
type | 0..1 | CodeableConcept | The nature of the accident Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc. | |||||
location[x] | 0..1 | Where the event occurred | ||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
item | S | 1..* | BackboneElement | Product or service provided | ||||
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 | S | 1..1 | positiveInt | Item instance identifier | ||||
careTeamSequence | 0..* | positiveInt | Applicable care team members | |||||
diagnosisSequence | 0..* | positiveInt | Applicable diagnoses | |||||
procedureSequence | 0..* | positiveInt | Applicable procedures | |||||
informationSequence | 0..* | positiveInt | Applicable exception and supporting information | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: NDC or Compound Value Set (required) | ||||
modifier | 0..* | CodeableConcept | Product or service billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
serviced[x] | S | 1..1 | date | Date or dates of service or product delivery | ||||
location[x] | 0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place where the service is rendered. | ||||||
locationCodeableConcept | CodeableConcept | |||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
quantity | S | 0..1 | SimpleQuantity | Count of products or services | ||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
bodySite | 0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
subSite | 0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
encounter | 0..* | Reference(Encounter) | Encounters related to this billed item | |||||
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 | |||||||
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 | ||||
category | S | 1..1 | CodeableConcept | Type of adjudication information Binding: C4BB Adjudication Category Discriminator Value Set (extensible) | ||||
reason | 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): Adjudication reason codes. | |||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
adjudication:rejectreason | S | 0..1 | BackboneElement | Reason codes used to interpret the Non-Covered Amount (92) | ||||
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 | ||||
category | S | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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/C4BBAdjudicationDiscriminator | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rejectreason | |||||
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 | |||||
reason | S | 1..1 | CodeableConcept | Explanation of adjudication outcome Binding: NCPDP Reject Code Value Set (required) | ||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
detail | S | 0..* | BackboneElement | Additional items | ||||
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 | Product or service provided | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: National Drug Code (NDC) Value Set (required) | ||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | S | 0..1 | SimpleQuantity | Count of products or services | ||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Detail level adjudication details | |||||
subDetail | 0..* | BackboneElement | Additional items | |||||
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 | Product or service provided | |||||
revenue | 0..1 | CodeableConcept | Revenue or cost center code Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products. | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
udi | 0..* | Reference(Device) | Unique device identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Subdetail level adjudication details | |||||
addItem | 0..* | BackboneElement | Insurer added line items | |||||
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 | ||||
itemSequence | 0..* | positiveInt | Item sequence number | |||||
detailSequence | 0..* | positiveInt | Detail sequence number | |||||
subDetailSequence | 0..* | positiveInt | Subdetail sequence number | |||||
provider | 0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | |||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
programCode | 0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
serviced[x] | 0..1 | Date or dates of service or product delivery | ||||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
location[x] | 0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place where the service is rendered. | ||||||
locationCodeableConcept | CodeableConcept | |||||||
locationAddress | Address | |||||||
locationReference | Reference(Location) | |||||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
bodySite | 0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
subSite | 0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Added items adjudication | |||||
detail | 0..* | BackboneElement | Insurer added line items | |||||
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 | ||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Added items adjudication | |||||
subDetail | 0..* | BackboneElement | Insurer added line items | |||||
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 | ||||
productOrService | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Service/Product billing modifiers Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
factor | 0..1 | decimal | Price scaling factor | |||||
net | 0..1 | Money | Total item cost | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ExplanationOfBenefit) | Added items adjudication | |||||
Slices for adjudication | S | 1..* | BackboneElement | Header-level adjudication Slice: Unordered, Open by value:category | ||||
adjudication: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 | ||||
category | S | 1..1 | CodeableConcept | Type of adjudication information Binding: C4BB Adjudication Category Discriminator Value Set (extensible) | ||||
reason | 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): Adjudication reason codes. | |||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
adjudication:billingnetworkstatus | S | 0..1 | BackboneElement | Billing provider networking status | ||||
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 | ||||
category | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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/C4BBAdjudicationDiscriminator | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: billingnetworkstatus | |||||
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 | |||||
reason | S | 1..1 | CodeableConcept | Explanation of adjudication outcome Binding: C4BB Payer Provider Network Status Value Set (required) | ||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
adjudication:benefitpaymentstatus | S | 1..1 | BackboneElement | Indicates the in network or out of network payment status of the claim. (142) | ||||
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 | ||||
category | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. 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/C4BBAdjudicationDiscriminator | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: benefitpaymentstatus | |||||
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 | |||||
reason | S | 1..1 | CodeableConcept | Explanation of adjudication outcome Binding: C4BB Payer Benefit Payment Status Value Set (required) | ||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monitary value | |||||
total | Σ | 0..* | BackboneElement | Adjudication totals | ||||
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 | ||||
category | Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | ||||
amount | SΣ | 1..1 | Money | Financial total for the category | ||||
payment | S | 0..1 | BackboneElement | Payment Details | ||||
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 | 0..1 | CodeableConcept | Partial or complete payment Binding: C4BB Payer Claim Payment Status Code Value Set (required) | ||||
adjustment | 0..1 | Money | Payment adjustment for non-claim issues | |||||
adjustmentReason | 0..1 | CodeableConcept | Explanation for the variance Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes. | |||||
date | S | 0..1 | date | Expected date of payment | ||||
amount | 0..1 | Money | Payable amount after adjustment | |||||
identifier | 0..1 | Identifier | Business identifier for the payment | |||||
formCode | 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |||||
form | 0..1 | Attachment | Printed reference or actual form | |||||
processNote | S | 0..* | BackboneElement | Note concerning adjudication | ||||
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 | ||||
number | 0..1 | positiveInt | Note instance identifier | |||||
type | 0..1 | code | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
text | S | 0..1 | string | Note explanatory text | ||||
language | 0..1 | CodeableConcept | Language of the text Binding: CommonLanguages (preferred): A human language.
| |||||
benefitPeriod | 0..1 | Period | When the benefits are applicable | |||||
benefitBalance | 0..* | BackboneElement | Balance by Benefit Category | |||||
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 | ||||
category | 1..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc. | |||||
excluded | 0..1 | boolean | Excluded from the plan | |||||
name | 0..1 | string | Short name for the benefit | |||||
description | 0..1 | string | Description of the benefit or services covered | |||||
network | 0..1 | CodeableConcept | In or out of network Binding: NetworkTypeCodes (example): Code to classify in or out of network services. | |||||
unit | 0..1 | CodeableConcept | Individual or family Binding: UnitTypeCodes (example): Unit covered/serviced - individual or family. | |||||
term | 0..1 | CodeableConcept | Annual or lifetime Binding: BenefitTermCodes (example): Coverage unit - annual, lifetime. | |||||
financial | 0..* | BackboneElement | Benefit Summary | |||||
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 | 1..1 | CodeableConcept | Benefit classification Binding: BenefitTypeCodes (example): Deductable, visits, co-pay, etc. | |||||
allowed[x] | 0..1 | Benefits allowed | ||||||
allowedUnsignedInt | unsignedInt | |||||||
allowedString | string | |||||||
allowedMoney | Money | |||||||
used[x] | 0..1 | Benefits used | ||||||
usedUnsignedInt | unsignedInt | |||||||
usedMoney | Money | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ExplanationOfBenefit.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ExplanationOfBenefit.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
ExplanationOfBenefit.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ExplanationOfBenefit.identifier:uniqueclaimid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.identifier:uniqueclaimid.type | extensible | Pattern: uchttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ExplanationOfBenefit.status | required | ExplanationOfBenefitStatushttp://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.type | required | Pattern: pharmacyhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | ||||
ExplanationOfBenefit.subType | example | ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype from the FHIR Standard | ||||
ExplanationOfBenefit.use | required | Pattern: claimhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.priority | required | ProcessPriorityCodeshttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | ||||
ExplanationOfBenefit.fundsReserveRequested | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
ExplanationOfBenefit.fundsReserve | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
ExplanationOfBenefit.related.relationship | required | C4BBRelatedClaimRelationshipCodeshttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBRelatedClaimRelationshipCodes from this IG | ||||
ExplanationOfBenefit.payee.type | required | C4BBPayeeTypehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayeeType from this IG | ||||
ExplanationOfBenefit.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.careTeam.role | required | C4BBClaimPharmacyTeamRolehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimPharmacyTeamRole from this IG | ||||
ExplanationOfBenefit.careTeam.qualification | example | ExampleProviderQualificationCodeshttp://hl7.org/fhir/ValueSet/provider-qualification from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo.category | extensible | C4BBSupportingInfoType (a valid code from C4BB Supporting Info Type Code System)http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:dayssupply.category | extensible | Pattern: dayssupplyhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:dayssupply.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:dayssupply.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:dawcode.category | extensible | Pattern: dawcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:dawcode.code | required | NCPDPDispensedAsWrittenOrProductSelectionCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPDispensedAsWrittenOrProductSelectionCode from this IG | ||||
ExplanationOfBenefit.supportingInfo:dawcode.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillNum.category | extensible | Pattern: refillnumhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:refillNum.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillNum.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillsAuthorized.category | extensible | Pattern: refillsauthorizedhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:refillsAuthorized.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:refillsAuthorized.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:brandgenericindicator.category | extensible | Pattern: brandgenericindicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:brandgenericindicator.code | required | NCPDPBrandGenericIndicatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPBrandGenericIndicator from this IG | ||||
ExplanationOfBenefit.supportingInfo:brandgenericindicator.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:rxoriginCode.category | extensible | Pattern: rxorigincodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:rxoriginCode.code | required | NCPDPPrescriptionOriginCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPPrescriptionOriginCode from this IG | ||||
ExplanationOfBenefit.supportingInfo:rxoriginCode.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:clmrecvddate.category | extensible | Pattern: clmrecvddatehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:clmrecvddate.code | example | ExceptionCodeshttp://hl7.org/fhir/ValueSet/claim-exception from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:clmrecvddate.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.supportingInfo:compoundcode.category | extensible | Pattern: compoundcodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBSupportingInfoType from this IG | ||||
ExplanationOfBenefit.supportingInfo:compoundcode.code | required | NCPDPCompoundCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPCompoundCode from this IG | ||||
ExplanationOfBenefit.supportingInfo:compoundcode.reason | example | MissingToothReasonCodeshttp://hl7.org/fhir/ValueSet/missing-tooth-reason from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.diagnosis[x] | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.type | example | ExampleDiagnosisTypeCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosistype from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.onAdmission | example | ExampleDiagnosisOnAdmissionCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission from the FHIR Standard | ||||
ExplanationOfBenefit.diagnosis.packageCode | example | ExampleDiagnosisRelatedGroupCodeshttp://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup from the FHIR Standard | ||||
ExplanationOfBenefit.procedure.type | example | ExampleProcedureTypeCodeshttp://hl7.org/fhir/ValueSet/ex-procedure-type from the FHIR Standard | ||||
ExplanationOfBenefit.procedure.procedure[x] | example | ICD-10ProcedureCodeshttp://hl7.org/fhir/ValueSet/icd-10-procedures from the FHIR Standard | ||||
ExplanationOfBenefit.accident.type | extensible | ActIncidentCodehttp://terminology.hl7.org/ValueSet/v3-ActIncidentCode | ||||
ExplanationOfBenefit.item.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
ExplanationOfBenefit.item.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.item.productOrService | required | FDANDCOrCompoundhttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANDCOrCompound from this IG | ||||
ExplanationOfBenefit.item.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.item.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.item.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
ExplanationOfBenefit.item.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
ExplanationOfBenefit.item.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
ExplanationOfBenefit.item.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | ||||
ExplanationOfBenefit.item.adjudication.reason | example | AdjudicationReasonCodeshttp://hl7.org/fhir/ValueSet/adjudication-reason from the FHIR Standard | ||||
ExplanationOfBenefit.item.adjudication:rejectreason.category | example | Pattern: rejectreasonhttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.item.adjudication:rejectreason.reason | required | NCPDPRejectCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/NCPDPRejectCode from this IG | ||||
ExplanationOfBenefit.item.detail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.productOrService | required | FDANationalDrugCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/FDANationalDrugCode from this IG | ||||
ExplanationOfBenefit.item.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.revenue | example | ExampleRevenueCenterCodeshttp://hl7.org/fhir/ValueSet/ex-revenue-center from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.item.detail.subDetail.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ExplanationOfBenefit.addItem.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication.category | extensible | C4BBAdjudicationCategoryDiscriminatorhttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator from this IG | ||||
ExplanationOfBenefit.adjudication.reason | example | AdjudicationReasonCodeshttp://hl7.org/fhir/ValueSet/adjudication-reason from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication:billingnetworkstatus.category | example | Pattern: billingnetworkstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication:billingnetworkstatus.reason | required | C4BBPayerProviderNetworkStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus from this IG | ||||
ExplanationOfBenefit.adjudication:benefitpaymentstatus.category | example | Pattern: benefitpaymentstatushttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.adjudication:benefitpaymentstatus.reason | required | C4BBPayerBenefitPaymentStatushttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus from this IG | ||||
ExplanationOfBenefit.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ExplanationOfBenefit.payment.type | required | C4BBPayerClaimPaymentStatusCodehttp://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerClaimPaymentStatusCode from this IG | ||||
ExplanationOfBenefit.payment.adjustmentReason | example | PaymentAdjustmentReasonCodeshttp://hl7.org/fhir/ValueSet/payment-adjustment-reason from the FHIR Standard | ||||
ExplanationOfBenefit.formCode | example | Form Codeshttp://hl7.org/fhir/ValueSet/forms from the FHIR Standard | ||||
ExplanationOfBenefit.processNote.type | required | NoteTypehttp://hl7.org/fhir/ValueSet/note-type|4.0.1 from the FHIR Standard | ||||
ExplanationOfBenefit.processNote.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ExplanationOfBenefit.benefitBalance.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.network | example | NetworkTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-network from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.unit | example | UnitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-unit from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.term | example | BenefitTermCodeshttp://hl7.org/fhir/ValueSet/benefit-term from the FHIR Standard | ||||
ExplanationOfBenefit.benefitBalance.financial.type | example | BenefitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
EOB-pharm-careTeam-organization | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to an organization : ( role.where(coding.where(code in ('rendering' )).exists()).exists() implies provider.all(resolve() is Organization) ) | |
EOB-pharm-careTeam-practitioner | error | ExplanationOfBenefit.careTeam | Pharmacy EOB: Careteam roles refer to a practitioner : ( role.where(coding.where(code in ('primary' | 'prescribing' )).exists()).exists() implies provider.all(resolve() is Organization) ) |
This structure is derived from C4BBExplanationOfBenefit
Summary
Mandatory: 12 elements(7 nested mandatory elements)
Must-Support: 43 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron