org.hl7.rim
public interface InfrastructureRoot extends RimObject
This abstract class is a super-type for all RIM classes, either directly or through inheritance. It provides a set of communication infrastructure attributes that may be used in instances of HL7-specified, RIM-based communications. When valued in a communication instance, these attributes indicate whether the information structure is being constrained by specifically defined templates, realms or common communication element types.
In general, constraint declarations, such as those communicated in this class's attributes, may occur wherever a RIM class or one of its derived clones is instantiated in an HL7 communication. Thus the attributes must be available in all RIM classes and clones.
| Method Summary | |
|---|---|
| CS | getNullFlavor()
Gets attribute nullFlavor of type CS and cardinality 0..1.
|
| SET<CS> | getRealmCode()
Gets attribute realmCode of type SET |
| SET<OID> | getTemplateId()
Gets attribute templateId of type SET |
| SET<OID> | getTypeId()
Gets attribute typeId of type SET |
| void | setNullFlavor(CS value)
Sets attribute nullFlavor of type CS and cardinality 0..1.
|
| void | setRealmCode(SET<CS> value)
Sets attribute realmCode of type SET |
| void | setTemplateId(SET<OID> value)
Sets attribute templateId of type SET |
| void | setTypeId(SET<OID> value)
Sets attribute typeId of type SET |
When valued in an instance, this attribute signals that the class instance is null, and that the remainder of the information for this class and its properties will not be communicated. The value of this attribute specifies the flavor of null that is intended.
Returns: the attribute value
When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question.
Returns: the attribute value
When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question.
Returns: the attribute value
When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Returns: the attribute value
When valued in an instance, this attribute signals that the class instance is null, and that the remainder of the information for this class and its properties will not be communicated. The value of this attribute specifies the flavor of null that is intended.
Parameters: value the new attribute value
When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question.
Parameters: value the new attribute value
When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question.
Parameters: value the new attribute value
When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Parameters: value the new attribute value