RecordRelation¶
Generalization is AnnotatedIdentifiable.
Superclass hierarchy
Definition¶
Relationships among record types within and between logical records.
Examples¶
One LogicalRecord containing a PersonIdentifier and a PersonName and another LogicalRecord containing a MeasurementID, a PersonID, a SystolicPressure, and a DiastolicPressure could be linked by a RecordRelation. The RecordRelation could employ an InstanceVariableValueMap to describe the linkage between PersonIdentifier and PersonID.
A household-level LogicalRecord might contain an InstanceVariable called HouseholdID and a person-level LogicalRecord might contain an InstanceVariable called HID. Describing a link between HouseholdID and HID would allow the linking of a person-level LogicalRecord to their corresponding household-level LogicalRecord.
Explanatory notes¶
For InstanceVariables existing in a LogicalRecord with multiple record layouts, pairs of InstanceVariables may function as paired keys to permit the expression of hierarchical links between records of different types. These links between keys in different record types could also be used to link records in a relational structure.
Subclasses¶
Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
displayLabel
from RecordRelation
|
A display label for the relation. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. |
0..* |
|
purpose
from RecordRelation
|
Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. |
0..1 |
|
usage
from RecordRelation
|
Explanation of the ways in which some decision or object is employed. Supports the use of multiple languages and structured text. |
0..1 |
Inherited Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
agency
from Identifiable
|
Agency expressed as filed with the DDI Agency ID registry [registry.ddialliance.org] with optional additional sub-agency extensions. |
:ref:`` |
1..1 |
id
from Identifiable
|
ID conforming to the allowed structure of the DDI Identifier and must be unique within the Agency. |
:ref:`` |
1..1 |
isPersistent
from Identifiable
|
Default value is false indicating that the content of the current version may change (may be in development mode). Set to true when the content of this version will no longer change. |
:ref:`` |
1..1 |
isUniversallyUnique
from Identifiable
|
Default value is false. If the id of the object was created as a Universally Unique ID (UUID) set to true. |
:ref:`` |
1..1 |
localId
from Identifiable
|
Locally used identifier unique with a specified context, such as a variable name within a dataset. |
0..* |
|
version
from Identifiable
|
Version number of the object. |
:ref:`` |
1..1 |
versionDate
from Identifiable
|
Date and time the object was changed expressed in standard ISO formats. |
0..1 |
|
versionRationale
from Identifiable
|
Reason for making a new version of the object. |
0..1 |
|
versionResponsibility
from Identifiable
|
Contributor who has the ownership and responsibility for the current version. |
:ref:`` |
0..1 |
Associations¶
Multiplicity |
Association |
Navigable Class |
Multiplicity |
---|---|---|---|
0..* |
RecordRelation_maps_UnitDataRecord |
2..* |
|
0..* |
RecordRelation_has_InstanceVariableMap |
0..1 |
TBD
Diagram¶
TBD