SMART Health Cards and Links IG
1.0.0 - STU 1
SMART Health Cards and Links IG
1.0.0 - STU 1
This page is part of the SMART Health Cards and Links FHIR IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 4 |
Definitions for the ShlManifest logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ShlManifest | |
| Definition | The SMART Health Link Manifest object |
| Short | SMART Health Link Manifest |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ShlManifest.status | |
| Definition | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid |
| Short | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. ShlManifest.list | |
| Definition | Property containing a List resource with metadata related to contained files. |
| Short | Property containing a List resource with metadata related to contained files. |
| Control | 0..1 |
| Type | List |
| 6. ShlManifest.files | |
| Definition | Object containing metadata related to one or more contained files. |
| Short | Object containing metadata related to one or more contained files. |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. ShlManifest.files.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. ShlManifest.files.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | The SMART Health Links manifest supports extensions to its content through the list property, which holds a FHIR List resource that can be extended using standard FHIR extensions.Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ShlManifest.files.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. ShlManifest.files.modifierExtension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | ExtensionExtensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 14. ShlManifest.files.contentType | |
| Definition | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter |
| Short | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. ShlManifest.files.location | |
| Definition | URL to the content. |
| Short | URL to the content. |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. ShlManifest.files.embedded | |
| Definition | Encrypted file contents. JSON Web Encryption (JWE) string. |
| Short | Encrypted file contents. JSON Web Encryption (JWE) string. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. ShlManifest.files.lastUpdated | |
| Definition | Last time the content was modified. ISO 8601 timestamp. |
| Short | Last time the content was modified. ISO 8601 timestamp. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ShlManifest | |
| Definition | The SMART Health Link Manifest object |
| Short | SMART Health Link Manifest |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ShlManifest.status | |
| Definition | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid |
| Short | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. ShlManifest.list | |
| Definition | Property containing a List resource with metadata related to contained files. |
| Short | Property containing a List resource with metadata related to contained files. |
| Control | 0..1 |
| Type | List |
| 6. ShlManifest.files | |
| Definition | Object containing metadata related to one or more contained files. |
| Short | Object containing metadata related to one or more contained files. |
| Control | 1..* |
| Type | BackboneElement |
| 8. ShlManifest.files.id | |
| Control | 0..0 |
| 10. ShlManifest.files.extension | |
| Short | The SMART Health Links manifest supports extensions to its content through the list property, which holds a FHIR List resource that can be extended using standard FHIR extensions. |
| Control | 0..0 |
| 12. ShlManifest.files.modifierExtension | |
| Control | 0..0 |
| 14. ShlManifest.files.contentType | |
| Definition | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter |
| Short | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. ShlManifest.files.location | |
| Definition | URL to the content. |
| Short | URL to the content. |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. ShlManifest.files.embedded | |
| Definition | Encrypted file contents. JSON Web Encryption (JWE) string. |
| Short | Encrypted file contents. JSON Web Encryption (JWE) string. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. ShlManifest.files.lastUpdated | |
| Definition | Last time the content was modified. ISO 8601 timestamp. |
| Short | Last time the content was modified. ISO 8601 timestamp. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ShlManifest | |
| Definition | The SMART Health Link Manifest object |
| Short | SMART Health Link Manifest |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ShlManifest.status | |
| Definition | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid |
| Short | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. ShlManifest.list | |
| Definition | Property containing a List resource with metadata related to contained files. |
| Short | Property containing a List resource with metadata related to contained files. |
| Control | 0..1 |
| Type | List |
| 6. ShlManifest.files | |
| Definition | Object containing metadata related to one or more contained files. |
| Short | Object containing metadata related to one or more contained files. |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. ShlManifest.files.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. ShlManifest.files.extension | |
| Definition | An Extension |
| Short | The SMART Health Links manifest supports extensions to its content through the list property, which holds a FHIR List resource that can be extended using standard FHIR extensions. |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ShlManifest.files.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. ShlManifest.files.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. ShlManifest.files.contentType | |
| Definition | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter |
| Short | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. ShlManifest.files.location | |
| Definition | URL to the content. |
| Short | URL to the content. |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. ShlManifest.files.embedded | |
| Definition | Encrypted file contents. JSON Web Encryption (JWE) string. |
| Short | Encrypted file contents. JSON Web Encryption (JWE) string. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. ShlManifest.files.lastUpdated | |
| Definition | Last time the content was modified. ISO 8601 timestamp. |
| Short | Last time the content was modified. ISO 8601 timestamp. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2024+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.smart-health-cards-and-links#1.0.0 based on FHIR 4.0.1. Generated 2025-07-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change