BO attribute property IsRequired
The following details the attribute property IsRequired
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
Set IsRequired to false if the HL7 message structure
definition encloses the segment or segment group with square bracket
[], otherwise set the property to true.
- Example:
The corresponding message BO for the ADT_A61 HL7 message
structure for message type ADT and event type A61 has following
attributes:
Table 43. This example shows the attribute cardinality for each attribute of HL7_MTADT_A61 and their HL7 counter parts
Attribute sequence |
Attribute type |
HL7 counter part |
IsRequired |
1 |
HL7_SGMSH |
MSH |
True |
2 |
HL7_SGEVN |
EVN |
True |
3 |
HL7_SGPID |
PID |
True |
4 |
HL7_SGPD1 |
[PD1] |
False |
5 |
HL7_SGV1 |
PV1 |
True |
6 |
HL7_SGROL |
[ { ROL } ] |
False |
7 |
HL7_SGPV2 |
[ PV2 ] |
False |
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
Segment group or segment BO that has [] brace: set IsRequired
to false, otherwise set to true
- 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
If the OPT column of segment field or query parameter
is not set to O, then set IsRequired property of corresponding attribute
to false, otherwise set to true.
- Grammar
N/A
- Example:
For BO HL7_SGQBD_Q21, the IsRequired attribute for the HL7 message standard specification
for parameter definition for query Q21:
Table 44. This example shows the IsRequired attribute for HL7_SGQBD_Q21 and their HL7 counter parts
Attribute sequence |
Sequence BO attribute name |
OPT |
IsRequired |
1 |
MessageQueryName |
R |
True |
2 |
QueryTag |
R |
True |
3 |
PersonIdentifier |
R |
True |
4 |
WhatDomainReturned |
O |
False |
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 29of this document for CM type
- Naming convention
N/A
- Marking convention
Set IsRequired to false
- Grammar
N/A
- Example:
N/A
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
- Naming convention
N/A
- Marking convention
Set IsRequired to false
- Grammar
N/A
- Example:
N/A
