HTTPS is our second preferred method of real-time data exchange and offers a highly reliable and scalable solution for secure API communications, ideal for healthcare information.
Key Benefits
High Availability: HTTPS provides a resilient infrastructure with built-in redundancy and failover capabilities, minimizing downtime and ensuring critical healthcare data exchanges are always accessible.
Scalability: Automatically scales to handle varying message volumes, accommodating fluctuating HL7 feed rates from sporadic updates to high-volume bursts without manual intervention.
Ease of Integration: HTTPS APIs are straightforward to implement using standard web technologies and libraries available in virtually every programming language, significantly reducing development time and enabling faster integration with existing systems.
Security: Operates over TLS 1.2 or higher, utilizing strong encryption, certificate-based authentication, and secure key exchange mechanisms to safeguard data in transit against unauthorized access and tampering.
Compliance: Supporting HIPAA-compliant secure transmission when properly configured, HTTPS meets stringent regulatory requirements for protecting healthcare data and ensures adherence to industry standards for secure communications.
Getting Connected
We will provide you with:
Staging Endpoint & API Key
Production Endpoint & API Key
Headers
The key should be provided on every request as the value in a header named x-api-key.
Content-Type should also be set accordingly, e.g. application/json or application/xml.
Encoding
We prefer base64 encoded HL7 in a JSON wrapper but we can also support XML wrappers.
Below is a JSON example:
{
"body": {
"Meta": {
"FacilityCode": "HOSP"
},
"data": "TVNIfF5+XCZ8SE9TUF9BRFR8SE9TUHxBRFRfU1lTfEFEVF9TWVN8MjAyMzA2MDYxMjAwMDB8fEFEVF5BMDR8TVNHMDAwMDAxfFB8Mi41CkVWTnxBMDR8MjAyMzA2MDYxMjAwMDB8fHwKUElEfDF8fFBBVDAwMDAwMXx8RG9lXkpvaG5eXl5Ncnx8MTk4MDAxMDF8TXx8fDEyMyBNYWluIFN0Xl5Bbnl0b3duXk5ZXjEyMzQ1fHw1NTUtMTIzLTQ1Njd8fFN8fE18Tk9OfHx8fHxOClBWMXwxfEl8V0FSRDEyMzReMV4xXkdlbmVyYWwgV2FyZF5MfHx8MTIzNDVeU21pdGheSm9obnx8fFNVUnx8fHx8fHxBRE0xMjM0NTY3ODl8fHx8fHx8fHx8fDIwMjMwNjA2MTIwMDAwCg=="
}
}
NB: The Meta object is recommended but not required. The Facility Code can be set as the value in MSH.4, which we recommend contains a unique identifier per facility per feed.
For further data requirements, please review our HL7v2 Specification.