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: COMPOSITION - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the COMPOSITION logical model.

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

0. COMPOSITION
Definition

Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.

NOTE: It is strongly recommended that the inherited attribute _uid_ be populated in Compositions, using the UID copied from the _object_id()_ of the _uid_ field of the enclosing VERSION object. + For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the _uid_ field of the Composition.


Base definition for all types defined in FHIR type system.

ShortContent of one version in a `VERSIONED_COMPOSITION`.Base for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLinks_valid: Links valid must be present (links.exists() implies links.empty().not())
Archetyped_valid: Archetyped valid must satisfy exclusive conditions (is_archetype_root() xor archetype_details .empty())
Archetype_node_id_valid: Archetype node id valid must not be empty (archetype_node_id.empty().not())
Setting_valid: Setting valid (null # TODO: manual translation needed)
unnamed2: unnamed2 (null # TODO: manual translation needed)
unnamed3: unnamed3 (null # TODO: manual translation needed)
Category_validity: Category validity (null # TODO: manual translation needed)
Is_persistent_validity: Is persistent validity must satisfy conditional constraints (is_persistent() implies context .empty())
Content_valid: Content valid must be present (content.exists() implies content.empty().not())
Is_archetype_root: Is archetype root (is_archetype_root())
2. COMPOSITION.name
Definition

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.

ShortRuntime name of this fragment, used to build runtime paths.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. COMPOSITION.archetype-node-id
Definition

Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

At an archetype root point, the value of this attribute is always the stringified form of the _archetype_id_ found in the _archetype_details_ object.

ShortDesign-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. COMPOSITION.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. COMPOSITION.links
Definition

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.

ShortLinks to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. COMPOSITION.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. COMPOSITION.feeder-audit
Definition

Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.

ShortAudit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. COMPOSITION.language
Definition

Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY._language_.

ShortMandatory indicator of the localised language in which this Composition is written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
16. COMPOSITION.territory
Definition

Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.

ShortName of territory in which this Composition was written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
18. COMPOSITION.category
Definition

Temporal category of this Composition, i.e.

  • 431|persistent| - of potential life-time validity;
  • 451|episodic| - valid over the life of a care episode;
  • 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment).

or any other code defined in the openEHR terminology group 'category'.

ShortTemporal category of this Composition, i.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
20. COMPOSITION.context
Definition

The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.

ShortThe clinical session context of this Composition, i.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT
Is Modifierfalse
22. COMPOSITION.composer
Definition

The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.

ShortThe person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system).
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse
24. COMPOSITION.content
Definition

The content of this Composition.

ShortThe content of this Composition.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/CONTENT-ITEM
Is Modifierfalse

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

0. COMPOSITION
Definition

Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.

NOTE: It is strongly recommended that the inherited attribute _uid_ be populated in Compositions, using the UID copied from the _object_id()_ of the _uid_ field of the enclosing VERSION object. + For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the _uid_ field of the Composition.

ShortContent of one version in a `VERSIONED_COMPOSITION`.
Control0..*
BindingThe codes SHALL be taken from https://specifications.openehr.org/fhir/valueset-languages
(required to https://specifications.openehr.org/fhir/valueset-languages)
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsSetting_valid: Setting valid (null # TODO: manual translation needed)
unnamed2: unnamed2 (null # TODO: manual translation needed)
unnamed3: unnamed3 (null # TODO: manual translation needed)
Category_validity: Category validity (null # TODO: manual translation needed)
Is_persistent_validity: Is persistent validity must satisfy conditional constraints (is_persistent() implies context .empty())
Content_valid: Content valid must be present (content.exists() implies content.empty().not())
Is_archetype_root: Is archetype root (is_archetype_root())
2. COMPOSITION.language
Definition

Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY._language_.

ShortMandatory indicator of the localised language in which this Composition is written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. COMPOSITION.territory
Definition

Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.

ShortName of territory in which this Composition was written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
6. COMPOSITION.category
Definition

Temporal category of this Composition, i.e.

  • 431|persistent| - of potential life-time validity;
  • 451|episodic| - valid over the life of a care episode;
  • 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment).

or any other code defined in the openEHR terminology group 'category'.

ShortTemporal category of this Composition, i.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. COMPOSITION.context
Definition

The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.

ShortThe clinical session context of this Composition, i.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT
Is Modifierfalse
10. COMPOSITION.composer
Definition

The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.

ShortThe person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system).
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse
12. COMPOSITION.content
Definition

The content of this Composition.

ShortThe content of this Composition.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/CONTENT-ITEM
Is Modifierfalse

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

0. COMPOSITION
Definition

Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.

NOTE: It is strongly recommended that the inherited attribute _uid_ be populated in Compositions, using the UID copied from the _object_id()_ of the _uid_ field of the enclosing VERSION object. + For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the _uid_ field of the Composition.

ShortContent of one version in a `VERSIONED_COMPOSITION`.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLinks_valid: Links valid must be present (links.exists() implies links.empty().not())
Archetyped_valid: Archetyped valid must satisfy exclusive conditions (is_archetype_root() xor archetype_details .empty())
Archetype_node_id_valid: Archetype node id valid must not be empty (archetype_node_id.empty().not())
Setting_valid: Setting valid (null # TODO: manual translation needed)
unnamed2: unnamed2 (null # TODO: manual translation needed)
unnamed3: unnamed3 (null # TODO: manual translation needed)
Category_validity: Category validity (null # TODO: manual translation needed)
Is_persistent_validity: Is persistent validity must satisfy conditional constraints (is_persistent() implies context .empty())
Content_valid: Content valid must be present (content.exists() implies content.empty().not())
Is_archetype_root: Is archetype root (is_archetype_root())
2. COMPOSITION.name
Definition

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.

ShortRuntime name of this fragment, used to build runtime paths.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. COMPOSITION.archetype-node-id
Definition

Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

At an archetype root point, the value of this attribute is always the stringified form of the _archetype_id_ found in the _archetype_details_ object.

ShortDesign-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. COMPOSITION.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. COMPOSITION.links
Definition

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.

ShortLinks to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. COMPOSITION.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. COMPOSITION.feeder-audit
Definition

Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.

ShortAudit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. COMPOSITION.language
Definition

Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY._language_.

ShortMandatory indicator of the localised language in which this Composition is written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
16. COMPOSITION.territory
Definition

Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.

ShortName of territory in which this Composition was written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
18. COMPOSITION.category
Definition

Temporal category of this Composition, i.e.

  • 431|persistent| - of potential life-time validity;
  • 451|episodic| - valid over the life of a care episode;
  • 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment).

or any other code defined in the openEHR terminology group 'category'.

ShortTemporal category of this Composition, i.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
20. COMPOSITION.context
Definition

The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.

ShortThe clinical session context of this Composition, i.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT
Is Modifierfalse
22. COMPOSITION.composer
Definition

The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.

ShortThe person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system).
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse
24. COMPOSITION.content
Definition

The content of this Composition.

ShortThe content of this Composition.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/CONTENT-ITEM
Is Modifierfalse