FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-VERSION.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-VERSION.html |
| URL | http://openehr.org/fhir/StructureDefinition/VERSION |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | VERSION |
| Title | VERSION |
| Realm | uv |
| Authority | hl7 |
| Description | Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution. |
| Type | http://openehr.org/fhir/StructureDefinition/VERSION |
| Kind | logical |
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | IMPORTED-VERSION | IMPORTED_VERSION |
| openehr.base#0.1.0-snapshot | ORIGINAL-VERSION | ORIGINAL_VERSION |
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | AUDIT-DETAILS | AUDIT_DETAILS |
| openehr.base#0.1.0-snapshot | Any | Any |
| openehr.base#0.1.0-snapshot | OBJECT-REF | OBJECT_REF |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition VERSION
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  VERSION<T : Any> | C | 0..* | Any | This is an abstract type. Child types: IMPORTED_VERSION, ORIGINAL_VERSION Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution. Constraints: Owner_id_valid, Preceding_version_uid_validity, Lifecycle_state_ valid |
  contribution<T : Any> | 1..1 | OBJECT_REF | Contribution in which this version was added. | |
 signature<T : Any> | 0..1 | string | OpenPGP digital signature or digest of content committed in this Version. | |
 commit_audit<T : Any> | 1..1 | AUDIT_DETAILS | Audit trail corresponding to the committal of this version to the `VERSIONED_OBJECT`. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "VERSION",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"contained": [
{
"resourceType": "OperationDefinition",
"id": "uid",
"name": "uid",
"title": "uid",
"status": "active",
"kind": "operation",
"description": "Unique identifier of this `VERSION`, in the form of an `{object_id, a version_tree_id, creating_system_id}` triple, where the `_object_id_` has the same value as the containing `VERSIONED_OBJECT _uid_`.",
"code": "uid",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "preceding_version_uid",
"name": "preceding_version_uid",
"title": "preceding_version_uid",
"status": "active",
"kind": "operation",
"description": "Unique identifier of the version of which this version is a modification; Void if this is the first version.",
"code": "preceding_version_uid",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "data",
"name": "data",
"title": "data",
"status": "active",
"kind": "operation",
"description": "The data of this Version.",
"code": "data",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "lifecycle_state",
"name": "lifecycle_state",
"title": "lifecycle_state",
"status": "active",
"kind": "operation",
"description": "Lifecycle state of this version; coded by openEHR vocabulary `version lifecycle state`.",
"code": "lifecycle_state",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "string"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "canonical_form",
"name": "canonical_form",
"title": "canonical_form",
"status": "active",
"kind": "operation",
"description": "A canonical serial form of this Version, suitable for generating reliable hashes and signatures.",
"code": "canonical_form",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "string"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "owner_id",
"name": "owner_id",
"title": "owner_id",
"status": "active",
"kind": "operation",
"description": "Copy of the owning `VERSIONED_OBJECT._uid_` value; extracted from the local `_uid_` property's `_object_id_`.",
"code": "owner_id",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "is_branch",
"name": "is_branch",
"title": "is_branch",
"status": "active",
"kind": "operation",
"description": "True if this Version represents a branch. Derived from `_uid_` attribute. ",
"code": "is_branch",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "boolean"
}
]
}
],
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/development/common.html#_version_class"
},
{
"extension": [
{
"url": "name",
"valueCode": "T"
},
{
"url": "type",
"valueUri": "http://openehr.org/fhir/StructureDefinition/Any"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#uid"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#preceding_version_uid"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#data"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#lifecycle_state"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#canonical_form"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#owner_id"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#is_branch"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode": "element-view-replace-cardinality"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url": "http://openehr.org/fhir/StructureDefinition/VERSION",
"version": "0.1.0-snapshot",
"name": "VERSION",
"title": "VERSION",
"status": "active",
"experimental": false,
"date": "2025-09-06T15:35:39+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": true,
"type": "http://openehr.org/fhir/StructureDefinition/VERSION",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/Any",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "VERSION",
"path": "VERSION",
"short": "Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution.",
"definition": "Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "Owner_id_valid",
"severity": "error",
"human": "Owner id valid",
"expression": "owner_id().value().is_equal (uid().object_id.value())"
},
{
"key": "Preceding_version_uid_validity",
"severity": "error",
"human": "Preceding version uid validity must be present",
"expression": "uid().version_tree_id.is_first xor preceding_version_uid().exists()"
},
{
"key": "Lifecycle_state_ valid",
"severity": "error",
"human": "Lifecycle state valid must be present",
"expression": "lifecycle_state().exists() and then terminology (Term_id_openehr).has_code_for_group_id (Group_id_version_lifecycle_state, lifecycle_state().defining_code)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "VERSION.contribution",
"path": "VERSION.contribution",
"short": "Contribution in which this version was added.",
"definition": "Contribution in which this version was added.",
"min": 1,
"max": "1",
"base": {
"path": "VERSION.contribution",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "VERSION.signature",
"path": "VERSION.signature",
"short": "OpenPGP digital signature or digest of content committed in this Version.",
"definition": "OpenPGP digital signature or digest of content committed in this Version.",
"min": 0,
"max": "1",
"base": {
"path": "VERSION.signature",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "VERSION.commit-audit",
"path": "VERSION.commit_audit",
"short": "Audit trail corresponding to the committal of this version to the `VERSIONED_OBJECT`.",
"definition": "Audit trail corresponding to the committal of this version to the `VERSIONED_OBJECT`.",
"min": 1,
"max": "1",
"base": {
"path": "VERSION.commit_audit",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/AUDIT-DETAILS"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "VERSION",
"path": "VERSION",
"short": "Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution.",
"definition": "Abstract model of one Version within a Version container, containing data, commit audit trail, and the identifier of its Contribution.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "Owner_id_valid",
"severity": "error",
"human": "Owner id valid",
"expression": "owner_id().value().is_equal (uid().object_id.value())"
},
{
"key": "Preceding_version_uid_validity",
"severity": "error",
"human": "Preceding version uid validity must be present",
"expression": "uid().version_tree_id.is_first xor preceding_version_uid().exists()"
},
{
"key": "Lifecycle_state_ valid",
"severity": "error",
"human": "Lifecycle state valid must be present",
"expression": "lifecycle_state().exists() and then terminology (Term_id_openehr).has_code_for_group_id (Group_id_version_lifecycle_state, lifecycle_state().defining_code)"
}
],
"isModifier": false
},
{
"id": "VERSION.contribution",
"path": "VERSION.contribution",
"short": "Contribution in which this version was added.",
"definition": "Contribution in which this version was added. ",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "VERSION.signature",
"path": "VERSION.signature",
"short": "OpenPGP digital signature or digest of content committed in this Version.",
"definition": "OpenPGP digital signature or digest of content committed in this Version. ",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "VERSION.commit-audit",
"path": "VERSION.commit_audit",
"short": "Audit trail corresponding to the committal of this version to the `VERSIONED_OBJECT`.",
"definition": "Audit trail corresponding to the committal of this version to the `VERSIONED_OBJECT`.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/AUDIT-DETAILS"
}
],
"isModifier": false
}
]
}
}