Note: It is recommended that theFHIR APIs are used for any new integrations.
...
HL7 API:The mail management solution sends an HL7 ADT^A28 with verified NHS number and required PID information to create the record. ReferenceHL7 ADT A28.
MSH|^~\&|POPRECORD|POPRECORD|HL7API|PKB|201904241033||ADT^A28|186b1b87-c438-443c-b254-3e69e5c7edff|P|2.4
...
HL7 API:The mail management solution sendsan HL7 MDM^T02 to add the received document to the patient record. ReferenceHL7 MDM T02. The document id is : 78ffb8b4-566c-4a3e-ba07-adb04b798d8d
...
Rest API: ‘GET byNationalId’. The mail management solution uses their OAUTH2 access token (system id) to retrieve the PKB ID (3594342) for ‘Read Richards’ (NHS: 5760678914). ReferenceOAUTH walkthrough (system client ID), REST getNationalNumberByPatientId
...
HL7 API:The mail management solution sends an HL7 QRY^A19 with a QRD.9 of STA and a QRF.2 of a relevant date to retrieve registration status updates of patients in the organisation. ReferenceHL7 QRY A19 (STA).
Note: This query is primarily intended to be used as a delta query to build and maintain a local reference table of patients and their registration status within PKB. In the typical workflow this is referred to as ‘Update Reg Repo’. Note: an initial one off full QRY^A19 of patients and their statuses may have been run on deployment to build the ‘Reg Repo’ base version.
...
FHIR API: Using an OAUTH access token (user client id) the mail management solution uses the FHIR DocumentReference resource to determine the read status of documents. A document is considered READ when the patient opens the message on PKB. ReferenceOAUTH walkthrough (user client ID), FHIR DocumentReference
PKB will provide you with the source_organisation parameter used below. This parameter will not change.
...