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/FHIR/openehr-base-ig/ 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 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. Base definition for all types defined in FHIR type system. |
Short | One version in a VERSIONED_COMPOSITION: the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising cliniciansBase for all types and resources |
Comments | 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. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. COMPOSITION.name | |
Definition | 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. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. |
Short | Design-time archetype identifier of this node taken from its generating archetype |
Comments | 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. |
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 ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions. |
Short | Links to other archetyped structures |
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 |
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 languages. The language of an Entry if different from the Composition is indicated in ENTRY.language. |
Short | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages |
Control | 1..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
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. Coded from the ISO 3166 standard |
Control | 1..1 |
Binding | The codes SHALL be taken from Territories (required to https://specifications.openehr.org/fhir/valueset-territories ) |
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, e.g. * 431|persistent|, 451|episodic|, or 433|event| |
Control | 1..1 |
Binding | The codes SHALL be taken from Composition Category (required to https://specifications.openehr.org/fhir/valueset-composition_category ) |
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.e. the contextual attributes of the clinical session |
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 PARTY_PROXY will be used. |
Short | The person primarily responsible for the content of the Composition. This is the identifier which should appear on the screen |
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 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. |
Short | One version in a VERSIONED_COMPOSITION: the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians |
Comments | 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. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
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. |
Short | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages |
Control | 1..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
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. Coded from the ISO 3166 standard |
Control | 1..1 |
Binding | The codes SHALL be taken from Territories (required to https://specifications.openehr.org/fhir/valueset-territories ) |
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, e.g. * 431|persistent|, 451|episodic|, or 433|event| |
Control | 1..1 |
Binding | The codes SHALL be taken from Composition Category (required to https://specifications.openehr.org/fhir/valueset-composition_category ) |
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.e. the contextual attributes of the clinical session |
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 PARTY_PROXY will be used. |
Short | The person primarily responsible for the content of the Composition. This is the identifier which should appear on the screen |
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 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. |
Short | One version in a VERSIONED_COMPOSITION: the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians |
Comments | 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. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. COMPOSITION.name | |
Definition | 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. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. |
Short | Design-time archetype identifier of this node taken from its generating archetype |
Comments | 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. |
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 ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions. |
Short | Links to other archetyped structures |
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 |
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 languages. The language of an Entry if different from the Composition is indicated in ENTRY.language. |
Short | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages |
Control | 1..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
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. Coded from the ISO 3166 standard |
Control | 1..1 |
Binding | The codes SHALL be taken from Territories (required to https://specifications.openehr.org/fhir/valueset-territories ) |
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, e.g. * 431|persistent|, 451|episodic|, or 433|event| |
Control | 1..1 |
Binding | The codes SHALL be taken from Composition Category (required to https://specifications.openehr.org/fhir/valueset-composition_category ) |
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.e. the contextual attributes of the clinical session |
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 PARTY_PROXY will be used. |
Short | The person primarily responsible for the content of the Composition. This is the identifier which should appear on the screen |
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 |