Overview
PKB supports 3 4 types of identifier in the HL7 API:
System. PKB assigns each patient a UUID. This is unique across the entire PKB system, and can be used to identify a patient independently of their links to any country, organisation or team.
Email address. PKB permits an email address to be used to target a medical record.
National. A national identifier is an identifier that identifies a patient within a given country, such as an NHS number.
Local. A local identifier is an identifier which identifies a patient uniquely for a sender, but not outside that sender. An example would be a hospital number. A local identifier can be associated with either a PKB Organisation or a PKB Team.
...
an Assigning Authority of: PKB
an Identifier Type Code of: PI
Email address identifiers
In order to use an email address as an identifier, you must provide it as an identifier (e.g. PID-3) rather than a contact point (e.g. PID-13). This is to ensure an unconfirmed email address is not accidentally included in a matching workflow. In order for an email address value to be recognised as an identifier, you must provide:
an Assigning Authority of: EMAIL
an Identifier Type Code of: EMAIL
An email address identifier will only match a medical record if the email address is either a) the primary address on the record, or b) a secondary address but which has been confirmed.
No more than one email address identifier can be included.
See our dedicated email addresses page for additional information and business logic rules.
National identifiers
In order to send through a national ID, you need to supply the Assigning Authority and Identifier Type Code as detailed in the table below.
Identifier Name | Country | Assigning Authority | Identifier Type Code | Status Code |
NHS Number * | GB-ENG, GB-WLS | NHS | NH | In addition, note that the NHS number can optionally include a status code, as defined in the NHS Data Dictionary . If present, the status code is supplied with the identifier type code, in the format NH{status:XX} where XX is the status code. There must be no space between “NH” and the status code. Since the status code is optional, “NH” remains a valid identifier type code. For example: NH{status:01} |
CHI Number * | GB-SCT | NHS Scotland | NH |
|
Health and Care Number * | GB-NIR | DHSSPS | NH |
|
Individual Health Identifier | IE | HSE | NI | |
SSN | US | USA | NI |
|
SIN | CA | CA | NI |
|
HKID | HK | HK | NI |
|
BSN | NL | NL | NI |
|
Krankenversichertennummer | DE | DE | NH |
|
Civil ID | KW | KW | NI |
|
*A note about NHS-Type Numbers. The following 3 National ID Types are drawn from the same numbering scheme, but with non-overlapping ranges. PKB considers them to be separate types. It is the responsibility of the sender to ensure the correct AA/TC values are sent.
CHI Number (Scotland): 010 101 0000 to 311 299 9999
Health and Care Number (Northern Ireland): 320 000 0010 to 399 999 9999
NHS Number (England and Wales): 400 000 0000 to 999 999 9999
Sandbox
PKB sandbox (sandbox.patientsknowbest.com) will only accept NHS numbers starting with 9 or a 5 and CHI and H&C numbers where the 7th and 8th digits are both set to 9. This is to help prevent accidental submission of real patient data to the sandbox environment.
Local identifiers
You will need to agree with PKB what local identifiers you would like to send through.
Each PKB Organisation or PKB Team can be associated with multiple local identifier types, and each patient can be associated with multiple ID values for each local identifier type.
AA wildcarding
A local ID type can have a wildcard for the Assigning Authority (but not the Type Code). If this is configured, then an HL7 identifier will be assigned to this type if the TC matches, regardless of the provided AA value.
Restrictions & scope
The scope of AA/TC pairs for local IDs is the whole PKB Organisation. All AA/TC pairs for a PKB Organisation (and for all PKB Teams within that PKB Organisation) must be unique across the PKB Organisation.In addition, a Type Code can only be used with a wildcarded Assigning Authority if that Type Code is not used by any other local ID within the PKB Organisation (or any PKB Teams within that PKB Organisation).
A local ID AA/TC pair must not match the AA/TC pair for any national ID.
...