Sign in

v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011274550.0 KB
HL7 Systems

Add Interface to HL7 System

Add a new outbound interface to an HL7 system. New interfaces are appended to the end of the priority list.

post/v1/hl7-systems/{id}/interfaces

Path parameters

idstring required

Request body

namestring required
messageTypesstring[] required
urlstring required
method'POST' | 'PUT'
headersobject
usernamestring
passwordstring
interfaceNamestring
enabledboolean

Response

Default Response

_idstring required
sendingApplicationstring required
sendingFacilitystring required
receivingApplicationstring required
receivingFacilitystring required
systemKeystring required
namestring required
status'unmapped' | 'active' | 'disabled' required
brandIdstring
autoRegisteredboolean
firstSeenAtstring date-time
lastSeenAtstring date-time
messageCountinteger
lastMessageTypestring
notesstring
createdAtstring date-time
updatedAtstring date-time