BUSINESS_SERVICE



Column Section Relationship Section Top of Page


Table-level Detail

Description: Business Service
Definition: Contains internal and external business services for messaging.
Table Type: REFERENCE





Column Detail - BUSINESS_SERVICE


Column Name Type Null? Definition
ACTIVE_IND DOUBLE N The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc.
ACTIVE_STATUS_CD DOUBLE N Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc.
ACTIVE_STATUS_DT_TM DATETIME N The date and time that the active_status_cd was set.
ACTIVE_STATUS_PRSNL_ID DOUBLE N The person who caused the active_status_cd to be set or change.
BEG_EFFECTIVE_DT_TM DATETIME N The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time.
BUSINESS_SERVICE_ID DOUBLE N Unique Identifier for Business Service row
END_EFFECTIVE_DT_TM DATETIME N The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive.
ORGANIZATION_ID DOUBLE N This is the value of the unique primary identifier of the organization table row. It identifies the organization of the service.
PARTY_IDENT VARCHAR(250) N This identifies a business service within an organization which could be in the form of OCS-Instance. e.g., D81001-811
SERVICE_IDENT VARCHAR(250) Y This is the alpha-numeric identifier of the Service
SERVICE_NAME VARCHAR(250) N This is the URI identifying a collection of actions within a party. e.g., urn:nhs:names:services:ebs
UPDT_APPLCTX DOUBLE N The application context number from the record info block.
UPDT_CNT DOUBLE N Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row.
UPDT_DT_TM DATETIME N The date and time the row was last inserted or updated.
UPDT_ID DOUBLE N The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table.
UPDT_TASK DOUBLE N The registered (assigned) task number for the process that inserted or updated the row.



Relationship Detail - BUSINESS_SERVICE


Child Column in BUSINESS_SERVICE(FK) Parent Table Name Parent Column Name
Parents: ORGANIZATION_ID ORGANIZATION ORGANIZATION_ID


CONTRACT_PROPERTY



Column Section Relationship Section Top of Page


Table-level Detail

Description: Contract Property
Definition: Contains the contract properties for a given message
Table Type: REFERENCE





Column Detail - CONTRACT_PROPERTY


