Versions Compared

Key

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

...

This page outlines the technical details of how to use the HL7 API to ensure your patients are automatically added to the correct Teams for your deployment.

Linked Teams

...

1: Source Organisation / Team

When connecting to PKB, the Source Organisation and/or Source Team are initially determined from the authentication credentials provided.

It is additionally possible to modify the Source Team through use of an alias in MSH-4.

2: Creating Team

When creating a record, exactly one Team will be identified as the Creating Team. The Creating Team will be determined as follows:

  • If the connection is authenticated as an HL7 Partner:

    • The Creating Team will be the default team (if present) for the corresponding grant issued by the Source Organisation on whose behalf the Partner is currently connecting

  • Else if a Source Team is present on the authenticated connection (for example, if the Source Organisation is using an MSH-4 alias to identify a specific Source Team for the current message):

    • That Source Team will also be treated as the Creating Team

  • Else:

    • The Creating Team will be the default team (if present) for the Source Organisation

...

  • The message was a demographic update (either an ADT A28 or ADT A31)

  • The auto-create configuration option has been enabled for the interface

...

Notably, this is true even if the HL7 message is relates to a real-world admission or discharge (e.g. an ADT A01 or ADT A03).

PKB customer sites: deploy | developer | information governance | procurement | manual

...