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: ROLE

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

Generic description of a role performed by an Actor. The role corresponds to a competency of the Party. Roles are used to define the responsibilities undertaken by a Party for a purpose. Roles should have credentials qualifying the performer to perform the role.

Original Source: specifications.openehr.org

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

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
.. ROLE C 0..* PARTY Generic description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
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, Capabilities_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.
... 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.
... time_validity 0..1 DV_INTERVAL<DV_DATE> Valid time interval for this role.
... performer 1..1 PARTY_REF Reference to Version container of Actor playing the role.
... capabilities 0..* CAPABILITY The capabilities of this role.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error ROLE Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error ROLE Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Capabilities_valid error ROLE Capabilities valid must be present capabilities.exists() implies capabilities.empty().not()
Contacts_valid error ROLE Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error ROLE Identities valid must not be empty identities.empty().not()
Is_archetype_root error ROLE Is archetype root is_archetype_root()
Links_valid error ROLE Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error ROLE Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error ROLE 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 ROLE Type valid type() = name
Uid_mandatory error ROLE Uid mandatory must be present uid.exists()

This structure is derived from PARTY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ROLE C 0..* PARTY Generic description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
Constraints: Capabilities_valid
... time_validity 0..1 DV_INTERVAL<DV_DATE> Valid time interval for this role.
... performer 1..1 PARTY_REF Reference to Version container of Actor playing the role.
... capabilities 0..* CAPABILITY The capabilities of this role.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Capabilities_valid error ROLE Capabilities valid must be present capabilities.exists() implies capabilities.empty().not()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ROLE C 0..* PARTY Generic description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
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, Capabilities_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.
... 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.
... time_validity 0..1 DV_INTERVAL<DV_DATE> Valid time interval for this role.
... performer 1..1 PARTY_REF Reference to Version container of Actor playing the role.
... capabilities 0..* CAPABILITY The capabilities of this role.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error ROLE Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error ROLE Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Capabilities_valid error ROLE Capabilities valid must be present capabilities.exists() implies capabilities.empty().not()
Contacts_valid error ROLE Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error ROLE Identities valid must not be empty identities.empty().not()
Is_archetype_root error ROLE Is archetype root is_archetype_root()
Links_valid error ROLE Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error ROLE Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error ROLE 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 ROLE Type valid type() = name
Uid_mandatory error ROLE Uid mandatory must be present uid.exists()

This structure is derived from PARTY

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ROLE C 0..* PARTY Generic description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
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, Capabilities_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.
... 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.
... time_validity 0..1 DV_INTERVAL<DV_DATE> Valid time interval for this role.
... performer 1..1 PARTY_REF Reference to Version container of Actor playing the role.
... capabilities 0..* CAPABILITY The capabilities of this role.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error ROLE Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error ROLE Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Capabilities_valid error ROLE Capabilities valid must be present capabilities.exists() implies capabilities.empty().not()
Contacts_valid error ROLE Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error ROLE Identities valid must not be empty identities.empty().not()
Is_archetype_root error ROLE Is archetype root is_archetype_root()
Links_valid error ROLE Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error ROLE Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error ROLE 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 ROLE Type valid type() = name
Uid_mandatory error ROLE Uid mandatory must be present uid.exists()

Differential View

This structure is derived from PARTY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ROLE C 0..* PARTY Generic description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
Constraints: Capabilities_valid
... time_validity 0..1 DV_INTERVAL<DV_DATE> Valid time interval for this role.
... performer 1..1 PARTY_REF Reference to Version container of Actor playing the role.
... capabilities 0..* CAPABILITY The capabilities of this role.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Capabilities_valid error ROLE Capabilities valid must be present capabilities.exists() implies capabilities.empty().not()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ROLE C 0..* PARTY Generic description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
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, Capabilities_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.
... 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.
... time_validity 0..1 DV_INTERVAL<DV_DATE> Valid time interval for this role.
... performer 1..1 PARTY_REF Reference to Version container of Actor playing the role.
... capabilities 0..* CAPABILITY The capabilities of this role.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error ROLE Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error ROLE Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Capabilities_valid error ROLE Capabilities valid must be present capabilities.exists() implies capabilities.empty().not()
Contacts_valid error ROLE Contacts valid must be present contacts.exists() implies contacts.empty().not()
Identities_valid error ROLE Identities valid must not be empty identities.empty().not()
Is_archetype_root error ROLE Is archetype root is_archetype_root()
Links_valid error ROLE Links valid must be present links.exists() implies links.empty().not()
Relationships_validity error ROLE Relationships validity must be present relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)
Reverse_relationships_validity error ROLE 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 ROLE Type valid type() = name
Uid_mandatory error ROLE Uid mandatory must be present uid.exists()

This structure is derived from PARTY

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

 

Other representations of profile: CSV, Excel