Polaris FHIR Implementation Guide - Local Development build (v1.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Extension: Polaris File Metadata Extension
| Official URL: https://fhir.apps.health/StructureDefinition/polaris-file-metadata | Version: 1.10.0 | |||
| Draft as of 2025-07-23 | Computable Name: PolarisFileMetadataExtension | |||
Additional metadata for file attachments including display hints and embedded sections
Context of Use
-
Element ID:
DocumentReference
This extension may be used on the following element(s)
Usage info
Usages:
- This Extension is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Extension Content
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 Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Polaris File Metadata Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:originalFileName |
S | 0..1 | Extension | Extension |
   extension |
0..0 | |||
| url |
1..1 | uri | "originalFileName" | |
  value[x] |
0..1 | string | Value of extension | |
| extension:fileCategory |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "fileCategory" | |
| value[x] |
0..1 | code | Value of extension Binding: Polaris File Categories (extensible) | |
| extension:displayHint |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "displayHint" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:processingInstructions |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "processingInstructions" | |
| value[x] |
0..1 | string | Value of extension | |
 extension:embeddedSections |
S | 0..* | Extension | Extension |
 extension |
0..0 | |||
| url |
1..1 | uri | "embeddedSections" | |
| value[x] |
0..1 | string | Value of extension | |
 url |
1..1 | uri | "https://fhir.apps.health/StructureDefinition/polaris-file-metadata" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Polaris File Metadata 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 | |
| extension:originalFileName |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "originalFileName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:fileCategory |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "fileCategory" | |
| value[x] |
0..1 | code | Value of extension Binding: Polaris File Categories (extensible) | |
| extension:displayHint |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "displayHint" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:processingInstructions |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "processingInstructions" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:embeddedSections |
S | 0..* | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "embeddedSections" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir.apps.health/StructureDefinition/polaris-file-metadata" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: Additional metadata for file attachments including display hints and embedded sections
- originalFileName: string: An Extension
- fileCategory: code: An Extension
- displayHint: string: An Extension
- processingInstructions: string: An Extension
- embeddedSections: string: An Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Polaris File Metadata Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:originalFileName |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "originalFileName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:fileCategory |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "fileCategory" | |
| value[x] |
0..1 | code | Value of extension Binding: Polaris File Categories (extensible) | |
| extension:displayHint |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "displayHint" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:processingInstructions |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "processingInstructions" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:embeddedSections |
S | 0..* | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "embeddedSections" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir.apps.health/StructureDefinition/polaris-file-metadata" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Polaris File Metadata 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 | |
| extension:originalFileName |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "originalFileName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:fileCategory |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "fileCategory" | |
| value[x] |
0..1 | code | Value of extension Binding: Polaris File Categories (extensible) | |
| extension:displayHint |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "displayHint" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:processingInstructions |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "processingInstructions" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:embeddedSections |
S | 0..* | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "embeddedSections" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://fhir.apps.health/StructureDefinition/polaris-file-metadata" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: Additional metadata for file attachments including display hints and embedded sections
- originalFileName: string: An Extension
- fileCategory: code: An Extension
- displayHint: string: An Extension
- processingInstructions: string: An Extension
- embeddedSections: string: An Extension
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Extension.extension:fileCategory.value[x] | extensible | PolarisFileCategorieshttps://fhir.apps.health/ValueSet/polaris-file-categoriesFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |