AGENT - Definitions - OpenEHR Base package v0.1.0

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: AGENT - Detailed Descriptions

Page standards status: Informative

Maturity Level: 3

Definitions for the AGENT logical model.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. AGENT
Definition	Generic concept of any kind of agent, including devices, software systems, but not humans or organisations. Base definition for all types defined in FHIR type system.
Short	Generic concept of any kind of agent, including devices, software systems, but not humans or organisations.Base for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	Links_valid: Links valid must be present (`links.exists() implies links.empty().not()`) Archetyped_valid: Archetyped valid must satisfy exclusive conditions (`is_archetype_root() xor archetype_details .empty()`) Archetype_node_id_valid: Archetype node id valid must not be empty (`archetype_node_id.empty().not()`) Type_valid: Type valid (`type() = name`) Identities_valid: Identities valid must not be empty (`identities.empty().not()`) Contacts_valid: Contacts valid must be present (`contacts.exists() implies contacts.empty().not()`) Relationships_validity: Relationships validity must be present (`relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r \| r.source = self)`) Reverse_relationships_validity: 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))`) Is_archetype_root: Is archetype root (`is_archetype_root()`) Uid_mandatory: Uid mandatory must be present (`uid.exists()`) Roles_valid: Roles valid must be present (`roles.exists() implies roles.empty().not()`) Legal_identity_exists: Legal identity exists (`null # TODO: manual translation needed`)
2. AGENT.name
Definition	Runtime name of this fragment, used to build runtime paths. 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. AGENT.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. 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.
Short	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control	1..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. AGENT.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. AGENT.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 (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/LINK
Is Modifier	false
10. AGENT.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. AGENT.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, or from a conversion gateway which has synthesised this node.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifier	false
14. AGENT.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	1..*
Type	http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY
Is Modifier	false
16. AGENT.contacts
Definition	Contacts for this party.
Short	Contacts for this party.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/CONTACT
Is Modifier	false
18. AGENT.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. AGENT.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. AGENT.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
24. AGENT.languages
Definition	Languages which can be used to communicate with this actor, in preferred order of use (if known, else order irrelevant).
Short	Languages which can be used to communicate with this actor, in preferred order of use (if known, else order irrelevant).
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifier	false
26. AGENT.roles
Definition	Identifiers of the Version container for each Role played by this Party.
Short	Identifiers of the Version container for each Role played by this Party.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/PARTY-REF
Is Modifier	false

Guidance on how to interpret the contents of this table can be foundhere

0. AGENT
Definition	Generic concept of any kind of agent, including devices, software systems, but not humans or organisations.
Short	Generic concept of any kind of agent, including devices, software systems, but not humans or organisations.
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference

Guidance on how to interpret the contents of this table can be foundhere

0. AGENT
Definition	Generic concept of any kind of agent, including devices, software systems, but not humans or organisations.
Short	Generic concept of any kind of agent, including devices, software systems, but not humans or organisations.
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	Links_valid: Links valid must be present (`links.exists() implies links.empty().not()`) Archetyped_valid: Archetyped valid must satisfy exclusive conditions (`is_archetype_root() xor archetype_details .empty()`) Archetype_node_id_valid: Archetype node id valid must not be empty (`archetype_node_id.empty().not()`) Type_valid: Type valid (`type() = name`) Identities_valid: Identities valid must not be empty (`identities.empty().not()`) Contacts_valid: Contacts valid must be present (`contacts.exists() implies contacts.empty().not()`) Relationships_validity: Relationships validity must be present (`relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r \| r.source = self)`) Reverse_relationships_validity: 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))`) Is_archetype_root: Is archetype root (`is_archetype_root()`) Uid_mandatory: Uid mandatory must be present (`uid.exists()`) Roles_valid: Roles valid must be present (`roles.exists() implies roles.empty().not()`) Legal_identity_exists: Legal identity exists (`null # TODO: manual translation needed`)
2. AGENT.name
Definition	Runtime name of this fragment, used to build runtime paths. 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. AGENT.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. 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.
Short	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control	1..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. AGENT.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. AGENT.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 (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/LINK
Is Modifier	false
10. AGENT.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. AGENT.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, or from a conversion gateway which has synthesised this node.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifier	false
14. AGENT.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	1..*
Type	http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY
Is Modifier	false
16. AGENT.contacts
Definition	Contacts for this party.
Short	Contacts for this party.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/CONTACT
Is Modifier	false
18. AGENT.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. AGENT.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. AGENT.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
24. AGENT.languages
Definition	Languages which can be used to communicate with this actor, in preferred order of use (if known, else order irrelevant).
Short	Languages which can be used to communicate with this actor, in preferred order of use (if known, else order irrelevant).
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifier	false
26. AGENT.roles
Definition	Identifiers of the Version container for each Role played by this Party.
Short	Identifiers of the Version container for each Role played by this Party.
Control	0..*
Type	http://openehr.org/fhir/StructureDefinition/PARTY-REF
Is Modifier	false