Column Name Type Null? Definition
ACK_ACTOR1_NAME VARCHAR(250) N This identifies the first participant in the acknowledgement process, if applicable.
ACK_ACTOR2_NAME VARCHAR(250) N This identifies the second participant in the acknowledgement process, if applicable.
ACK_REQUESTED_FLAG DOUBLE N This indicates whether a system will return an acknowledgement. Possible values include 1=ALWAYS, 2=PER-MESSAGE, and 0=NEVER
ACTION_NAME VARCHAR(250) N This identifies a process within a service that processes the message. e.g., PRSC_IN040000UK
ACTION_VERSION_TXT VARCHAR(250) N Action version - Alpha-Numeric.
ACTIVE_IND DOUBLE N The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc.
ACTIVE_STATUS_CD DOUBLE N Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc.
ACTIVE_STATUS_DT_TM DATETIME N The date and time that the active_status_cd was set.
ACTIVE_STATUS_PRSNL_ID DOUBLE N The person who caused the active_status_cd to be set or change.
AUTHENTICATION_FLAG DOUBLE N Is Authenticated Flag. This determines whether the receiver must identify the sender. Possible values include 0=NONE, 1=TRANSIENT, and 2=PERSISTENT
BEG_EFFECTIVE_DT_TM DATETIME N The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time.
CONTRACT_PROPERTY_ID DOUBLE N Primary Key. Unique row identifier. The value for this column will not come from a sequence. The value for the ID will be re-generated nightly as the table contents are reloaded (replaced)
CPA_IDENT VARCHAR(250) N Contract / Property / Action Identifier for parameters governing the exchange of messages between parties.
DUPLICATE_ELIMINATION_FLAG DOUBLE N This field indicates whether the receiver will check for duplicate messages. Possible Values: 0 = NEVER, 1 = ALWAYS, 2 - PER MESSAGE
DUPLICATE_ELIMINATION_IND DOUBLE N Obsolete. Not Used. Column DUPLICATE_ELIMINATION_FLAG will replace this field.
END_EFFECTIVE_DT_TM DATETIME N The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive.
FROM_PARTYID_TXT VARCHAR(250) Y This column contains the information for the FROM PARTYID element of the EBXML wrapper.
ORGANIZATION_ID DOUBLE N This is the value of the unique primary identifier of the organization. It identifies the service.
PARTY_KEY_TXT VARCHAR(250) N Identifies a business service within an organization, which could be in the form of OCS-Instance, e.g., D81001-811.
PAYLOAD_ENCODING_TXT VARCHAR(250) Y This column contains the information for the PAYLOAD ENCODING element of the EBXML wrapper.
PAYLOAD_STYLE_TXT VARCHAR(250) Y This column contains the information for the PAYLOAD STYLE element of the EBXML wrapper.
PAYLOAD_VER_TXT VARCHAR(250) Y This column contains the information for the PAYLOAD VERSION element of the EBXML wrapper.
PERSIST_DURATION_NBR DOUBLE N This is the minimum length of time that data from a reliably sent message is kept in persistent storage by a receiving system. (seconds)
RETRIES_NBR DOUBLE N This is the maximum number of times a sending system should attempt to redeliver an unacknowledged message.
RETRY_INTERVAL_NBR DOUBLE N This is the time a sending system will wait before retrying (seconds)
SCHEMA_LOCATION_TXT VARCHAR(250) N Schema LocationColumn
SEND_URL VARCHAR(250) N This identifies the address of the receiving system
SERVICE_NAME VARCHAR(250) N Service NameColumn
SLA_IND DOUBLE N Service Level Agreement. This indicates whether the message requires SLA.
SYNC_REPLY_MODE_FLAG DOUBLE N This indicates that the sender expects a synchronous response. Possible values include: 1 = MSHSIGNALSONLY; 2=SIGNALSONLY; 3=RESPONSEONLY; 4=SIGNALSANDRESPONSE; and 0=none.
TIMEOUT_NBR DOUBLE N Determine the amount of time our system will await a response over a communication line.
TO_PARTYID_TXT VARCHAR(250) Y This column contains the information for the TO PARTYID element of the EBXML wrapper.
UPDT_APPLCTX DOUBLE N The application context number from the record info block.
UPDT_CNT DOUBLE N Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row.
UPDT_DT_TM DATETIME N The date and time the row was last inserted or updated.
UPDT_ID DOUBLE N The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table.
UPDT_TASK DOUBLE N The registered (assigned) task number for the process that inserted or updated the row.
XLINK_HREF_TXT VARCHAR(250) Y This column contains the information for the XLINK HREF element of the EBXML wrapper.



Relationship Detail - CONTRACT_PROPERTY


Child Column in CONTRACT_PROPERTY(FK) Parent Table Name Parent Column Name
Parents: ORGANIZATION_ID ORGANIZATION ORGANIZATION_ID


CQM_OENINTERFACE_QUE



Column Section Relationship Section Top of Page


Table-level Detail

Description: cqm oeninterface que
Definition: This CQM queue table is the primary storage locations of the transaction message for the Open Engine application. This table contains the administrative and routing data used for controlling the transaction.
Table Type: ACTIVITY





Column Detail - CQM_OENINTERFACE_QUE


