Overview
ConfigurationWSDL-based configurationEach HL7 endpoint has a corresponding WSDL, which you can use to automatically configure your connection (if supported by your toolset).
Please see our Connectivity page for technical details of where the WSDL can be found for your environment.
No built-in SOAP/Web Services support?If you can make HTTP requests, you can still use the SOAP/Web Services interface.Here's what's involved in submitting an HL7 message securely to PKB using the web services (SOAP) interface. You can test it using Postman (an app for the Chrome browser). Submit an HTTP POST to the relevant HL7 URL. Please see our Connectivity page for technical details of where the HL7 SOAP message should be sent. You'll need to provide your HTTP Auth:
username: _________
password: _________ The way to include that in the request using Postman is to add this HTTP header: Header: Authorization Value: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE (the second part of the value will need to be "your-username:your-password" encoded in Base64) You'll also need to set the content type in a second HTTP header: Header: Content-Type Value: text/xml The body (raw) of the message is this XML SOAP wrapper around your HL7 message. It wraps your HL7 content in a "CDATA" tag so that you don't need to escape XML special characters like & < and >: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wss="http://wsssl.hl7api.patientsknowbest.com/"> <soapenv:Header/> <soapenv:Body> <wss:acceptMessage> <arg0><![CDATA[YOUR HL7 MESSAGE GOES HERE ]]></arg0> </wss:acceptMessage> </soapenv:Body></soapenv:Envelope>Here's a full working example for content: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wss="http://wsssl.hl7api.patientsknowbest.com/"> <soapenv:Header/> <soapenv:Body> <wss:acceptMessage> <arg0><![CDATA[MSH|^~\&|SendingApp|SendingOrg|HL7API|PatientsKnowBest|201302241503||ORU^R01|6566425|P|2.3PID|||5981074299^^^NHS^NH~123456^^^RA9^MS~||PATIENT^DATA^^^||19800101|F|||1 WIMPOLE STREET^^LONDON^LONDON^CB1 8NR|||||||||||^|||||||| ORC|RE||0011B050802||IP||^^^201302241100^^R||201302241503|||KEEL^DR P.G. KERLING|DATA^PKB DATA INTEGRATION||||||| OBR|1||0011B050802|CBC^BCBC^WinPath||201302241423|201302241100||||||\.br\\.br\\.br\\.br\? mi|201302241100|B^Blood,|KEEL^ DR P.J. KEELING||||||201302241457||BHI|F||^^^^^ROBX|1|NM|BHIMCH^MCH^WinPath||31.2|pg/cell|27 - 32||||F|||201302241100|| ]]></arg0> </wss:acceptMessage> </soapenv:Body></soapenv:Envelope>Source informationPartner connectionsIf you are connecting as a Partner, please see specific guidance here.Default teamsAll patients need to be created into a PKB Team.Since your HL7 credentials represent your PKB Organisation, then the client should decide which PKB Team patients created via HL7 API interface should be placed in.
AliasesOccasionally, some customers have a need to send a message using their PKB Organisation level HL7 credentials, but have it processed as if it came from a specific PKB Team. For example, if you need to create a patient into a PKB Team other than your default, you will need this functionality. We can configure some aliases for you, such that you can send the corresponding alias in MSH-4 to indicate which PKB Team you're sending the message on behalf of.At the moment, you can only send a message as a PKB Team within your own PKB Organisation (or, although less common, you could connect as a PKB Team and send a message on behalf of your PKB Organisation). However, you cannot yet send a message on behalf of another PKB Organisation entirely.
Note: Once an alias has been configured, you will be required to provide an alias on every call. So for example, if you occasionally need to send a message using an alias for a PKB Team, but the rest as your PKB Organisation, then you will need 2 aliases - one for the PKB Team and one for the PKB Organisation.
Aliases are not case sensitive.
PKB Aliasing Checklist:
|
Developer documentation > HL7 API >
