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/FOLDER | Version: 0.1.0 | |||
| Standards status: Informative | Maturity Level: 3 | Computable Name: FOLDER | ||
The concept of a named folder.
NOTE: It is strongly recommended that the inherited attribute _uid_ be populated in top-level (i.e. tree-root) FOLDER objects, 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 top FOLDER object.
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:   |
|---|---|---|---|---|
  FOLDER |
C | 0..* | LOCATABLE | The concept of a named folder. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Folders_valid |
  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. | |
| items |
0..* | OBJECT_REF | The list of references to other (usually) versioned objects logically in this folder. | |
| folders |
0..* | FOLDER | Sub-folders of this `FOLDER`. | |
 details |
0..1 | ITEM_STRUCTURE | Archetypable meta-data for `FOLDER`. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | FOLDER | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | FOLDER | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Folders_valid | error | FOLDER | Folders valid must not be empty |
folders.empty().not()
|
| Links_valid | error | FOLDER | Links valid must be present |
links.exists() implies links.empty().not()
|
This structure is derived from LOCATABLE
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FOLDER |
C | 0..* | LOCATABLE | The concept of a named folder. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Folders_valid |
| items |
0..* | OBJECT_REF | The list of references to other (usually) versioned objects logically in this folder. | |
| folders |
0..* | FOLDER | Sub-folders of this `FOLDER`. | |
| details |
0..1 | ITEM_STRUCTURE | Archetypable meta-data for `FOLDER`. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Folders_valid | error | FOLDER | Folders valid must not be empty |
folders.empty().not()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FOLDER |
C | 0..* | LOCATABLE | The concept of a named folder. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Folders_valid |
| 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. | |
| items |
0..* | OBJECT_REF | The list of references to other (usually) versioned objects logically in this folder. | |
| folders |
0..* | FOLDER | Sub-folders of this `FOLDER`. | |
| details |
0..1 | ITEM_STRUCTURE | Archetypable meta-data for `FOLDER`. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | FOLDER | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | FOLDER | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Folders_valid | error | FOLDER | Folders valid must not be empty |
folders.empty().not()
|
| Links_valid | error | FOLDER | Links valid must be present |
links.exists() implies links.empty().not()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FOLDER |
C | 0..* | LOCATABLE | The concept of a named folder. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Folders_valid |
| 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. | |
| items |
0..* | OBJECT_REF | The list of references to other (usually) versioned objects logically in this folder. | |
| folders |
0..* | FOLDER | Sub-folders of this `FOLDER`. | |
| details |
0..1 | ITEM_STRUCTURE | Archetypable meta-data for `FOLDER`. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | FOLDER | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | FOLDER | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Folders_valid | error | FOLDER | Folders valid must not be empty |
folders.empty().not()
|
| Links_valid | error | FOLDER | Links valid must be present |
links.exists() implies links.empty().not()
|
Differential View
This structure is derived from LOCATABLE
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FOLDER |
C | 0..* | LOCATABLE | The concept of a named folder. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Folders_valid |
| items |
0..* | OBJECT_REF | The list of references to other (usually) versioned objects logically in this folder. | |
| folders |
0..* | FOLDER | Sub-folders of this `FOLDER`. | |
| details |
0..1 | ITEM_STRUCTURE | Archetypable meta-data for `FOLDER`. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Folders_valid | error | FOLDER | Folders valid must not be empty |
folders.empty().not()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| FOLDER |
C | 0..* | LOCATABLE | The concept of a named folder. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Folders_valid |
| 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. | |
| items |
0..* | OBJECT_REF | The list of references to other (usually) versioned objects logically in this folder. | |
| folders |
0..* | FOLDER | Sub-folders of this `FOLDER`. | |
| details |
0..1 | ITEM_STRUCTURE | Archetypable meta-data for `FOLDER`. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Archetype_node_id_valid | error | FOLDER | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| Archetyped_valid | error | FOLDER | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| Folders_valid | error | FOLDER | Folders valid must not be empty |
folders.empty().not()
|
| Links_valid | error | FOLDER | Links valid must be present |
links.exists() implies links.empty().not()
|