OpenEHR Base package
0.1.0 - First Draft International flag

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

Logical Model: PARTY ( Abstract )

Official URL: http://openehr.org/fhir/StructureDefinition/PARTY Version: 0.1.0
Standards status: Informative Maturity Level: 3 Computable Name: PARTY

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).

NOTE: 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.

Original Source: specifications.openehr.org

Usages:

  • Derived from this Logical Model: ACTOR and ROLE

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PARTY C 0..* LOCATABLE This is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... 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.
... 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.
... identities 1..* PARTY_IDENTITY Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..* CONTACT Contacts for this party.
... details 0..1 ITEM_STRUCTURE All other details for this Party.
... reverse_relationships 0..* LOCATABLE_REF References to relationships in which this Party takes part as target.
... relationships 0..* PARTY_RELATIONSHIP Relationships in which this Party takes part as source.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error PARTY Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error PARTY Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Contacts_valid error PARTY Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error PARTY Identities valid must not be empty identities.empty().not()
Is_archetype_root error PARTY Is archetype root is_archetype_root()
Links_valid error PARTY Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error PARTY Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error PARTY Reverse relationships validity must be present reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\"demographics\").all_party_relationships.has_object (item) and then repository(\"demographics\").all_party_relationships.object (item).target = self))
Type_valid error PARTY Type valid type() = name
Uid_mandatory error PARTY Uid mandatory must be present uid.exists()

This structure is derived from LOCATABLE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PARTY C 0..* LOCATABLE This is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... identities 1..* PARTY_IDENTITY Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..* CONTACT Contacts for this party.
... details 0..1 ITEM_STRUCTURE All other details for this Party.
... relationships 0..* PARTY_RELATIONSHIP Relationships in which this Party takes part as source.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Contacts_valid error PARTY Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error PARTY Identities valid must not be empty identities.empty().not()
Is_archetype_root error PARTY Is archetype root is_archetype_root()
Relationships_validity error PARTY Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error PARTY Reverse relationships validity must be present reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\"demographics\").all_party_relationships.has_object (item) and then repository(\"demographics\").all_party_relationships.object (item).target = self))
Type_valid error PARTY Type valid type() = name
Uid_mandatory error PARTY Uid mandatory must be present uid.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PARTY C 0..* LOCATABLE This is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... 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.
... 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.
... identities 1..* PARTY_IDENTITY Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..* CONTACT Contacts for this party.
... details 0..1 ITEM_STRUCTURE All other details for this Party.
... reverse_relationships 0..* LOCATABLE_REF References to relationships in which this Party takes part as target.
... relationships 0..* PARTY_RELATIONSHIP Relationships in which this Party takes part as source.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error PARTY Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error PARTY Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Contacts_valid error PARTY Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error PARTY Identities valid must not be empty identities.empty().not()
Is_archetype_root error PARTY Is archetype root is_archetype_root()
Links_valid error PARTY Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error PARTY Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error PARTY Reverse relationships validity must be present reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\"demographics\").all_party_relationships.has_object (item) and then repository(\"demographics\").all_party_relationships.object (item).target = self))
Type_valid error PARTY Type valid type() = name
Uid_mandatory error PARTY Uid mandatory must be present uid.exists()

This structure is derived from LOCATABLE

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PARTY C 0..* LOCATABLE This is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... 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.
... 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.
... identities 1..* PARTY_IDENTITY Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..* CONTACT Contacts for this party.
... details 0..1 ITEM_STRUCTURE All other details for this Party.
... reverse_relationships 0..* LOCATABLE_REF References to relationships in which this Party takes part as target.
... relationships 0..* PARTY_RELATIONSHIP Relationships in which this Party takes part as source.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error PARTY Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error PARTY Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Contacts_valid error PARTY Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error PARTY Identities valid must not be empty identities.empty().not()
Is_archetype_root error PARTY Is archetype root is_archetype_root()
Links_valid error PARTY Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error PARTY Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error PARTY Reverse relationships validity must be present reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\"demographics\").all_party_relationships.has_object (item) and then repository(\"demographics\").all_party_relationships.object (item).target = self))
Type_valid error PARTY Type valid type() = name
Uid_mandatory error PARTY Uid mandatory must be present uid.exists()

Differential View

This structure is derived from LOCATABLE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PARTY C 0..* LOCATABLE This is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... identities 1..* PARTY_IDENTITY Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..* CONTACT Contacts for this party.
... details 0..1 ITEM_STRUCTURE All other details for this Party.
... relationships 0..* PARTY_RELATIONSHIP Relationships in which this Party takes part as source.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Contacts_valid error PARTY Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error PARTY Identities valid must not be empty identities.empty().not()
Is_archetype_root error PARTY Is archetype root is_archetype_root()
Relationships_validity error PARTY Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error PARTY Reverse relationships validity must be present reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\"demographics\").all_party_relationships.has_object (item) and then repository(\"demographics\").all_party_relationships.object (item).target = self))
Type_valid error PARTY Type valid type() = name
Uid_mandatory error PARTY Uid mandatory must be present uid.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PARTY C 0..* LOCATABLE This is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... 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.
... 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.
... identities 1..* PARTY_IDENTITY Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..* CONTACT Contacts for this party.
... details 0..1 ITEM_STRUCTURE All other details for this Party.
... reverse_relationships 0..* LOCATABLE_REF References to relationships in which this Party takes part as target.
... relationships 0..* PARTY_RELATIONSHIP Relationships in which this Party takes part as source.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error PARTY Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error PARTY Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Contacts_valid error PARTY Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error PARTY Identities valid must not be empty identities.empty().not()
Is_archetype_root error PARTY Is archetype root is_archetype_root()
Links_valid error PARTY Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error PARTY Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error PARTY Reverse relationships validity must be present reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\"demographics\").all_party_relationships.has_object (item) and then repository(\"demographics\").all_party_relationships.object (item).target = self))
Type_valid error PARTY Type valid type() = name
Uid_mandatory error PARTY Uid mandatory must be present uid.exists()

This structure is derived from LOCATABLE

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

 

Other representations of profile: CSV, Excel

Contained resources