HL7 Integration

We have created a generic task list to use with our deployments for HL7 integrations to give you an insight into what is usually involved (see image below). Each site has varying specifications so some additional tasks can be needed. We have based the due dates on the premise that the customer has a technical lead available for one day a week to work on integration.


  1. Project Initiation Document filled out : Integrations to be implemented identified Bus Dev

  2. Project Kickoff : Project Manager takes over the PID

  3. Customer meets Assurance Criteria as defined here Client

  4. Send out IG documentation: Key IG issues in online documentation and fill out ISA and DPA. Project Manager

  5. Send out HL7 documentation for review: HL7 specification in online documentation and PKB IP (Sandbox) to whitelist Project Manager

  6. Sandbox test site created: Sandbox test-site created and log-in details sent out (patient, professional, coordinator, org admin for the org patient records (umbrella) team) Project Manager

  7. Kickoff Integration call with integration specialist: Follow PID template and walk through signup form Project Manager + Integration Specialist

  8. Information governance sign-off: Once all IG issues have been discussed to the satisfaction of all parties, IG sign-off can occur, live data does not flow until this is complete Project Manager

  9. Agree HL7 message specification: PKB publishes a specification for the HL7 messages we support in our online documentation, add to PID once agreed. Project Manager + Integration Specialist + Client

  10. Fill out HL7 credentials request form for sandbox HL7 credentials to start testing Client

  11. HL7 credentials created by PKB: Freshdesk (FD) ticket admin (tracker) by Project Manager and FD Dev creates sandbox HL7 credentials Sandbox Project Manager + Dev

  12. HL7 Credentials passed to client Project Manager

  13. Super admin port settings updated for sandbox using client supplied details Integration Specialist

  14. Connectivity established: Ensure client has whitelisted https://sandbox.patientsknowbest.com:7443/services/hl7 which sits outside N3. Client + Project Manager

  15. UAT Testing (including all code sets and patient matching issues) Follow Test Scripts - Client + Project Manager + Integration Specialist

  16. Multi-source testing done with PKB messages Client + Project Manager + Integration Specialist

  17. Prod test-site created: Client supplies details according to PKB request. Production site created and coordinator will be invited to register. Project Manager + Client

  18. Client firewall opened for PKB production environment https://nww.patientsknowbest.com:7443/services/hl7. For Netherland clients this is https://nl.patientsknowbest.com:7443/services/hl7 Client

  19. Review documentation and fill out HL7 credentials request form Prod Client

  20. Prod HL7 credentials created by PKB: Repeat step 11 for prod, and FD Dev to whitelist customer IP Project Manager + Dev

  21. Prod HL7 credentials sent to client via phone call Project Manager

  22. Super admin port settings updated for prod using client supplied details Integration Specialist

  23. Prod connectivity established: https://nww.patientsknowbest.com:7443/services/hl7 for UK. For the Netherlands https://nl.patientsknowbest.com:7443/services/hl7 Client + Project Manager

  24. Schedule a Go-Live time where all will be available Client + Project Manager

  25. Interfaces switched on for 1 hour testing load and last QA verification (to be done by a clinician with patient consent - implicit or explicit) Client + Project Manager

  26. Go-Live, provided IG is signed off

  27. Map test results to LOINC codes: Only if needed. See here for more information about the PKB approach to code sets Client + Project Manager