v46

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

HL7 Systems

Update HL7 System Interface

Update an existing interface on an HL7 system.

put/v1/hl7-systems/{id}/interfaces/{interfaceId}

Path parameters

idstring required

interfaceIdstring required

Request body

namestring

messageTypesstring[]

urlstring

method'POST' | 'PUT'

headersobject

{"stackTrail":"paths:/v1/hl7-systems/{id}/interfaces/{interfaceId}:put:requestBody:content:application/json:schema:properties:username","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/hl7-systems/{id}/interfaces/{interfaceId}:put:requestBody:content:application/json:schema:properties:password","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/hl7-systems/{id}/interfaces/{interfaceId}:put:requestBody:content:application/json:schema:properties:interfaceName","oasType":"schema","type":"unknown"}

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