description: The basis profile is used for Explanation of Benefits (EOBs) based on claims submitted by clinics, hospitals, skilled nursing facilities and other institutions for inpatient services, which may include the use of equipment and supplies, laboratory services, radiology services and other charges. Inpatient claims are submitted for services rendered at an institution as part of an overnight stay.\nThe claims data is based on the institutional claim format UB-04, submission standards adopted by the Department of Health and Human\nServices.\nThe basis profile does not have requirements for financial data.
package_name: hl7.fhir.us.carin-bb
derivation: constraint
name: C4BBExplanationOfBenefitInpatientInstitutionalBasis
type: ExplanationOfBenefit
elements:
  processNote:
    elements:
      text: {mustSupport: true, index: 88}
  diagnosis:
    mustSupport: true
    index: 50
    elements:
      sequence: {index: 51}
      diagnosis:
        mustSupport: true
        choices: [diagnosisCodeableConcept]
        index: 53
      diagnosisCodeableConcept: {type: CodeableConcept, mustSupport: true, choiceOf: diagnosis, index: 54}
      type:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInpatientInstitutionalDiagnosisType'}
        mustSupport: true
        index: 55
      onAdmission:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPresentOnAdmission'}
        mustSupport: true
        index: 56
    required: [type]
  adjudication:
    type: BackboneElement
    mustSupport: true
    index: 76
    elements:
      category:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator'}
        mustSupport: true
        index: 77
    slicing:
      rules: open
      ordered: false
      description: Slice based on value pattern
      discriminator:
      - {path: category, type: pattern}
      min: 1
      slices:
        billingnetworkstatus:
          match:
            category:
              coding:
              - {code: billingnetworkstatus, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
          schema:
            short: Billing provider network status
            mustSupport: true
            index: 78
            elements:
              category:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: billingnetworkstatus, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
                index: 79
              reason:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerProviderNetworkStatus'}
                mustSupport: true
                index: 80
            required: [reason]
        benefitpaymentstatus:
          match:
            category:
              coding:
              - {code: benefitpaymentstatus, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
          schema:
            short: Indicates the in network or out of network payment status of the claim. (142)
            mustSupport: true
            _required: true
            index: 81
            elements:
              category:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: benefitpaymentstatus, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
                index: 82
              reason:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBPayerBenefitPaymentStatus'}
                mustSupport: true
                index: 83
            required: [reason]
        adjustmentreason:
          match:
            category:
              coding:
              - {code: adjustmentreason, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
          schema:
            short: Reason codes used to interpret the Non-Covered Amount (92)
            mustSupport: true
            array: true
            index: 84
            elements:
              category:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: adjustmentreason, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
                index: 85
              reason:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/X12ClaimAdjustmentReasonCodesCMSRemittanceAdviceRemarkCodes'}
                mustSupport: true
                index: 86
            required: [reason]
  supportingInfo:
    index: 8
    slicing:
      rules: open
      ordered: false
      description: Slice based on $this pattern
      discriminator:
      - {path: category, type: pattern}
      min: 1
      slices:
        discharge-status:
          match:
            category:
              coding:
              - {code: discharge-status, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Discharge status
            mustSupport: true
            index: 30
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: discharge-status, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 31
              code:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPatientDischargeStatus'}
                mustSupport: true
                index: 32
            required: [code]
        pointoforigin:
          match:
            category:
              coding:
              - {code: pointoforigin, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Point of origin for admission
            mustSupport: true
            index: 24
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: pointoforigin, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 25
              code:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPointOfOriginForAdmissionOrVisit'}
                mustSupport: true
                index: 26
            required: [code]
        typeofbill:
          match:
            category:
              coding:
              - {code: typeofbill, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Type of bill
            mustSupport: true
            index: 21
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: typeofbill, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 22
              code:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCTypeOfBill'}
                mustSupport: true
                index: 23
            required: [code]
        drg:
          match:
            category:
              coding:
              - {code: drg, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Diagnosis Related Group
            mustSupport: true
            index: 33
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: drg, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 34
              code:
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/CMSMS3MAPAPRDRG'}
                mustSupport: true
                index: 35
            required: [code]
        admtype:
          match:
            category:
              coding:
              - {code: admtype, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Admission type
            mustSupport: true
            index: 27
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: admtype, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 28
              code:
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCPriorityTypeOfAdmissionOrVisit'}
                mustSupport: true
                index: 29
            required: [code]
        admissionperiod:
          match:
            category:
              coding:
              - {code: admissionperiod, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Admission Period
            mustSupport: true
            _required: true
            index: 9
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: admissionperiod, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 10
              timing:
                choices: []
                index: 12
                slicing:
                  rules: open
                  ordered: false
                  discriminator:
                  - {path: $this, type: type}
                  min: 1
                  slices:
                    timingPeriod:
                      match: {}
                      schema:
                        mustSupport: true
                        choices: [timingPeriod]
                        _required: true
                        index: 14
                      min: 1
                      max: 1
              timingPeriod:
                type: Period
                mustSupport: true
                choiceOf: timing
                index: 15
                slicing:
                  slices:
                    timingPeriod:
                      match: {}
                      schema: {type: Period, mustSupport: true, choiceOf: timing, _required: true, index: 15}
                      min: 1
                      max: 1
            required: [timingPeriod, timing]
        clmrecvddate:
          match:
            category:
              coding:
              - {code: clmrecvddate, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Claim received date
            mustSupport: true
            index: 16
            elements:
              category:
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: clmrecvddate, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 17
              timing:
                mustSupport: true
                choices: [timingDate]
                index: 19
              timingDate: {type: date, mustSupport: true, choiceOf: timing, index: 20}
            required: [timingDate, timing]
        medicalrecordnumber:
          match:
            category:
              coding:
              - {code: medicalrecordnumber, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Medical record number
            mustSupport: true
            index: 36
            elements:
              category:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: medicalrecordnumber, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 37
              value:
                choices: []
                index: 39
                slicing:
                  rules: open
                  ordered: false
                  discriminator:
                  - {path: $this, type: type}
                  min: 1
                  slices:
                    valueString:
                      match: {}
                      schema:
                        mustSupport: true
                        choices: [valueString]
                        _required: true
                        index: 41
                      min: 1
                      max: 1
              valueString:
                type: string
                mustSupport: true
                choiceOf: value
                index: 42
                slicing:
                  slices:
                    valueString:
                      match: {}
                      schema: {type: string, mustSupport: true, choiceOf: value, _required: true, index: 42}
                      min: 1
                      max: 1
            required: [valueString, value]
        patientaccountnumber:
          match:
            category:
              coding:
              - {code: patientaccountnumber, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
          schema:
            short: Patient account number
            mustSupport: true
            index: 43
            elements:
              category:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: patientaccountnumber, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBSupportingInfoType'}
                index: 44
              value:
                choices: []
                index: 46
                slicing:
                  rules: open
                  ordered: false
                  discriminator:
                  - {path: $this, type: type}
                  min: 1
                  slices:
                    valueString:
                      match: {}
                      schema:
                        mustSupport: true
                        choices: [valueString]
                        _required: true
                        index: 48
                      min: 1
                      max: 1
              valueString:
                type: string
                mustSupport: true
                choiceOf: value
                index: 49
                slicing:
                  slices:
                    valueString:
                      match: {}
                      schema: {type: string, mustSupport: true, choiceOf: value, _required: true, index: 49}
                      min: 1
                      max: 1
            required: [valueString, value]
  payment:
    elements:
      date: {mustSupport: true, index: 87}
  item:
    elements:
      revenue:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AHANUBCRevenueCodes'}
        mustSupport: true
        index: 64
      productOrService:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBEOBInstitutionalProcedureCodes'}
        mustSupport: true
        index: 65
      modifier:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers'}
        mustSupport: true
        index: 66
      quantity: {mustSupport: true, index: 67}
      adjudication:
        mustSupport: true
        index: 68
        elements:
          category:
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBAdjudicationCategoryDiscriminator'}
            index: 69
        slicing:
          rules: open
          ordered: false
          description: Slice based on value pattern
          discriminator:
          - {path: category, type: pattern}
          min: null
          slices:
            adjustmentreason:
              match:
                category:
                  coding:
                  - {code: adjustmentreason, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
              schema:
                short: Reason codes used to interpret the Non-Covered Amount (92)
                mustSupport: true
                array: true
                index: 70
                elements:
                  category:
                    pattern:
                      type: CodeableConcept
                      value:
                        coding:
                        - {code: adjustmentreason, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
                    index: 71
                  reason:
                    binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/X12ClaimAdjustmentReasonCodesCMSRemittanceAdviceRemarkCodes'}
                    mustSupport: true
                    index: 72
                required: [reason]
            allowedunits:
              match:
                category:
                  coding:
                  - {code: allowedunits, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
              schema:
                short: The quantity of units, times, days, visits, services, or treatments for the service described by the HCPCS code, revenue code or procedure code, submitted by the provider.  (149)
                mustSupport: true
                index: 73
                elements:
                  category:
                    pattern:
                      type: CodeableConcept
                      value:
                        coding:
                        - {code: allowedunits, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBAdjudicationDiscriminator'}
                    index: 74
                  value: {mustSupport: true, index: 75}
                required: [value]
    required: [revenue]
  type:
    pattern:
      type: CodeableConcept
      value:
        coding:
        - {code: institutional, system: 'http://terminology.hl7.org/CodeSystem/claim-type'}
    index: 1
  created: {mustSupport: true, index: 4}
  procedure:
    mustSupport: true
    index: 57
    elements:
      sequence: {index: 58}
      type:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimProcedureType'}
        mustSupport: true
        index: 59
      date: {mustSupport: true, index: 60}
      procedure:
        mustSupport: true
        choices: [procedureCodeableConcept]
        index: 62
      procedureCodeableConcept: {type: CodeableConcept, mustSupport: true, choiceOf: procedure, index: 63}
    required: [type]
  billablePeriod:
    elements:
      end: {mustSupport: true, index: 3}
  identifier: {mustSupport: true, index: 0}
  subType:
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBInstitutionalClaimSubType'}
    mustSupport: true
    pattern:
      type: CodeableConcept
      value:
        coding:
        - {code: inpatient, system: 'http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBInstitutionalClaimSubType'}
    index: 2
  provider:
    type: Reference
    refers: ['http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization']
    index: 5
  careTeam:
    constraint:
      EOB-inst-careTeam-practitioner:
        human: 'Institutional EOB: Careteam roles refer to a practitioner'
        source: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional-Basis
        severity: error
        expression: |-
          (
          role.where(coding.where(code in ('attending' | 'primary' | 'referring' | 'supervisor')).exists()).exists() implies
          provider.all(resolve() is Practitioner)
          )
      EOB-inst-careTeam-organization:
        human: 'Institutional EOB: Careteam roles refer to an organization'
        source: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional-Basis
        severity: error
        expression: |-
          (
          role.where(coding.where(code in ('rendering' )).exists()).exists() implies
          provider.all(resolve() is Organization)
          )
    index: 6
    elements:
      role:
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInstitutionalCareTeamRole'}
        index: 7
    required: [role]
package_version: 2.1.0-snapshot1
class: profile
kind: resource
url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional-Basis
base: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit
version: 2.1.0-snapshot1
required: [diagnosis, adjudication, supportingInfo, subType]