Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Whenever an appointment partner wishes to add or update a management URL to an appointment in PKB, they send a supported HL7 SIU message. This message must include the necessary information required to identify the appointment, along with a custom ZAP segment which contains the management URL. The HL7 logic for SIU update messages will ignore any additional fields not provided, as is currently the case. This means that the appointment partner can simply omit the key appointment details (e.g. start time, location) and PKB will not overwrite or delete these. The following information is required:

    1. MSH-4. This must contain the alias for the relevant customer. Our syntax requires this to be provided twice in the format: alias{alias} - see our HL7 Partner pages for more information.

    2. PID-3. This must contain the patient identifier (e.g. NHS number).

    3. PID-7. This should contain the patient's DOB to assist with our soft matching logic.

    4. SCH-1. This must contain the appointment placer ID, typically issued by the customer PAS, that uniquely identifies the appointment

    5. ZAP-1. The management URL for the appointment. This is a static URL, but it may contain static path or query parameters (e.g. both https://appointments-r-us.co.uk/manage/123 and https://appointments-r-us.co.uk/manage?123 are supported).

...