CARIN Digital Insurance Card
1.1.0 - STU 1.1 United States of America flag

CARIN Digital Insurance Card, published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 1.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-digital-insurance-card/ and changes regularly. See the Directory of published versions

Extension: Logo

Official URL: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Logo-extension Version: 1.1.0
Active as of 2024-04-16 Computable Name: Logo

This extension enables payers to provide an image of their company or organization logo for use by consuming applications when rendering the coverage information for use by the health plan member. This may assist in making the information provided feel more relevant or recongizable by the member. 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):

  • Element ID 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

Complex Extension: This extension enables payers to provide an image of their company or organization logo for use by consuming applications when rendering the coverage information for use by the health plan member. This may assist in making the information provided feel more relevant or recongizable by the member. 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.

  • description: string: An Extension
  • image: Attachment, Reference: An Extension
  • label: string: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Logo
... extension 3..* Extension Extension
... extension:description 1..1 Extension Extension
.... extension 0..0
.... url 1..1 uri "description"
.... value[x] 0..1 string Value of extension
... extension:image 1..1 Extension Extension
.... extension 0..0
.... url 1..1 uri "image"
.... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Open by type:$this
..... valueAttachment Attachment
..... valueReference Reference(DocumentReference)
..... value[x]:valueAttachment 0..1 Attachment Value of extension
...... contentType 1..1 code Mime type of the content, with charset etc.
...... data 1..1 base64Binary Data inline, base64ed
..... value[x]:valueReference 0..1 Reference(DocumentReference) Value of extension
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... extension 0..0
.... url 1..1 uri "label"
.... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Logo-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Logo
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
... extension:description 1..1 Extension Extension
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "description"
.... value[x] 0..1 string Value of extension
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "image"
.... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Closed by type:$this
..... valueAttachment Attachment
..... valueReference Reference(DocumentReference)
..... value[x]:valueAttachment 0..1 Attachment Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType Σ 1..1 code Mime 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..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
...... data 1..1 base64Binary Data inline, base64ed
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created
..... value[x]:valueReference 0..1 Reference(DocumentReference) Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
... extension:label 1..1 Extension Extension
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "label"
.... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Logo-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension enables payers to provide an image of their company or organization logo for use by consuming applications when rendering the coverage information for use by the health plan member. This may assist in making the information provided feel more relevant or recongizable by the member. 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.

  • description: string: An Extension
  • image: Attachment, Reference: An Extension
  • label: string: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Logo
... extension 3..* Extension Extension
... extension:description 1..1 Extension Extension
.... extension 0..0
.... url 1..1 uri "description"
.... value[x] 0..1 string Value of extension
... extension:image 1..1 Extension Extension
.... extension 0..0
.... url 1..1 uri "image"
.... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Open by type:$this
..... valueAttachment Attachment
..... valueReference Reference(DocumentReference)
..... value[x]:valueAttachment 0..1 Attachment Value of extension
...... contentType 1..1 code Mime type of the content, with charset etc.
...... data 1..1 base64Binary Data inline, base64ed
..... value[x]:valueReference 0..1 Reference(DocumentReference) Value of extension
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... extension 0..0
.... url 1..1 uri "label"
.... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Logo-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Logo
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
... extension:description 1..1 Extension Extension
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "description"
.... value[x] 0..1 string Value of extension
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "image"
.... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Closed by type:$this
..... valueAttachment Attachment
..... valueReference Reference(DocumentReference)
..... value[x]:valueAttachment 0..1 Attachment Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType Σ 1..1 code Mime 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..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
...... data 1..1 base64Binary Data inline, base64ed
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created
..... value[x]:valueReference 0..1 Reference(DocumentReference) Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
... extension:label 1..1 Extension Extension
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "label"
.... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Logo-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:image.value[x]:valueAttachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Extension.extension:image.value[x]:valueAttachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Extension.extension:image.value[x]:valueReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard