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: Barcode

This extension enables payers to provide an image of the barcode found on a member’s physicial insurance card. This image may be displayed by consuming applications when rendering the coverage information for use by the health plan member. Often there are data elements relevant to the health plan coverage encoded in the barcode. The extension also allows for the health plan to provide a Label for the image which can be displayed in the consuming application as well as a Description of the content in the image file. Detailed descriptions are encouraged to assist with accessibility.

The official URL for this extension is: 

http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Barcode-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: 3 elements (2 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBarcode
... extension 3..*ExtensionExtension
... extension:description 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"description"
.... value[x] 0..1stringValue of extension
... extension:image 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"image"
.... Slices for value[x] 0..1AttachmentValue of extension
Slice: Unordered, Open by type:$this
.... valueAttachment 0..1AttachmentValue of extension
..... contentType 1..1codeMime type of the content, with charset etc.
..... data 1..1base64BinaryData inline, base64ed
.... extension 0..0
.... url 1..1uri"label"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Barcode-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBarcode
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:description 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"description"
.... value[x] 0..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"image"
.... Slices for value[x] 0..1AttachmentValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueAttachment 0..1AttachmentValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType Σ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


Example General: en-AU
...... data 1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
... extension:label 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"label"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Barcode-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

  • The element 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..*ExtensionBarcode
... extension 3..*ExtensionExtension
... extension:description 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"description"
.... value[x] 0..1stringValue of extension
... extension:image 1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"image"
.... Slices for value[x] 0..1AttachmentValue of extension
Slice: Unordered, Open by type:$this
.... valueAttachment 0..1AttachmentValue of extension
..... contentType 1..1codeMime type of the content, with charset etc.
..... data 1..1base64BinaryData inline, base64ed
.... extension 0..0
.... url 1..1uri"label"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Barcode-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBarcode
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:description 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"description"
.... value[x] 0..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"image"
.... Slices for value[x] 0..1AttachmentValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueAttachment 0..1AttachmentValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType Σ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


Example General: en-AU
...... data 1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
... extension:label 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"label"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Barcode-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:image.value[x]:valueAttachment.contentTyperequiredMime Types
Extension.extension:image.value[x]:valueAttachment.languagepreferredCommonLanguages
Max Binding: AllLanguages