Each type of rule controls the parsing and generation of message attributes in a specific way and in a specific context. Some rule types have extra settings or child rules, while others simply map one piece of data to a message attribute.
The following table describes each rule type and its settings, as well as the processing and encoding types of the message attributes which the rule type can be applied to.
Rule Type |
Description and Settings |
Applicable Processing and Encoding Types |
---|---|---|
<Complex> |
Maps an attribute to a multifaceted piece of data using child rules. Each child rule maps part of the data to specific component parts of the attribute. Settings:
Note:
This setting is not available for all message attributes. This rule type applies child rules to component attributes. See Component Attributes and Child Rules for more information. |
Processing Types:
Encoding Types:
|
<System> |
Stores message data from an attribute. This rule type can only be system generated. There are no additional settings for this rule type. Note:
Because it is only applicable for System processing, you cannot create new <System> rules or modify existing ones. |
Processing Types:
|
Association Type |
Populates an attribute with a value used to specify a HasMember or Document Relationship association type. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Availability Status |
Populates an attribute with the lifecycle status of the object. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Code |
Maps a component attribute to the coded value applied to the document. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Coding Scheme |
Maps a component attribute to the coding scheme to which the document's coded value belongs. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Date Stored |
Populates an attribute with the date the document was created by its author. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Display Name |
Maps a component attribute to the name the document's coded value is translated as. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Document Date |
Maps an attribute to the OnBase Document Date property. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Document Type |
Maps an attribute to a coded value set and maps specific coded values to community Document Types. Each incoming document is assigned to the Document Type mapped to its coded value, and the outgoing metadata of a document includes a coded value corresponding to its Document Type. Settings:
To map a community Document Type to a coded value:
You can use the Edit and Delete buttons to change existing Document Type mappings. This rule type applies child rules to component attributes. See Component Attributes and Child Rules for more information. |
Processing Types:
Encoding Types:
Note:
This rule can only be applied when the required child attributes are present. |
Hash |
Populates an attribute with the hash value of the document's byte data. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Home Community ID |
Populates an attribute with the identifier for the community which the sending system belongs to. This ID is set in the Home Community ID field of the Community Settings dialog box. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Keyword Type |
Maps an attribute to the selected Keyword Type. The value of the message attribute is saved as a Keyword Value of this type for incoming documents, and outgoing documents use their existing Keyword Values to populate this attribute. Settings:
Note:
Ensure that the Keyword Type you select is assigned to all community Document Types. |
Processing Types:
Encoding Types:
|
Mapped Keyword Value |
Maps Keyword Values to specific coded values, so that a single Keyword Value on an outgoing document can be used to populate component attributes with a code, scheme, and display name. Settings:
To map Keyword Values to coded values:
|
Processing Types:
Encoding Types:
|
MIME Type |
Maps an attribute to the document's media type, which identifies the file format and extension to use for reading and saving the document. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Object Type |
Populates an attribute with a value that identifies the type of metadata the object contains. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
OID |
Populates an attribute with the identifier for the object it belongs to. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Parent UUID |
Populates an attribute with the universal unique identifier for a parent object. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Repository Unique ID |
Populates an attribute with the OnBase Repository Unique ID, identifying the system from which the document can be accessed. This ID is displayed in the OnBase Repository Unique ID field of the Community Settings dialog box. This rule type can only be system generated. |
Processing Types:
Encoding Types:
|
Size |
Populates an attribute with the size (in bytes) of the byte stream that composes the document. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Source ID |
Populates an attribute with the OnBase Source ID, identifying the system that created the document. This ID is displayed in the OnBase Source ID field of the Community Settings dialog box. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Source UUID |
Populates an attribute with the universal unique identifier of the system sending the message. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Static Value |
Populates an attribute with a preconfigured value. Note:
The settings for this rule type change depending on whether the attribute it is applied to has an Classification encoding type. Settings:
Settings(Classification):
|
Processing Types:
Encoding Types:
Note:
This rule can only be applied when the required child attributes are present. |
Submission Set UUID |
Populates an attribute with the universal unique identifier of a submission set. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Submission Time |
Populates an attribute with the time the message was generated. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Target UUID |
Populates an attribute with the universal unique identifier of the system intended to receive the message. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|
Template |
Maps an IHE field template to an attribute, allowing HL7 message data found in the attribute to be processed as configured in the template. Settings:
Note:
System templates are not available to be mapped to attributes. |
Processing Types:
Encoding Types:
Note:
Templates with more than one field group can are only applicable for attributes with a Slot encoding type. |
UUID |
Populates an attribute with a universal unique identifier for a metadata or association object. This rule type can only be system generated. There are no additional settings for this rule type. |
Processing Types:
Encoding Types:
|