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 PARTY logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. PARTY | |
Definition | Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The name attribute inherited from LOCATABLE is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the identities attribute, not the name attribute). Base definition for all types defined in FHIR type system. |
Short | Ancestor of all Party types, including real world entities and their rolesBase for all types and resources |
Comments | It is strongly recommended that the inherited attribute uid be populated in PARTY 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 PARTY object. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. PARTY.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. PARTY.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. PARTY.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. PARTY.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. PARTY.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. PARTY.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. PARTY.identities | |
Definition | Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on. |
Short | Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY |
Is Modifier | false |
16. PARTY.contacts | |
Definition | Contacts for this party. |
Short | Contacts for this party |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/CONTACT |
Is Modifier | false |
18. PARTY.details | |
Definition | All other details for this Party. |
Short | All other details for this Party |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
20. PARTY.reverse-relationships | |
Definition | References to relationships in which this Party takes part as target. |
Short | References to relationships in which this Party takes part as target |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/LOCATABLE-REF |
Is Modifier | false |
22. PARTY.relationships | |
Definition | Relationships in which this Party takes part as source. |
Short | Relationships in which this Party takes part as source |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. PARTY | |
Definition | Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The name attribute inherited from LOCATABLE is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the identities attribute, not the name attribute). |
Short | Ancestor of all Party types, including real world entities and their roles |
Comments | It is strongly recommended that the inherited attribute uid be populated in PARTY 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 PARTY object. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. PARTY.identities | |
Definition | Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on. |
Short | Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY |
Is Modifier | false |
4. PARTY.contacts | |
Definition | Contacts for this party. |
Short | Contacts for this party |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/CONTACT |
Is Modifier | false |
6. PARTY.details | |
Definition | All other details for this Party. |
Short | All other details for this Party |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
8. PARTY.reverse-relationships | |
Definition | References to relationships in which this Party takes part as target. |
Short | References to relationships in which this Party takes part as target |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/LOCATABLE-REF |
Is Modifier | false |
10. PARTY.relationships | |
Definition | Relationships in which this Party takes part as source. |
Short | Relationships in which this Party takes part as source |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP |
Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
0. PARTY | |
Definition | Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The name attribute inherited from LOCATABLE is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the identities attribute, not the name attribute). |
Short | Ancestor of all Party types, including real world entities and their roles |
Comments | It is strongly recommended that the inherited attribute uid be populated in PARTY 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 PARTY object. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. PARTY.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. PARTY.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. PARTY.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. PARTY.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. PARTY.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. PARTY.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. PARTY.identities | |
Definition | Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on. |
Short | Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY |
Is Modifier | false |
16. PARTY.contacts | |
Definition | Contacts for this party. |
Short | Contacts for this party |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/CONTACT |
Is Modifier | false |
18. PARTY.details | |
Definition | All other details for this Party. |
Short | All other details for this Party |
Control | 0..1 |
Type | http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE |
Is Modifier | false |
20. PARTY.reverse-relationships | |
Definition | References to relationships in which this Party takes part as target. |
Short | References to relationships in which this Party takes part as target |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/LOCATABLE-REF |
Is Modifier | false |
22. PARTY.relationships | |
Definition | Relationships in which this Party takes part as source. |
Short | Relationships in which this Party takes part as source |
Control | 0..* |
Type | http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP |
Is Modifier | false |