OpenEHR Base package
0.1.0 - First Draft
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
| Official URL: http://openehr.org/fhir/StructureDefinition/COMPOSITION | Version: 0.1.0 | |||
| Standards status: Informative | Maturity Level: 3 | Computable Name: COMPOSITION | ||
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.
Original Source: specifications.openehr.org
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  COMPOSITION |
C | 0..* | LOCATABLE | Content of one version in a `VERSIONED_COMPOSITION`. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root |
  name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
 archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| language |
1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. | |
| territory |
1..1 | CODE_PHRASE | Name of territory in which this Composition was written. | |
| category |
1..1 | DV_CODED_TEXT | Temporal category of this Composition, i. | |
| context |
0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i. | |
| composer |
1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). | |
 content |
0..* | CONTENT_ITEM | The content of this Composition. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | COMPOSITION | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | COMPOSITION | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Category_validity | error | COMPOSITION | Category validity |
null # TODO: manual translation needed
|
| Content_valid | error | COMPOSITION | Content valid must be present |
content.exists() implies content.empty().not()
|
| Is_archetype_root | error | COMPOSITION | Is archetype root |
is_archetype_root()
|
| Is_persistent_validity | error | COMPOSITION | Is persistent validity must satisfy conditional constraints |
is_persistent() implies context .empty()
|
| Links_valid | error | COMPOSITION | Links valid must be present |
links.exists() implies links.empty().not()
|
| Setting_valid | error | COMPOSITION | Setting valid |
null # TODO: manual translation needed
|
| unnamed2 | error | COMPOSITION | unnamed2 |
null # TODO: manual translation needed
|
| unnamed3 | error | COMPOSITION | unnamed3 |
null # TODO: manual translation needed
|
This structure is derived from LOCATABLE
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| COMPOSITION |
C | 0..* | LOCATABLE | Content of one version in a `VERSIONED_COMPOSITION`. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Binding: https://specifications.openehr.org/fhir/valueset-languages (required) Constraints: Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root |
| language |
1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. | |
| territory |
1..1 | CODE_PHRASE | Name of territory in which this Composition was written. | |
| category |
1..1 | DV_CODED_TEXT | Temporal category of this Composition, i. | |
| context |
0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i. | |
| composer |
1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). | |
| content |
0..* | CONTENT_ITEM | The content of this Composition. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| COMPOSITION | Base | required | https://specifications.openehr.org/fhir/valueset-languages | Not Stated | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| Category_validity | error | COMPOSITION | Category validity |
null # TODO: manual translation needed
|
| Content_valid | error | COMPOSITION | Content valid must be present |
content.exists() implies content.empty().not()
|
| Is_archetype_root | error | COMPOSITION | Is archetype root |
is_archetype_root()
|
| Is_persistent_validity | error | COMPOSITION | Is persistent validity must satisfy conditional constraints |
is_persistent() implies context .empty()
|
| Setting_valid | error | COMPOSITION | Setting valid |
null # TODO: manual translation needed
|
| unnamed2 | error | COMPOSITION | unnamed2 |
null # TODO: manual translation needed
|
| unnamed3 | error | COMPOSITION | unnamed3 |
null # TODO: manual translation needed
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| COMPOSITION |
C | 0..* | LOCATABLE | Content of one version in a `VERSIONED_COMPOSITION`. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root |
| name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| language |
1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. | |
| territory |
1..1 | CODE_PHRASE | Name of territory in which this Composition was written. | |
| category |
1..1 | DV_CODED_TEXT | Temporal category of this Composition, i. | |
| context |
0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i. | |
| composer |
1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). | |
| content |
0..* | CONTENT_ITEM | The content of this Composition. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | COMPOSITION | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | COMPOSITION | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Category_validity | error | COMPOSITION | Category validity |
null # TODO: manual translation needed
|
| Content_valid | error | COMPOSITION | Content valid must be present |
content.exists() implies content.empty().not()
|
| Is_archetype_root | error | COMPOSITION | Is archetype root |
is_archetype_root()
|
| Is_persistent_validity | error | COMPOSITION | Is persistent validity must satisfy conditional constraints |
is_persistent() implies context .empty()
|
| Links_valid | error | COMPOSITION | Links valid must be present |
links.exists() implies links.empty().not()
|
| Setting_valid | error | COMPOSITION | Setting valid |
null # TODO: manual translation needed
|
| unnamed2 | error | COMPOSITION | unnamed2 |
null # TODO: manual translation needed
|
| unnamed3 | error | COMPOSITION | unnamed3 |
null # TODO: manual translation needed
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| COMPOSITION |
C | 0..* | LOCATABLE | Content of one version in a `VERSIONED_COMPOSITION`. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root |
| name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| language |
1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. | |
| territory |
1..1 | CODE_PHRASE | Name of territory in which this Composition was written. | |
| category |
1..1 | DV_CODED_TEXT | Temporal category of this Composition, i. | |
| context |
0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i. | |
| composer |
1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). | |
| content |
0..* | CONTENT_ITEM | The content of this Composition. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | COMPOSITION | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | COMPOSITION | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Category_validity | error | COMPOSITION | Category validity |
null # TODO: manual translation needed
|
| Content_valid | error | COMPOSITION | Content valid must be present |
content.exists() implies content.empty().not()
|
| Is_archetype_root | error | COMPOSITION | Is archetype root |
is_archetype_root()
|
| Is_persistent_validity | error | COMPOSITION | Is persistent validity must satisfy conditional constraints |
is_persistent() implies context .empty()
|
| Links_valid | error | COMPOSITION | Links valid must be present |
links.exists() implies links.empty().not()
|
| Setting_valid | error | COMPOSITION | Setting valid |
null # TODO: manual translation needed
|
| unnamed2 | error | COMPOSITION | unnamed2 |
null # TODO: manual translation needed
|
| unnamed3 | error | COMPOSITION | unnamed3 |
null # TODO: manual translation needed
|
Differential View
This structure is derived from LOCATABLE
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| COMPOSITION |
C | 0..* | LOCATABLE | Content of one version in a `VERSIONED_COMPOSITION`. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Binding: https://specifications.openehr.org/fhir/valueset-languages (required) Constraints: Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root |
| language |
1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. | |
| territory |
1..1 | CODE_PHRASE | Name of territory in which this Composition was written. | |
| category |
1..1 | DV_CODED_TEXT | Temporal category of this Composition, i. | |
| context |
0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i. | |
| composer |
1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). | |
| content |
0..* | CONTENT_ITEM | The content of this Composition. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| COMPOSITION | Base | required | https://specifications.openehr.org/fhir/valueset-languages | Not Stated | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| Category_validity | error | COMPOSITION | Category validity |
null # TODO: manual translation needed
|
| Content_valid | error | COMPOSITION | Content valid must be present |
content.exists() implies content.empty().not()
|
| Is_archetype_root | error | COMPOSITION | Is archetype root |
is_archetype_root()
|
| Is_persistent_validity | error | COMPOSITION | Is persistent validity must satisfy conditional constraints |
is_persistent() implies context .empty()
|
| Setting_valid | error | COMPOSITION | Setting valid |
null # TODO: manual translation needed
|
| unnamed2 | error | COMPOSITION | unnamed2 |
null # TODO: manual translation needed
|
| unnamed3 | error | COMPOSITION | unnamed3 |
null # TODO: manual translation needed
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| COMPOSITION |
C | 0..* | LOCATABLE | Content of one version in a `VERSIONED_COMPOSITION`. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root |
| name |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit |
0..1 | FEEDER_AUDIT | 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. | |
| language |
1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. | |
| territory |
1..1 | CODE_PHRASE | Name of territory in which this Composition was written. | |
| category |
1..1 | DV_CODED_TEXT | Temporal category of this Composition, i. | |
| context |
0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i. | |
| composer |
1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). | |
| content |
0..* | CONTENT_ITEM | The content of this Composition. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | COMPOSITION | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | COMPOSITION | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Category_validity | error | COMPOSITION | Category validity |
null # TODO: manual translation needed
|
| Content_valid | error | COMPOSITION | Content valid must be present |
content.exists() implies content.empty().not()
|
| Is_archetype_root | error | COMPOSITION | Is archetype root |
is_archetype_root()
|
| Is_persistent_validity | error | COMPOSITION | Is persistent validity must satisfy conditional constraints |
is_persistent() implies context .empty()
|
| Links_valid | error | COMPOSITION | Links valid must be present |
links.exists() implies links.empty().not()
|
| Setting_valid | error | COMPOSITION | Setting valid |
null # TODO: manual translation needed
|
| unnamed2 | error | COMPOSITION | unnamed2 |
null # TODO: manual translation needed
|
| unnamed3 | error | COMPOSITION | unnamed3 |
null # TODO: manual translation needed
|
Other representations of profile: CSV, Excel