BO attribute property AppSpecificInfo
The following details the attribute property Relationship
for common business objects.
Message BO
- Corresponding to the HL7 data element
Attributes in segment groups or segments that make up
the HL7 message structure definition or query structure definition.
- Naming convention
N/A
- Marking convention
N/A
- Example:
N/A
Group BO
- Corresponding to the HL7 data element
Segments or segment subgroup of a given segment group
with two or more segments
- Naming convention
N/A
- Marking convention
N/A
- Example:
N/A
Segment BO
- Corresponding to the HL7 data element
- The fields of regular HL7 segment
- The parameter names of QPD, RDT segments of a conformance statement
- Naming convention
N/A
- Marking Convention
N/A
- Grammar
- All data types other than CM: StructType=DataType;DataTypeID=<HL7 data type ID>
- DT BO listed in Table 29 StructType=DataType;DataTypeID=CM
- Example:
- For attribute that corresponds to the ST data type, the AppSpecificInfo
is StructType=DataType;DataTypeID=ST; MaxLength=199
- For attribute whose type is HL7_DTMSG as defined in Table 29, the AppSpecificInfo is StructType=DataType;DataTypeID=CM
BO of complex data type
Key attributes in BO of Complex Data Type do not bear
any significance.
- Corresponding to the HL7 data element
- HL7 components in the definition data type except CM and Varies
- Components of data structures listed in Table 29 of this document for CM type
- Marking convention
If the attribute type is BO, set Relationship to Containment,
otherwise take out the attribute property when working with BO definition
file
- Grammar
- All data types other than CM, MA, NA, QIP and Varies StructType=DataType;DataTypeID=<HL7 data type ID>
- DT BO listed in Table 29, StructType=DataType;DataTypeID=CM
- MA, NA and QIP type BO
- Union BO for varies data type StructType=Union;TypeContext=<reference path at where the data type is specified in the BO structure>
TypeContext is used to indicate where in the BO structure to
retrieve the data type announcer information such as the CM or NM
for the data carrier.
The path can be relative or can also be absolute path where the
root is the top-most parent BO.
Since the RDT segment definition expects user to provide definition
for each of the columns and hence does not consist of column of
varies data type, the need to supporting absolute path is not warranted. This
release only supports the relative path.
In this release, the relative pathname is defined as BO attribute
name of the one of data type announcer
- Example:
Table 45. This example shows the attribute AppSpecificInfo for each attribute of HL7_DTCQ and their HL7 counter parts
Attribute sequence |
Attribute name |
Attribute type |
ASI |
1 |
Quantity |
Float |
DataTypeID=NM |
2 |
Units |
HL7_DTCE |
DataTypeID=CM |
The ObservationValue attribute of BO HL7_SGOBX, which corresponds to the OBX-5 (varies) and is depended on
the data type announcer located at OBX-2, has AppSpecificInfo StructType=Union;TypeContext=ValueType
Here the path to the data type announcer is "ValueType", which
is just the attribute name. Because both the "ValueType" and "ObservationValue"
attributes are located in the same BO, this path is a relative path.
Data type Union BO
The property type attributes of the Union BO data type
are summarized as follows:
- Corresponding to the HL7 data element
- HL7 data type except CM and Varies
- Components of data structures listed in Table 29 of this document for CM type
- Primitive data types
- Grammar
- All Data type other than CM StructType=DataType;DataTypeID=<HL7 data type ID>
- CM type BO listed in Table 29 StructType=DataType;DataTypeID=CM
- MA, NA type BO listed in Table 29 StructType=Array;DataTypeID=<MA or NA, whichever appropriate data type ID>
- Example:
For attribute that corresponds to the ST data type, the AppSpecificInfo
is StructType=DataType;DataTypeID=STFor an attribute whose type is HL7_DTMSG as defined in Table 29, the AppSpecificInfo is StructType=DataType;DataTypeID=CM
