TRANXACT.AI Help

EHR · Interoperability

HL7 Interfaces

Trading partners speaking HL7 v2: ADT, results (ORU), orders (ORM/OML) and pharmacy (RDE), over HTTP, a watched folder, or MLLP (off until switched on).

Type REST7 operationsBase path /api/ehr/hl7-interfacesPublished as /api/v1/hl7-interfaces

Download specification (OpenAPI 3.1) Screen: HL7 Interfaces

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold EHR › HL7 Interfaces on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableehr.hl7_interfaces · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/hl7-interfacesList hl7 interfaces

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "direction": "inbound",
      "transport": "http",
      "mllp_host": "text",
      "mllp_port": 10,
      "file_dir": "text",
      "enabled": true,
      "sending_app": "text",
      "sending_facility": "text",
      "receiving_app": "text",
      "receiving_facility": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ehr/hl7-interfaces?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/hl7-interfaces/{id}Read one hl7 interfaces

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "direction": "inbound",
  "transport": "http",
  "mllp_host": "text",
  "mllp_port": 10,
  "file_dir": "text",
  "enabled": true,
  "sending_app": "text",
  "sending_facility": "text",
  "receiving_app": "text",
  "receiving_facility": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ehr/hl7-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/hl7-interfacesCreate a hl7 interfaces

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
directiontextNoDirection
Allowed: inbound outbound both
transporttextNoTransport
Allowed: http file mllp
mllp_hosttextNoMLLP host — Where outbound messages go.
mllp_portintegerNoMLLP port — Listened on inbound when the server runs with HL7_MLLP=on.
file_dirtextNoFolder — inbound/, outbound/, processed/ and error/ are kept under it.
enabledbooleanNoEnabled
sending_apptextNoOur application (MSH-3)
sending_facilitytextNoOur facility (MSH-4)
receiving_apptextNoTheir application (MSH-5)
receiving_facilitytextNoTheir facility (MSH-6)
hl7_versiontextNoVersion
message_types_textNoMessage types
create_patientsbooleanNoRegister patients an ADT names
is_defaultbooleanNoDefault interface

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "direction": "inbound",
  "transport": "http",
  "mllp_host": "text",
  "mllp_port": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "direction": "inbound",
  "transport": "http",
  "mllp_host": "text",
  "mllp_port": 10,
  "file_dir": "text",
  "enabled": true,
  "sending_app": "text",
  "sending_facility": "text",
  "receiving_app": "text",
  "receiving_facility": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/hl7-interfaces" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","direction":"inbound","transport":"http","mllp_host":"text","mllp_port":10}'
PUT/api/ehr/hl7-interfaces/{id}Change a hl7 interfaces

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
directiontextNoDirection
Allowed: inbound outbound both
transporttextNoTransport
Allowed: http file mllp
mllp_hosttextNoMLLP host — Where outbound messages go.
mllp_portintegerNoMLLP port — Listened on inbound when the server runs with HL7_MLLP=on.
file_dirtextNoFolder — inbound/, outbound/, processed/ and error/ are kept under it.
enabledbooleanNoEnabled
sending_apptextNoOur application (MSH-3)
sending_facilitytextNoOur facility (MSH-4)
receiving_apptextNoTheir application (MSH-5)
receiving_facilitytextNoTheir facility (MSH-6)
hl7_versiontextNoVersion
message_types_textNoMessage types
create_patientsbooleanNoRegister patients an ADT names
is_defaultbooleanNoDefault interface

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "direction": "inbound",
  "transport": "http",
  "mllp_host": "text",
  "mllp_port": 10,
  "file_dir": "text",
  "enabled": true,
  "sending_app": "text",
  "sending_facility": "text",
  "receiving_app": "text",
  "receiving_facility": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/hl7-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/ehr/hl7-interfaces/{id}Delete a hl7 interfaces

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/ehr/hl7-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/hl7-interfaces/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/hl7-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/ehr/hl7-interfaces/{id}/pollPoll

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/hl7-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/poll" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a hl7 interfaces, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
directiontextread, writeDirection
Allowed: inbound outbound both
transporttextread, writeTransport
Allowed: http file mllp
mllp_hosttextread, writeMLLP host — Where outbound messages go.
mllp_portintegerread, writeMLLP port — Listened on inbound when the server runs with HL7_MLLP=on.
file_dirtextread, writeFolder — inbound/, outbound/, processed/ and error/ are kept under it.
enabledbooleanread, writeEnabled
sending_apptextread, writeOur application (MSH-3)
sending_facilitytextread, writeOur facility (MSH-4)
receiving_apptextread, writeTheir application (MSH-5)
receiving_facilitytextread, writeTheir facility (MSH-6)
hl7_versiontextread, writeVersion
message_types_textread, writeMessage types
create_patientsbooleanread, writeRegister patients an ADT names
is_defaultbooleanread, writeDefault interface
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › HL7 Interfaces for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.