CARIN Digital Insurance Card
1.0.0 - STU 1 US

This page is part of the CARIN Digital Insurance Card (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: QR Code

Official URL: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-QRCode-extension Version: 1.0.0
Active as of 2022-07-13 Computable Name: QRCode

This extension enables payers to provide an image of the QR code 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 QR code. 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.

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 (3 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..*ExtensionQR Code
... 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"
.... value[x] 0..1Value of extension
Slice: Unordered, Open by type:$this
..... valueAttachmentAttachment
..... valueReferenceReference(DocumentReference)
.... valueAttachment 0..1AttachmentValue of extension
..... contentType 1..1codeMime type of the content, with charset etc.
..... data 1..1base64BinaryData inline, base64ed
.... valueReference 0..1Reference(DocumentReference)Value of extension
..... reference 1..1stringLiteral reference, Relative, internal or absolute URL
.... 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-QRCode-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionQR Code
... 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
.... extension 0..0
.... url 1..1uri"description"
.... value[x] 0..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"image"
.... Slices for value[x] 0..1Value of extension
Slice: Unordered, Closed by type:$this
..... valueAttachmentAttachment
..... valueReferenceReference(DocumentReference)
..... value[x]:valueAttachment 0..1AttachmentValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

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
..... value[x]:valueReference 0..1Reference(DocumentReference)Value of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
... extension:label 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... 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-QRCode-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 3 elements (3 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..*ExtensionQR Code
... 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"
.... value[x] 0..1Value of extension
Slice: Unordered, Open by type:$this
..... valueAttachmentAttachment
..... valueReferenceReference(DocumentReference)
.... valueAttachment 0..1AttachmentValue of extension
..... contentType 1..1codeMime type of the content, with charset etc.
..... data 1..1base64BinaryData inline, base64ed
.... valueReference 0..1Reference(DocumentReference)Value of extension
..... reference 1..1stringLiteral reference, Relative, internal or absolute URL
.... 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-QRCode-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionQR Code
... 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
.... extension 0..0
.... url 1..1uri"description"
.... value[x] 0..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"image"
.... Slices for value[x] 0..1Value of extension
Slice: Unordered, Closed by type:$this
..... valueAttachmentAttachment
..... valueReferenceReference(DocumentReference)
..... value[x]:valueAttachment 0..1AttachmentValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

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
..... value[x]:valueReference 0..1Reference(DocumentReference)Value of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
... extension:label 1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... 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-QRCode-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
Extension.extension:image.value[x]:valueReference.typeextensibleResourceType