CARIN Digital Insurance Card
1.0.0 - STU 1
US
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 
| Official URL: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-SupportingImage-extension | Version: 1.0.0 | |||
| Active as of 2022-07-13 | Computable Name: SupportingImage | |||
This extension enables payers to provide other supporting images found on a member’s physicial insurance card. A supporting image may be displayed by consuming applications when rendering the coverage information for use by the health plan member. These images may communicate additional information to the member such as the type of coverage provided or partner logos. 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):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Supporting image | |
  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" | |
  value[x] | 0..1 | Value of extension Slice: Unordered, Open by type:$this | ||
   valueAttachment | Attachment | |||
  valueReference | Reference(DocumentReference) | |||
| 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 | |
 valueReference | 0..1 | Reference(DocumentReference) | Value of extension | |
 reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| extension:label | 1..1 | Extension | Extension | |
| 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-SupportingImage-extension" | |
| value[x] | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Extension | 0..* | Extension | Supporting image | |||||
| 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 | |||||
| extension:image | 1..1 | Extension | 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.
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 | ΣI | 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-SupportingImage-extension" | |||||
| 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:
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Supporting image | |
| 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" | |
| value[x] | 0..1 | Value of extension Slice: Unordered, Open by type:$this | ||
| valueAttachment | Attachment | |||
| valueReference | Reference(DocumentReference) | |||
| 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 | |
| valueReference | 0..1 | Reference(DocumentReference) | Value of extension | |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| extension:label | 1..1 | Extension | Extension | |
| 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-SupportingImage-extension" | |
| value[x] | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Extension | 0..* | Extension | Supporting image | |||||
| 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 | |||||
| extension:image | 1..1 | Extension | 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.
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 | ΣI | 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-SupportingImage-extension" | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Extension.extension:image.value[x]:valueAttachment.contentType | required | Mime Types |
| Extension.extension:image.value[x]:valueAttachment.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Extension.extension:image.value[x]:valueReference.type | extensible | ResourceType |
IG © 2022+ HL7 Payer/Provider Information Exchange Working Group (PIE WG). Package hl7.fhir.us.insurance-card#1.0.0 based on FHIR 4.0.1. Generated 2022-07-13
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change