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
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.
The official URL for this extension is:
http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-SupportingImage-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):
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" | |
Slices for value[x] | 0..1 | Attachment | Value of extension Slice: Unordered, Open by type:$this | |
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 | |
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 | |
Slices for 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "image" | |
Slices for value[x] | 0..1 | Attachment | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueAttachment | 0..1 | Attachment | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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) Max Binding: AllLanguages: 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 |
extension:label | 1..1 | Extension | Extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 (2 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" | |
Slices for value[x] | 0..1 | Attachment | Value of extension Slice: Unordered, Open by type:$this | |
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 | |
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 | |
Slices for 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 | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "image" | |
Slices for value[x] | 0..1 | Attachment | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueAttachment | 0..1 | Attachment | Value of extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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) Max Binding: AllLanguages: 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 |
extension:label | 1..1 | Extension | Extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 |