HL7 Integration
PKB’s HL7 APIs are based on HL7 Messaging Standard 2.4
This area of the wiki is split into two main sections and is designed to support you in the sending of data via HL7 APIs to create and populate patient records in PKB.
Gain and understanding of:
The options available for connecting to our Sandbox and Production endpoints, the security standards you’ll need to comply with and guides to help you successfully connect.
How to send data as a 3rd party on behalf of another PKB organisation
How to construct and send HL7 messages to PKB
How we use identifiers supplied in HL7 messages to match to PKB records, what identifiers we support being sent and how you should send them.
Standard concepts that are applied when processing messages.
Guidance and Scopes for Sending HL7 data
Will provide you with:
A list of the HL7 APIs you can use to send data to PKB
Details of the response you will receive when PKB processes an HL7 message from you
A section for each of the data types you can send using HL7, containing:
An example of the configuration document an organisation must complete before beginning development work.
The HL7 API scope
Example HL7 Message(s)
Guidance on the data to include in the message
An example of the Testing & Evidence document we’ll ask you to complete as part of your testing process.
An FAQ’s page specific to that data feed type.
Page Index
HL7 - Getting Started
- Connecting to PKB's HL7 Endpoints
- Introduction to the HL7 message format
- Sending an HL7 Message
- Sending HL7 Messages as a 3rd Party (HL7 Partner)
- Understanding Patient identifiers & matching
- Understanding Soft Matching
- Understanding Auto Create
- Code Sets Overview
- Managing Patient Email Addresses
- Using Timestamp values
Guidance and Scopes for Sending HL7 Data
- Scopes for standard Segments
- ACK (Acknowledgement Response)
- Demographics
- Allergies
- Diagnosis
- Medications
- Appointments
- Encounters (Admission / Discharge / Transfer)
- Documents
- Care Plans
- Radiology Reports
- Pathology Results
- Measurements