CARIN Digital Insurance Card
0.1.0 - STU 1 Ballot

This page is part of the CARIN Digital Insurance Card (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: Beneficiary Costs

This extension allows for the representation of copay details as strings. This can be passed as part of the Coverage resource where payors need to communicate costToBeneficiary details that cannot be expressed as SimpleQuantity or Money data types.

The official URL for this extension is: 

http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-BeneficiaryCosts-extension

Status: active
Extension maintained by: HL7 Payer/Provider Information Exchange Working Group (PIE WG)

Context of Use

This extension may be used on the following element(s):

  • Coverage

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 0 element (5 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBeneficiary Costs
... extension:costToBeneficiary S0..*ExtensionCost to beneficiary
.... extension 2..*ExtensionExtension
.... extension:type S1..1ExtensionType of cost
..... extension 0..0
..... url 1..1uri"type"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: C4DIC Copay Type (required)
.... extension:cost S1..1ExtensionCost description
..... extension 0..0
..... url 1..1uri"cost"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"costToBeneficiary"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-BeneficiaryCosts-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBeneficiary Costs
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:costToBeneficiary S0..*ExtensionCost to beneficiary
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:type S1..1ExtensionType of cost
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"type"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: C4DIC Copay Type (required)
.... extension:cost S1..1ExtensionCost description
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"cost"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"costToBeneficiary"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 0 element (5 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBeneficiary Costs
... extension:costToBeneficiary S0..*ExtensionCost to beneficiary
.... extension 2..*ExtensionExtension
.... extension:type S1..1ExtensionType of cost
..... extension 0..0
..... url 1..1uri"type"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: C4DIC Copay Type (required)
.... extension:cost S1..1ExtensionCost description
..... extension 0..0
..... url 1..1uri"cost"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"costToBeneficiary"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-BeneficiaryCosts-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBeneficiary Costs
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:costToBeneficiary S0..*ExtensionCost to beneficiary
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:type S1..1ExtensionType of cost
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"type"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: C4DIC Copay Type (required)
.... extension:cost S1..1ExtensionCost description
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"cost"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"costToBeneficiary"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:costToBeneficiary.extension:type.value[x]:valueCodeableConceptrequiredC4DICCopayTypeVS