OpenEHR Base package
0.1.0 - First Draft International flag

OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions

Logical Model: VERSIONED_COMPOSITION - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the VERSIONED-COMPOSITION logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. VERSIONED_COMPOSITION
Definition

Version-controlled composition abstraction, defined by inheriting VERSIONED_OBJECT\<COMPOSITION>.


Base definition for all types defined in FHIR type system.

ShortVersion-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`.Base for all types and resources
Control0..*
Type ParameterT : Any
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsVersion_count_valid: Version count valid must satisfy range constraints (version_count() >= 0)
All_version_ids_valid: All version ids valid (all_version_ids().count() = version_count())
All_versions_valid: All versions valid (all_versions().count() = version_count())
Latest_version_valid: Latest version valid must be present (version_count() > 0 implies latest_version().exists())
Uid_validity: Uid validity must not be empty (extension.empty())
Archetype_node_id_valid: Archetype node id valid (for_all v in all_versions() | v.archetype_node_id.is_equal (all_versions().first().archetype_node_id))
Persistent_validity: Persistent validity (for_all v in all_versions() | v.is_persistent() = all_versions().first().data.is_persistent())
2. VERSIONED_COMPOSITION.uid
Definition

Unique identifier of this version container in the form of a UID with no extension. This id will be the same in all instances of the same container in a distributed environment, meaning that it can be understood as the uid of the virtual version tree.

ShortUnique identifier of this version container in the form of a UID with no extension.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
4. VERSIONED_COMPOSITION.owner-id
Definition

Reference to object to which this version container belongs, e.g. the id of the containing EHR or other relevant owning entity.

ShortReference to object to which this version container belongs, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
6. VERSIONED_COMPOSITION.time-created
Definition

Time of initial creation of this versioned object.

ShortTime of initial creation of this versioned object.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. VERSIONED_COMPOSITION
Definition

Version-controlled composition abstraction, defined by inheriting VERSIONED_OBJECT\<COMPOSITION>.

ShortVersion-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`.
Control0..*
Type ParameterT : Any
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsArchetype_node_id_valid: Archetype node id valid (for_all v in all_versions() | v.archetype_node_id.is_equal (all_versions().first().archetype_node_id))
Persistent_validity: Persistent validity (for_all v in all_versions() | v.is_persistent() = all_versions().first().data.is_persistent())

Guidance on how to interpret the contents of this table can be foundhere

0. VERSIONED_COMPOSITION
Definition

Version-controlled composition abstraction, defined by inheriting VERSIONED_OBJECT\<COMPOSITION>.

ShortVersion-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`.
Control0..*
Type ParameterT : Any
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsVersion_count_valid: Version count valid must satisfy range constraints (version_count() >= 0)
All_version_ids_valid: All version ids valid (all_version_ids().count() = version_count())
All_versions_valid: All versions valid (all_versions().count() = version_count())
Latest_version_valid: Latest version valid must be present (version_count() > 0 implies latest_version().exists())
Uid_validity: Uid validity must not be empty (extension.empty())
Archetype_node_id_valid: Archetype node id valid (for_all v in all_versions() | v.archetype_node_id.is_equal (all_versions().first().archetype_node_id))
Persistent_validity: Persistent validity (for_all v in all_versions() | v.is_persistent() = all_versions().first().data.is_persistent())
2. VERSIONED_COMPOSITION.uid
Definition

Unique identifier of this version container in the form of a UID with no extension. This id will be the same in all instances of the same container in a distributed environment, meaning that it can be understood as the uid of the virtual version tree.

ShortUnique identifier of this version container in the form of a UID with no extension.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID
Is Modifierfalse
4. VERSIONED_COMPOSITION.owner-id
Definition

Reference to object to which this version container belongs, e.g. the id of the containing EHR or other relevant owning entity.

ShortReference to object to which this version container belongs, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
6. VERSIONED_COMPOSITION.time-created
Definition

Time of initial creation of this versioned object.

ShortTime of initial creation of this versioned object.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse