| Package | hl7.fhir.uv.smart-health-cards-and-links |
| Type | StructureDefinition |
| Id | ShlManifest |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/smart-health-cards-and-links/https://build.fhir.org/ig/HL7/smart-health-cards-and-links/StructureDefinition-ShlManifest.html |
| URL | http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlManifest |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-07-21T13:49:05+00:00 |
| Name | ShlManifest |
| Title | SMART Health Link Manifest |
| Realm | uv |
| Authority | hl7 |
| Description | The SMART Health Link Manifest object |
| Purpose | This is a logical model reflecting the structure of a SMART Health Link (SHL) manifest. Its intent is to provide a means for understanding mainfest content. |
| Type | http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlManifest |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ShlManifest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ShlManifest | 0..* | Base | SMART Health Link Manifest | |
  status | 0..1 | string | Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid | |
 list | 0..1 | List | Property containing a List resource with metadata related to contained files. | |
  files | 1..* | BackboneElement | Object containing metadata related to one or more contained files. | |
 @id | 0..0 | |||
 extension | 0..0 | |||
 modifierExtension | 0..0 | |||
| contentType | 1..1 | string | Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter | |
| location | 0..1 | url | URL to the content. | |
| embedded | 0..1 | string | Encrypted file contents. JSON Web Encryption (JWE) string. | |
| lastUpdated | 0..1 | dateTime | Last time the content was modified. ISO 8601 timestamp. | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "ShlManifest",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlManifest",
"version": "1.0.0",
"name": "ShlManifest",
"title": "SMART Health Link Manifest",
"status": "active",
"date": "2025-07-21T13:49:05+00:00",
"publisher": "HL7 International / FHIR Infrastructure",
"contact": [
{
"name": "HL7 International / FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"name": "Frank McKinney",
"telecom": [
{
"system": "email",
"value": "frank.mckinney@pocp.com"
},
{
"system": "email",
"value": "fm@frankmckinney.com"
}
]
}
],
"description": "The SMART Health Link Manifest object",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This is a logical model reflecting the structure of a SMART Health Link (SHL) manifest. Its intent is to provide a means for understanding mainfest content.",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlManifest",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "ShlManifest",
"path": "ShlManifest",
"short": "SMART Health Link Manifest",
"definition": "The SMART Health Link Manifest object",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "ShlManifest.status",
"path": "ShlManifest.status",
"short": "Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid",
"definition": "Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid",
"min": 0,
"max": "1",
"base": {
"path": "ShlManifest.status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ShlManifest.list",
"path": "ShlManifest.list",
"short": "Property containing a List resource with metadata related to contained files.",
"definition": "Property containing a List resource with metadata related to contained files.",
"min": 0,
"max": "1",
"base": {
"path": "ShlManifest.list",
"min": 0,
"max": "1"
},
"type": [
{
"code": "List"
}
]
},
{
"id": "ShlManifest.files",
"path": "ShlManifest.files",
"short": "Object containing metadata related to one or more contained files.",
"definition": "Object containing metadata related to one or more contained files.",
"min": 1,
"max": "*",
"base": {
"path": "ShlManifest.files",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "ShlManifest.files.id",
"path": "ShlManifest.files.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "0",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ShlManifest.files.extension",
"path": "ShlManifest.files.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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.",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ShlManifest.files.modifierExtension",
"path": "ShlManifest.files.modifierExtension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
},
{
"id": "ShlManifest.files.contentType",
"path": "ShlManifest.files.contentType",
"short": "Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter",
"definition": "Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter",
"min": 1,
"max": "1",
"base": {
"path": "ShlManifest.files.contentType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ShlManifest.files.location",
"path": "ShlManifest.files.location",
"short": "URL to the content.",
"definition": "URL to the content.",
"min": 0,
"max": "1",
"base": {
"path": "ShlManifest.files.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "ShlManifest.files.embedded",
"path": "ShlManifest.files.embedded",
"short": "Encrypted file contents. JSON Web Encryption (JWE) string.",
"definition": "Encrypted file contents. JSON Web Encryption (JWE) string.",
"min": 0,
"max": "1",
"base": {
"path": "ShlManifest.files.embedded",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ShlManifest.files.lastUpdated",
"path": "ShlManifest.files.lastUpdated",
"short": "Last time the content was modified. ISO 8601 timestamp.",
"definition": "Last time the content was modified. ISO 8601 timestamp.",
"min": 0,
"max": "1",
"base": {
"path": "ShlManifest.files.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ShlManifest",
"path": "ShlManifest",
"short": "SMART Health Link Manifest",
"definition": "The SMART Health Link Manifest object"
},
{
"id": "ShlManifest.status",
"path": "ShlManifest.status",
"short": "Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid",
"definition": "Indicates whether files may be changed in the future. Values are: finalized|can-change|no-longer-valid",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ShlManifest.list",
"path": "ShlManifest.list",
"short": "Property containing a List resource with metadata related to contained files.",
"definition": "Property containing a List resource with metadata related to contained files.",
"min": 0,
"max": "1",
"type": [
{
"code": "List"
}
]
},
{
"id": "ShlManifest.files",
"path": "ShlManifest.files",
"short": "Object containing metadata related to one or more contained files.",
"definition": "Object containing metadata related to one or more contained files.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ShlManifest.files.id",
"path": "ShlManifest.files.id",
"max": "0"
},
{
"id": "ShlManifest.files.extension",
"path": "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.",
"max": "0"
},
{
"id": "ShlManifest.files.modifierExtension",
"path": "ShlManifest.files.modifierExtension",
"max": "0"
},
{
"id": "ShlManifest.files.contentType",
"path": "ShlManifest.files.contentType",
"short": "Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter",
"definition": "Nature of the content. Values: application/smart-health-card or application/smart-api-access or application/fhir+json with fhirVersion parameter",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ShlManifest.files.location",
"path": "ShlManifest.files.location",
"short": "URL to the content.",
"definition": "URL to the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "url"
}
]
},
{
"id": "ShlManifest.files.embedded",
"path": "ShlManifest.files.embedded",
"short": "Encrypted file contents. JSON Web Encryption (JWE) string.",
"definition": "Encrypted file contents. JSON Web Encryption (JWE) string.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ShlManifest.files.lastUpdated",
"path": "ShlManifest.files.lastUpdated",
"short": "Last time the content was modified. ISO 8601 timestamp.",
"definition": "Last time the content was modified. ISO 8601 timestamp.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
}
]
}
}