TRANXACT.AI Help

EHR · Interoperability

Network Connections

Surescripts, clearinghouses and HL7 partners: the transport, the identities in the envelope and the control numbers. Credentials are sealed and never shown again. With no live connection the sandbox answers.

Type REST7 operationsBase path /api/ehr/interop-connectionsPublished as /api/v1/interop-connections

Download specification (OpenAPI 3.1) Screen: Network Connections

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 › Network Connections 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.interop_connections · 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/interop-connectionsList network connections

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",
      "kind": "surescripts",
      "transport": "sandbox",
      "endpoint_url": "https://example.com",
      "host": "text",
      "port": 10,
      "username": "Example",
      "secret_sealed": "text",
      "client_cert_pem": "text",
      "client_key_sealed": "text",
      "ca_cert_pem": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "kind": "surescripts",
  "transport": "sandbox",
  "endpoint_url": "https://example.com",
  "host": "text",
  "port": 10,
  "username": "Example",
  "secret_sealed": "text",
  "client_cert_pem": "text",
  "client_key_sealed": "text",
  "ca_cert_pem": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
kindtextYesKind
Allowed: surescripts clearinghouse hl7
transporttextNoTransport
Allowed: sandbox https sftp mllp file
endpoint_urltextNoEndpoint address
hosttextNoHost
portintegerNoPort
usernametextNoUser name
submitter_idtextNoSubmitter id (ISA06)
submitter_nametextNoSubmitter name
receiver_idtextNoReceiver id (ISA08)
receiver_nametextNoReceiver name
usage_indicatortextNoTest or production
Allowed: T P
account_idtextNoNetwork account id
portal_idtextNoPortal id
is_defaultbooleanNoDefault for its kind
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "kind": "surescripts",
  "transport": "sandbox",
  "endpoint_url": "https://example.com",
  "host": "text",
  "port": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "kind": "surescripts",
  "transport": "sandbox",
  "endpoint_url": "https://example.com",
  "host": "text",
  "port": 10,
  "username": "Example",
  "secret_sealed": "text",
  "client_cert_pem": "text",
  "client_key_sealed": "text",
  "ca_cert_pem": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/interop-connections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","kind":"surescripts","transport":"sandbox","endpoint_url":"https://example.com","host":"text","port":10}'
PUT/api/ehr/interop-connections/{id}Change a interop connections

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
kindtextYesKind
Allowed: surescripts clearinghouse hl7
transporttextNoTransport
Allowed: sandbox https sftp mllp file
endpoint_urltextNoEndpoint address
hosttextNoHost
portintegerNoPort
usernametextNoUser name
submitter_idtextNoSubmitter id (ISA06)
submitter_nametextNoSubmitter name
receiver_idtextNoReceiver id (ISA08)
receiver_nametextNoReceiver name
usage_indicatortextNoTest or production
Allowed: T P
account_idtextNoNetwork account id
portal_idtextNoPortal id
is_defaultbooleanNoDefault for its kind
is_activebooleanNoActive

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",
  "kind": "surescripts",
  "transport": "sandbox",
  "endpoint_url": "https://example.com",
  "host": "text",
  "port": 10,
  "username": "Example",
  "secret_sealed": "text",
  "client_cert_pem": "text",
  "client_key_sealed": "text",
  "ca_cert_pem": "text"
}

Sample request

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

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/interop-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/interop-connections/{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/interop-connections/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/interop-connections/{id}/credentialsCredentials

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):

secret, clientKeyPem, clientCertPem, caCertPem

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/interop-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credentials" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"secret":"value","clientKeyPem":"value","clientCertPem":"value","caCertPem":"value"}'

Data model

Every field of a interop connections, 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
kindtextread, writeKind
Allowed: surescripts clearinghouse hl7
transporttextread, writeTransport
Allowed: sandbox https sftp mllp file
endpoint_urltextread, writeEndpoint address
hosttextread, writeHost
portintegerread, writePort
usernametextread, writeUser name
secret_sealedtextread onlySecret sealed
client_cert_pemtextread onlyClient cert pem
client_key_sealedtextread onlyClient key sealed
ca_cert_pemtextread onlyCa cert pem
submitter_idtextread, writeSubmitter id (ISA06)
submitter_nametextread, writeSubmitter name
receiver_idtextread, writeReceiver id (ISA08)
receiver_nametextread, writeReceiver name
usage_indicatortextread, writeTest or production
Allowed: T P
isa_control_seqbigintread onlyIsa control seq
gs_control_seqbigintread onlyGs control seq
account_idtextread, writeNetwork account id
portal_idtextread, writePortal id
settingsjsonbread onlySettings
is_defaultbooleanread, writeDefault for its kind
is_activebooleanread, writeActive
last_used_attimestamp with time zoneread onlyLast used at
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 › Network Connections 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.