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

Request

Base URL
https://api.bluehive.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/hl7-systems/:id/interfaces/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

namestring required

messageTypesstring[] required

urlstring required

method'POST' | 'PUT'

headersobject

usernamestring

passwordstring

interfaceNamestring

enabledboolean

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