OpenEHR Base package
0.1.0 - First Draft
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
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 NOTE: It is strongly recommended that the inherited attribute Base definition for all types defined in FHIR type system. |
Short | Content of one version in a `VERSIONED_COMPOSITION`.Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | Links_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. |
Short | Runtime name of this fragment, used to build runtime paths. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
Is Modifier | false |
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. At an archetype root point, the value of this attribute is always the stringified form of the |
Short | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. |
Control | 1..1 |
Type | string |
Is Modifier | false |
Primitive Value | This 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. |
Short | Optional globally unique object identifier for root points of archetyped structures. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/UID-BASED-ID |
Is Modifier | false |
8. COMPOSITION.links | |
Definition | Links to other archetyped structures (data whose root object inherits from |
Short | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/LINK |
Is Modifier | false |
10. COMPOSITION.archetype-details | |
Definition | Details of archetyping used on this node. |
Short | Details of archetyping used on this node. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ARCHETYPED |
Is Modifier | false |
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. |
Short | 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. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT |
Is Modifier | false |
14. COMPOSITION.language | |
Definition | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set |
Short | Mandatory indicator of the localised language in which this Composition is written. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
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. |
Short | Name of territory in which this Composition was written. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
18. COMPOSITION.category | |
Definition | Temporal category of this Composition, i.e.
or any other code defined in the openEHR terminology group 'category'. |
Short | Temporal category of this Composition, i. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT |
Is Modifier | false |
20. COMPOSITION.context | |
Definition | The clinical session context of this Composition, i.e. the contextual attributes of the clinical session. |
Short | The clinical session context of this Composition, i. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT |
Is Modifier | false |
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 |
Short | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
24. COMPOSITION.content | |
Definition | The content of this Composition. |
Short | The content of this Composition. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. COMPOSITION | |
Definition | Content of one version in a NOTE: It is strongly recommended that the inherited attribute |
Short | Content of one version in a `VERSIONED_COMPOSITION`. |
Control | 0..* |
Binding | The codes SHALL be taken from https://specifications.openehr.org/fhir/valueset-languages (required to https://specifications.openehr.org/fhir/valueset-languages ) |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | 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.language | |
Definition | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set |
Short | Mandatory indicator of the localised language in which this Composition is written. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
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. |
Short | Name of territory in which this Composition was written. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
6. COMPOSITION.category | |
Definition | Temporal category of this Composition, i.e.
or any other code defined in the openEHR terminology group 'category'. |
Short | Temporal category of this Composition, i. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT |
Is Modifier | false |
8. COMPOSITION.context | |
Definition | The clinical session context of this Composition, i.e. the contextual attributes of the clinical session. |
Short | The clinical session context of this Composition, i. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT |
Is Modifier | false |
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 |
Short | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
12. COMPOSITION.content | |
Definition | The content of this Composition. |
Short | The content of this Composition. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. COMPOSITION | |
Definition | Content of one version in a NOTE: It is strongly recommended that the inherited attribute |
Short | Content of one version in a `VERSIONED_COMPOSITION`. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | Links_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. |
Short | Runtime name of this fragment, used to build runtime paths. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-TEXT |
Is Modifier | false |
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. At an archetype root point, the value of this attribute is always the stringified form of the |
Short | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. |
Control | 1..1 |
Type | string |
Is Modifier | false |
Primitive Value | This 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. |
Short | Optional globally unique object identifier for root points of archetyped structures. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/UID-BASED-ID |
Is Modifier | false |
8. COMPOSITION.links | |
Definition | Links to other archetyped structures (data whose root object inherits from |
Short | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/LINK |
Is Modifier | false |
10. COMPOSITION.archetype-details | |
Definition | Details of archetyping used on this node. |
Short | Details of archetyping used on this node. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ARCHETYPED |
Is Modifier | false |
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. |
Short | 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. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT |
Is Modifier | false |
14. COMPOSITION.language | |
Definition | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set |
Short | Mandatory indicator of the localised language in which this Composition is written. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
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. |
Short | Name of territory in which this Composition was written. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |
18. COMPOSITION.category | |
Definition | Temporal category of this Composition, i.e.
or any other code defined in the openEHR terminology group 'category'. |
Short | Temporal category of this Composition, i. |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT |
Is Modifier | false |
20. COMPOSITION.context | |
Definition | The clinical session context of this Composition, i.e. the contextual attributes of the clinical session. |
Short | The clinical session context of this Composition, i. |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT |
Is Modifier | false |
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 |
Short | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). |
Control | 1..1 |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-PROXY |
Is Modifier | false |
24. COMPOSITION.content | |
Definition | The content of this Composition. |
Short | The content of this Composition. |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM |
Is Modifier | false |