PID

Patient identification

PID-2

O

Patient identifier. See our identifiers and matching documentation for more information about acceptable identifiers.

PID-2.1

Patient ID

9999999999

If PKB ID:
[[User.Public ID]]

If National ID:
[[Patient.National ID.Value]]

If Organisation Level ID:
[[Patient.Organisation Level ID.Value]]

If Team Level ID:
[[Patient.Team Level ID.Value]]

Y - for National IDs

N/A - for local IDs

PID-2.4

Patient ID assigning authority (e.g "NHS" for the UK)

NHS

If PKB ID: PKB

If National ID:
[[Patient.National ID.National ID Type.HL7 Assigning Authority]]

If Organisation Level ID:
[[Patient.Organisation Level ID.Organisation Level ID Type.HL7 Assigning Authority]]

If Team Level ID:
[[Patient.Team Level ID.Team Level ID Type.HL7 Assigning Authority]]

N/A

PID-2.5

Patient ID type code. If an NHS number status code is being provided, it must be appended without a space in the format given in the example.

NH{status:01}

If PKB ID: PI

If National ID:
[[Patient.National ID.National ID Type.HL7 Type Code]]

If Organisation Level ID:
[[Patient.Organisation Level ID.Organisation Level ID Type.HL7 Type Code]]

If Team Level ID:
[[Patient.Team Level ID.Team Level ID Type.HL7 Type Code]]

N/A

PID-3

O

Y

Patient identifier. See our identifiers and matching documentation for more information about acceptable identifiers.

PID-3.1

Patient ID

9999999999

As PID-2.1

As PID-2.1

PID-3.4

Patient ID assigning authority (e.g "NHS" for the UK)

NHS

As PID-2.4

As PID-2.4

PID-3.5

Patient ID type code

NH{status:01}

As PID-2.5

As PID-2.5

PID-5

O

Name. Each component is optional by default, but any that have been configured for soft matching must be provided.

PID-5.1

Family name

Smith

[[Patient.Family Name]]

Y

PID-5.2

Given name

John

[[Patient.Given Name]]

Y

PID-5.3

Middle names

Joe

[[Patient.Middle Names]]

Y

PID-5.5

Title

Mr

[[Patient.Title]]

Y

PID-7

O

Date of birth

PID-7.1

Date of birth. Note that this timestamp will be accepted even if it contains time information.

19700101

[[Patient.Date of Birth]]

Y

PID-8

O

Gender (Administrative Sex)

PID-8.1

Gender. Allowed values are defined in Code Set PKBCS01.

M

[[Patient.Gender]]

Y

PID-11

O

Address. Each component is optional by default, but any that have been configured for soft matching must be provided.

PID-11.1

Address Line 1

Flat name

[[Patient.Address Line 1]]

Y

PID-11.2

Address Line 2

1, The Road

[[Patient.Address Line 2]]

Y

PID-11.3

City

London

[[Patient.City]]

Y

PID-11.4

State

London

[[Patient.State]]

Y

PID-11.5

Postal code

SW1A 1AA

[[Patient.Postal Code]]

Y

PID-11.6

Country code

GBR

[[Patient.Country]]

If blank during creation, the default country will be that of the source team if present, else that of the source org.

This should normally be the 3-character ISO 3166 country code. Customers in the UK should specify more granular information using the 2-character code with region and not supply code GBR (which will always result in the country defaulting to England).

Wales = GB-WLS
England = GB-ENG
N.I. = GB-NIR
Scotland = GB-SCT

Y

PID-13

O

Y

Supports sending of Home contact number, Mobile contact number and Email address information.

Note that an invalid email address will be silently ignored. If more than one email address is provided in PID-13 then the last in the list will be used, and the others will be silently ignored. See our notes on email address handling for more information.

PID-13.1

Contact value

[[Patient.Contact.Value]] is set to this value if PID-13.2 is NET and PID-13.4 is not provided.

Note: Only the phone number types of mobile (PRS) and home (PRN) will be stored in [[Patient.Phone]].
HL7 null is NOT accepted as a value.

If work (WPN) is provided this will be silently ignored.

Y - for phone numbers

N/A - for email addresses

PID-13.2

Contact use code. Allowed values are defined in Code Set PKBCS02.

NET

If this is NET then

[[Patient.Contact.Type]]

will be set to EMAIL.

N/A

PID-13.4

Email address. When receiving data where PID-13.2 is NET, PKB will pull the email address from PID-13.4. If this field is not provided, then PID-13.1 will be used instead.

john.smith@hotmail.com

[[Patient.Contact.Value]]

if PID-13.2 was NET.

N/A

PID-14

O

Y

Supports sending of Work contact and Email address information.

Note that an invalid email address will be silently ignored. If more than one email address is provided in PID-14 then the last in the list will be used, and the others will be silently ignored. See our notes on email address handling for more information.

PID-14.1

Contact value

01234 567890

[[Patient.Contact.Value]] is set to this value if PID-14.2 is NET and PID-14.4 is not provided.

If PID-14.2 is WPN then this value can be added to [[Patient.Phone]].

Note: Only the phone number type for work (WPN) will be stored in [[Patient.Phone]].
HL7 null is NOT accepted as a value.

Mobile (PRS) and home (PRN) will be silently ignored if provided.

Y - for phone numbers

N/A - for email addresses

PID-14.2

Contact use code. Allowed values are defined in Code Set PKBCS03.

WPN

If this is NET then

[[Patient.Contact.Type]]

will be set to EMAIL.

N/A

PID-14.4

Email address. When receiving data where PID-14.2 is NET, PKB will pull the email address from PID-14.4. If this field is not provided, then PID-14.1 will be used instead.

[[Patient.Contact.Value]]

if PID-14.2 was NET.

N/A

PID-15

O

Primary language. This should be the ISO 639-1 code. If no language is specified the default of English will be used.

PID-15.1

Primary language

en

[[Patient.Language]]

Y

PID-15.4

Alternative primary language. This is only checked if PID-15.1 is not provided.

en

[[Patient.Language]]

Y

PID-29

O

Death timestamp. If the death timestamp is set, then "Y" is inferred for death indicator in PID-30, regardless of its actual value.