Column Name Type Null? Definition
ACTIVE_IND DOUBLE N The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc.
CLASS VARCHAR(15) Y Future: Identifies the trigger explosion class of the transaction.
CONTRIBUTOR_EVENT_DT_TM DATETIME Y Significant date and time associated with the transaction row as supplied by the contributor application.
CONTRIBUTOR_ID DOUBLE N This is the value of the unique primary identifier of the CQM contributor configuration table. It is an internal system assigned number.
CONTRIBUTOR_REFNUM VARCHAR(48) N A reference or key assigned to the transaction row by the contributor application. It recommended that this identifier be unique although it is not required.
CREATE_DT_TM DATETIME N The date and time the row was inserted.
CREATE_RETURN_FLAG DOUBLE Y The current trigger explosion state for this transaction row.
CREATE_RETURN_TEXT VARCHAR(132) Y Return text string from the trigger explosion process of this transaction row.
DEBUG_IND DOUBLE Y Defines whether debugging is active or inactive for the queue transaction unidentified in this row.
MESSAGE LONGBLOB Y This is the binary longraw field which contains the contents of the original message.
MESSAGE_LEN DOUBLE N The length of the textual or binary object placed in the message field.
PARAM_LIST_IND DOUBLE Y Identifies whether there are row in the queue parameters table associated with this transaction row.
PRIORITY DOUBLE N Identifies the priority of this transaction row that may or may not be used to process in a prioritized method. The value range for priority is 1 through 99, highest to lowest, respectively.
PROCESS_STATUS_FLAG DOUBLE N The current trigger explosion state for this transaction row.
QUEUE_ID DOUBLE N This is the value of the unique primary identifier of the CQM queue table. It is an internal system assigned number.
SUBTYPE VARCHAR(15) Y Future: Identifies the trigger explosion subtype of the transaction.
SUBTYPE_DETAIL VARCHAR(15) Y Future: Identifies the trigger explosion subtype detail of the transaction.
TRANSACTION_TIME_IN_SECONDS DOUBLE Y Stores the elapsed time for an inbound transaction in seconds
TRIG_CREATE_END_DT_TM DATETIME Y The date and time the trigger explosion completed on this transaction row.
TRIG_CREATE_START_DT_TM DATETIME Y The date and time the trigger explosion began on this transaction row.
TRIG_MODULE_IDENTIFIER VARCHAR(16) Y Future. Identifies the process/module which performs the trigger explosion on this transaction row.
TYPE VARCHAR(15) Y Future. Identifies the trigger explosion type of the transaction.
UPDT_APPLCTX DOUBLE N The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_CNT DOUBLE N Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_DT_TM DATETIME N The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_ID DOUBLE N The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_TASK DOUBLE N The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
VERBOSITY_FLAG DOUBLE Y Defines the verbosity level during debugging for the processing of the transaction.



Relationship Detail - CQM_OENINTERFACE_QUE




Parent Column in CQM_OENINTERFACE_QUE (PK) Child Table Name Child Column Name
Children: QUEUE_ID ESI_LOG QUEUE_ID
SI_DOCUMENT_TRANSACTION_LOG OEN_QUEUE_ID
SI_HAAD_TRANSACTION RETRIEVE_QUEUE_ID
SI_HAAD_TRANSACTION UPLOAD_QUEUE_ID
SI_OEN_SKIPPED_MSGS QUEUE_ID
SI_REPO_REG_RELTN QUEUE_ID
SI_UNMTCHD_PRSN_QUE_RELTN QUEUE_ID
SI_XDOC_METADATA DOC_RETR_QUEUE_ID
SI_XDOC_QUERY_PERSON_RELTN QUEUE_ID


CQM_OENINTERFACE_TR_1



Column Section Relationship Section Top of Page


Table-level Detail

Description: Open Engine Listener Trigger #1
Definition: The CQM listener trigger table contains the administrative data for the processing of a trigger exploded CQM transaction by a listener application. This table contains data for the Open Engine application.
Table Type: ACTIVITY





Column Detail - CQM_OENINTERFACE_TR_1


Column Name Type Null? Definition
ACTIVE_IND DOUBLE N The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc.
COMPLETION_SEQUENCE_ID DOUBLE N This is the value that unique identifies the transaction completion order by the listener application. It is an internal system assigned number.
CREATE_DT_TM DATETIME N The date and time the row was inserted.
DEBUG_IND DOUBLE Y Defines whether debugging is active or inactive for the listener trigger explosion event unidentifie in this row.
ERROR_RECOVERY_CNT DOUBLE Y Stores the number of times error recovery is initiated if the transaction in Open Engine leads to the termination of the interface or the connection is closed.
LAST_RETRY_DT_TM DATETIME Y The date and time of the last retry to process this trigger exploded transaction row. This field may or may not be used by the listener application.
LISTENER_ID DOUBLE N This is the value of the unique primary identifier of the CQM listener configuration table. It is an internal system assigned number.
L_R_PROCESS_STATUS_FLAG DOUBLE Y The last retry processing state for this trigger exploded transaction row. This field may or may not be used by the listener application.
L_R_TRIGGER_STATUS_TEXT VARCHAR(132) Y The last retry processing text for this trigger exploded transaction row. This field may or may not be used by the listener application.
MESSAGE_SEQUENCE DOUBLE N This is a numeric value that determines the order in which the messages will be processed. It is based on the date and time that the row was inserted.
NUMBER_OF_RETRIES DOUBLE Y Set to 0 on insert. Optionally incremented by 1 by the listener application to specify the number of times the listener attempted to process the trigger exploded transaction.
PRIORITY DOUBLE Y Identifies the priority of this transaction row that may or may not be used to process in a prioritized method. The value range for priority is 1 throug 99, highest to lowest, respectively.
PROCESS_START_DT_TM DATETIME Y The date and time the listener application started processing on this exploded transaction.
PROCESS_STATUS_FLAG DOUBLE N The current processing state for this trigger exploded transaction row.
PROCESS_STOP_DT_TM DATETIME Y The date and time the listener application completed processing on this exploded transaction.
QUEUE_ID DOUBLE N This is the value of the unique primary identifier of the CQM queue table. It is an internal system assigned number.
RESPONSE_TIME_IN_SECONDS DOUBLE Y Stores the response time taken by a foreign system to respond to an Open Engine transaction in seconds
SCHEDULE_DT_TM DATETIME N The date and time this exploded transaction row is scheduled for processing.
TRANSACTION_TIME_IN_SECONDS DOUBLE Y Stores the elapsed time for an entire transaction in Open Engine in seconds
TRIGGER_ID DOUBLE N This is the value of the unique primary identifier of the CQM listener trigger table. It is an internal system assigned number.
TRIGGER_STATUS_TEXT VARCHAR(132) Y The status text associated with the processing status flag.
UPDT_APPLCTX DOUBLE N The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_CNT DOUBLE N Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_DT_TM DATETIME N The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_ID DOUBLE N The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
UPDT_TASK DOUBLE N The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic.
VERBOSITY_FLAG DOUBLE Y Defines the verbosity level during debugging for the processing of the transaction.



