HL7 Connector Record object
HL7 Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The HL7 Connector Record object contains HL7-specific document information and user-defined tracked field information along with other fields.
Structure
<HL7ConnectorRecord>
<account/>
<executionId/>
<atomId/>
<dateProcessed/>
<id/>
<actionType/>
<connectorType/>
<connectorName/>
<operationName/>
<documentIndex/>
<successful/>
<size/>
<errorMessage/>
<customFields>
<field1>value</field1>
.
.
.
<fieldN>value</fieldN>
</customFields>
<acceptAckStatus/>
<acceptAckReport/>
<ackStatus/>
<ackReport/>
<senderApplicationId/>
<senderFacilityId/>
<receiverApplicationId/>
<receiverFacilityId/>
<messageControlId/>
<messageType/>
<version/>
<isValidMessage/>
<outboundValidationStatus/>
<outboundValidationReport/>
</HL7ConnectorRecord>
| Field | Type | Description |
|---|---|---|
| Filter | Filter | Filter |
| account | string | The ID of the account in which you ran this record. |
| executionId | string | The ID of the run. |
| atomId | string | The processing ID of the Atom for this record. |
| dateProcessed | string | The processing date and time of this record. The format is yyyy-MM-dd'T'HH:mm:ss'Z', for example 2019-09-14T15:32:00Z. |
| id | string | The ID of this record. |
| actionType | string | The type of action with which this record corresponds — Send for an outbound interchange or Listen for an inbound interchange. |
| connectorType | string | hl7 is the connector type for any record. |
| connectorName | string | The value is Trading Partner for an HL7 trading partner Send operation, or Start for an HL7 trading partner Listen operation. |
| operationName | string | The name of the operation component processing the record. |
| documentIndex | int | The numerical index of this record in the run. |
| successful | boolean | Whether the record is a success or error. |
| size | long | The size, in bytes, of the document that corresponds to this record. |
| errorMessage | string | Any error message associated with this record. This field is omitted for a successful interchange. |
| customFields | string | Custom fields based on the fields configured on the Document Tracking tab of the Setup page. The names of the fields are dependent upon your account setup. |
| acceptAckStatus | string | The Accept Acknowledgment status — either Commit Accept, Commit Error, or Commit Reject. |
| acceptAckReport | string | The Accept Acknowledgment Report. |
| ackStatus | string | The acknowledgment status — either Application Accept, Application Error, or Application Reject. |
| ackReport | string | The acknowledgment report. |
| senderApplicationId | string | The ID of the sending application among all other applications within the network enterprise. |
| senderFacilityId | string | Additional detail regarding the sending application. |
| receiverApplicationId | string | The ID of the receiving application among all other applications within the network enterprise. |
| receiverFacilityId | string | Additional detail regarding the receiving application. |
| messageControlId | string | The unique identifier for the message. |
| messageType | string | The code identifying the type of message. |
| version | string | The applicable HL7 version. |
| isValidMessage | string | If the message satisfies the requirements of the referenced profile’s segment and element configuration, including mandatory fields, data types, and minimum and maximum lengths, the value is true. Otherwise, the value is false. |
| outboundValidationStatus | string | The outbound validation status — is either Success, Error-Interchange, Error-Message, or N/A. For an outbound interchange for which you do not select the outbound validation option in the sending trading partner, the value is N/A. This field is omitted for an inbound interchange. |
| outboundValidationReport | string | The outbound validation report. This report contains descriptions of errors present in the outbound interchange. If the outbound validation option is not selected in the sending trading partner, the value is N/A. The API omits this field or an inbound interchange. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Not Supported | Supported | Not Supported | Not Supported | Not Supported | Not Supported |
You can use the following fields as QUERY filters for the HL7 Connector Record object:
| Field | Allowed values |
|---|---|
| executionId | Any string value |
| atomId | Any string value |
| dateProcessed | Date with the format yyyy-MM-dd'T'HH:mm:ss'Z', such as 2019-09-14T15:32:00Z |
| id | Any string value |
| actionType | Send, Listen |
| connectorType | hl7 |
| connectorName | Trading Partner to filter by HL7 trading partner Send operations, Start to filter by HL7 trading partner Listen operations |
| operationName | Any string value |
| documentIndex | Any numeric value |
| successful | true, false |
| size | Any numeric value |
| errorMessage | Any string value |
| acceptAckStatus | Commit Accept, Commit Error, Commit Reject |
| acceptAckReport | Any string value |
| ackStatus | Application Accept, Application Error, Application Reject |
| ackReport | Any string value |
| senderApplicationId | Any string value |
| senderFacilityId | Any string value |
| receiverApplicationId | Any string value |
| receiverFacilityId | Any string value |
| messageControlId | Any string value |
| messageType | Any string value |
| version | Any string value |
| isValidMessage | true, false |
| outboundValidationStatus | Success, Error-Interchange, Error-Message, N/A |
| outboundValidationReport | Any string value |
To filter by a customField, use the format customFields.fieldName as the filter property where fieldName is the element name of the custom field in the HL7 Connector Record structure. To get a list of the available custom fields see the Custom Tracked Field object documentation.
The operators allowed for the HL7 Connector Record object filters are:
-
BETWEEN
-
EQUALS
-
GREATER_THAN
-
GREATER_THAN_OR_EQUAL
-
LESS_THAN
-
LESS_THAN_OR_EQUAL
-
STARTS_WITH
However, it is important to note that the STARTS_WITH operator accepts values that do not include spaces.
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.
SOAP implementation
The following example query returns all HL7 Connector records with an executionId of execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:query>
<api:objectType>HL7ConnectorRecord</api:objectType>
<api:queryConfig>
<api:QueryFilter>
<api:expression operator="EQUALS" property="executionId"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
<api:argument>execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14</api:argument>
</api:expression>
</api:QueryFilter>
</api:queryConfig>
</api:query>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<bns:queryResponse xmlns="http://api.platform.boomi.com/">
<bns:results numberOfResults="100">
<bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
<bns:result xsi:type="bns:HL7ConnectorRecord">
<bns:account>account-123456</bns:account>
<bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14</bns:executionId>
<bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
<bns:dateProcessed>2019-09-14T06:24:12Z</bns:dateProcessed>
<bns:id>connector-abcdef01-2345-6789-abcd-ef0123456789</bns:id>
<bns:actionType>Listen</bns:actionType>
<bns:connectorType>hl7</bns:connectorType>
<bns:connectorName>Start</bns:connectorName>
<bns:operationName>Sample HL7 Listen Operation</bns:operationName>
<bns:documentIndex>0</bns:operationName>
<bns:successful>true</bns:successful>
<bns:size>3138</bns:size>
<bns:customFields>
<bns:customNumber>13</bns:customNumber>
<bns:customDate>2019-09-14T10:53:59-0400</bns:customDate>
<bns:customCharacter>sample</bns:customCharacter>
</bns:customFields>
<bns:acceptAckStatus>Commit Error</bns:acceptAckStatus>
<bns:acceptAckReport>Acknowledgment Report for Interchange Control Number 000139776
Date: 190914
Time: 1031
Acknowledgment Status: Accepted with Errors
Note: Invalid Interchange Receiver ID</bns:acceptAckReport>
<bns:ackStatus>Application Error</bns:ackStatus>
<bns:ackReport>Group Control #: 139776
 Acknowledgement Status: A</bns:ackReport>
