This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Datatypes R2 Issue 5"

From HL7Wiki
Jump to navigation Jump to search
 
Line 3: Line 3:
 
== Introduction ==
 
== Introduction ==
  
 +
Add a new controlActIdReference property to the HXIT datatype.
  
? backward compatible.
+
This was part of the resolution to managing history of individual attribute occurrences.  It allows each attribute occurrence to link to the ControlAct event which caused the value expressed by the attribute to come into effect.
 +
 
 +
backward compatible: This change would remove the assertion that an HXIT<EN> and EN are one and the same.
 +
 
 +
Control Query, MnM
  
 
== Discussion ==
 
== Discussion ==
  
 +
History Item (HXIT) specializes T
 +
   
 +
Definition:      A generic data type extension that tags a time range and/or link to the ControlAct associated with the creation of the data to any data value of any data type. The time range is the time in which the information represented by the value is (was) valid.  The ControlAct id reference indicates the event responsible for the value of the datatype.
 +
   
 +
If the base type T does not possess a validTime property, the HXIT adds that property to the base type. If, however, the base type T does have a valid time property (currently only EN), that property is mapped to the valid time property of the HXIT.52
 +
   
 +
Definition 234:
 +
template<ANY T>
 +
type HistoryItem<T> alias HXIT<T> specializes T {
 +
    IVL<TS> validTime;
 +
    II controlActIdReference;
 +
};
 +
   
 +
Control Act Id Reference (controlActIdReference : II)
 +
   
 +
Definition:      The identifier of the ControlAct associated with setting the datatype to its specified value.
 +
By referencing a particular ControlAct, the property links to all of the information surrounding that ControlAct, such as who made the change, when it was made, why it was made, what system originated the change, etc.
 +
History Item (HXIT)
 +
   
 +
Table 42: Components of History Item
 +
Name Type Description
 +
controlActIdReference II The identifier of the ControlAct associated with setting the datatype to its specified value.
 +
   
 +
For example, a value of type HXIT<CS> extended from a Coded Simple Value (CS) data type has all of the properties of the original CS value, plus a time range indicating when that code is or was valid and a reference to the ControlActEvent responsible for the CS attribute attaining its current value.
 +
   
 +
Data types that already have a valid time range property (i.e., EN and specialisations) obviously do not need these extensions. Their valid time range property can be mapped to the valid time property of the HXIT
 +
 +
<gsd:templatename="HXIT">
 +
    <gsd:paramname="T" type="ANY" />
 +
    <xsd:complexType>
 +
        <xsd:complexContent>
 +
            <xsd:extension>
 +
                <gsd:attributename="base" type="T" />
 +
                <xsd:sequence>
 +
                    <xsd:elementname="validTime" ... />
 +
                    <xsd:elementname="controlActIdReference" type="II" minOccurs="0" maxOccurs="1"/>
 +
                </xsd:sequence>
 +
            </xsd:extension>
 +
        </xsd:complexContent>
 +
    </xsd:complexType>
 +
</gsd:template>
 +
 +
== Disposition ==
 +
 +
== Status ==
 +
 +
Proposed
  
 
== Links ==
 
== Links ==
 
Back to [[Data Types R2 issues]]
 
Back to [[Data Types R2 issues]]

Revision as of 03:05, 12 January 2007

Data Types Issue 5: Add HIST.controlActIdRef

Introduction

Add a new controlActIdReference property to the HXIT datatype.

This was part of the resolution to managing history of individual attribute occurrences. It allows each attribute occurrence to link to the ControlAct event which caused the value expressed by the attribute to come into effect.

backward compatible: This change would remove the assertion that an HXIT<EN> and EN are one and the same.

Control Query, MnM

Discussion

History Item (HXIT) specializes T

Definition: A generic data type extension that tags a time range and/or link to the ControlAct associated with the creation of the data to any data value of any data type. The time range is the time in which the information represented by the value is (was) valid. The ControlAct id reference indicates the event responsible for the value of the datatype.

If the base type T does not possess a validTime property, the HXIT adds that property to the base type. If, however, the base type T does have a valid time property (currently only EN), that property is mapped to the valid time property of the HXIT.52

Definition 234: template<ANY T> type HistoryItem<T> alias HXIT<T> specializes T {

   IVL<TS> validTime;
   II controlActIdReference;

};

Control Act Id Reference (controlActIdReference : II)

Definition: The identifier of the ControlAct associated with setting the datatype to its specified value. By referencing a particular ControlAct, the property links to all of the information surrounding that ControlAct, such as who made the change, when it was made, why it was made, what system originated the change, etc. History Item (HXIT)

Table 42: Components of History Item Name Type Description controlActIdReference II The identifier of the ControlAct associated with setting the datatype to its specified value.

For example, a value of type HXIT<CS> extended from a Coded Simple Value (CS) data type has all of the properties of the original CS value, plus a time range indicating when that code is or was valid and a reference to the ControlActEvent responsible for the CS attribute attaining its current value.

Data types that already have a valid time range property (i.e., EN and specialisations) obviously do not need these extensions. Their valid time range property can be mapped to the valid time property of the HXIT

<gsd:templatename="HXIT">

   <gsd:paramname="T" type="ANY" />
   <xsd:complexType>
       <xsd:complexContent>
           <xsd:extension>
               <gsd:attributename="base" type="T" />
               <xsd:sequence>
                   <xsd:elementname="validTime" ... />
                   <xsd:elementname="controlActIdReference" type="II" minOccurs="0" maxOccurs="1"/>
               </xsd:sequence>
           </xsd:extension>
       </xsd:complexContent>
   </xsd:complexType>

</gsd:template>

Disposition

Status

Proposed

Links

Back to Data Types R2 issues