Relationship Detail - CQM_OENINTERFACE_TR_1




Parent Column in CQM_OENINTERFACE_TR_1 (PK) Child Table Name Child Column Name
Children: TRIGGER_ID SI_ALERT_EVENT OENINTERFACE_TRIGGER_ID
SI_OEN_SKIPPED_MSGS TRIGGER_ID


CQM_OENTXLOG_QUE



Column Section Top of Page


Table-level Detail

Description: CQM OENTXLOG QUE
Definition: This table holds the Open Engine transactions we've received and sent.
Table Type: ACTIVITY





Column Detail - CQM_OENTXLOG_QUE


Column Name Type Null? Definition
ACTIVE_IND DOUBLE N The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc.
CLASS VARCHAR(15) Y Holds the Interface ID that wrote to the queue.Column
CONTRIBUTOR_EVENT_DT_TM DATETIME Y Holds date/time when a transaction was written to the queue.Column
CONTRIBUTOR_ID DOUBLE N Contributor ID of the contributor writing to the queue.Column
CONTRIBUTOR_REFNUM VARCHAR(48) N Reference number for contributor.Column
CREATE_DT_TM DATETIME N Date/time this transaction was written.Column
CREATE_RETURN_FLAG DOUBLE Y Return flag.Column
CREATE_RETURN_TEXT VARCHAR(132) Y Return text.Column
DEBUG_IND DOUBLE Y Debug indicator.Column
MESSAGE LONGBLOB Y The transaction receive/sent.Column
MESSAGE_LEN DOUBLE N Length of the transaction.Column
PARAM_LIST_IND DOUBLE Y Param list.Column
PRIORITY DOUBLE N If the transaction is replayed, this is the priority to be used when re-queuing.Column
PROCESS_STATUS_FLAG DOUBLE N Used for replaying.Column
QUEUE_ID DOUBLE N Unique ID for this transaction.Column
SUBTYPE VARCHAR(15) Y Sub type of transaction.Column
SUBTYPE_DETAIL VARCHAR(15) Y Detail sub type of transaction.Column
TRIG_CREATE_END_DT_TM DATETIME Y Trigger end date/time.Column
TRIG_CREATE_START_DT_TM DATETIME Y Trigger start date/time.Column
TRIG_MODULE_IDENTIFIER VARCHAR(16) Y Trigger module identifier.Column
TYPE VARCHAR(15) Y Type of message.Column
UPDT_APPLCTX DOUBLE N The application context number from the record info block.
UPDT_CNT DOUBLE N Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row.
UPDT_DT_TM DATETIME N The date and time the row was last inserted or updated.
UPDT_ID DOUBLE N The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table.
UPDT_TASK DOUBLE N The registered (assigned) task number for the process that inserted or updated the row.
VERBOSITY_FLAG DOUBLE Y Verbosity flag.Column