<bns:senderApplicationId>mcapp33382</bns:senderApplicationId>
<bns:senderFacilityId>mcf33382</bns:senderFacilityId>
<bns:receiverApplicationId>tpapp33382</bns:receiverApplicationId>
<bns:receiverFacilityId>tpf33382</bns:receiverFacilityId>
<bns:messageControlId>1018015</bns:messageControlId>
<bns:messageType>ADT_A01</bns:messageType>
<bns:version>v27</bns:version>
<bns:isValidMessage>false</bns:isValidMessage> </bns:result>
...
<bns:result xsi:type="bns:HL7ConnectorRecord">
<bns:account>account-123456</bns:account>
<bns:executionId>execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14</bns:executionId>
<bns:atomId>3456789a-bcde-f012-3456-789abcdef012</bns:atomId>
<bns:dateProcessed>2019-09-14T06:25:02Z</bns:dateProcessed>
<bns:id>connector-bcdef012-3456-789a-bcde-f0123456789a</bns:id>
<bns:actionType>Listen</bns:actionType>
<bns:connectorType>hl7</bns:connectorType>
<bns:connectorName>Start</bns:connectorName>
<bns:operationName>Sample HL7 Listen Operation</bns:operationName>
<bns:documentIndex>49</bns:documentIndex>
<bns:successful>true</bns:successful>
<bns:size>2781</bns:size>
<bns:customFields>
<bns:customNumber>55</bns:customNumber>
<bns:customDate>2019-09-14T10:57:14-0400</bns:customDate>
<bns:customCharacter>sample</bns:customCharacter>
</bns:customFields>
<bns:acceptAckStatus>Commit Accept</bns:acceptAckStatus>
<bns:acceptAckReport>Success</bns:acceptAckReport>
<bns:ackStatus>Application Accept</bns:ackStatus>
<bns:ackReport>Group Control #: 139776
 Acknowledgement Status: A</bns:ackReport>
<bns:senderApplicationId>mcapp33382</bns:senderApplicationId>
<bns:senderFacilityId>mcf33382</bns:senderFacilityId>
<bns:receiverApplicationId>tpapp33382</bns:receiverApplicationId>
<bns:receiverFacilityId>tpf33382</bns:receiverFacilityId>
<bns:messageControlId>1018016</bns:messageControlId>
<bns:messageType>ADT_A01</bns:messageType>
<bns:version>v27</bns:version>
<bns:isValidMessage>true</bns:isValidMessage> </bns:result>
</bns:results>
</bns:queryResponse>
</S:Body>
</S:Envelope>
The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.
Was this topic helpful?
