...
1 | Segment | Field | Opt | RP/# | Component | Description | Example | Data Model | Blank Ignored On Update |
---|---|---|---|---|---|---|---|---|---|
2 | PID | Patient identification | |||||||
3 | PID-2 | O | Patient identifier. See our identifiers and matching documentation for more information about acceptable identifiers. | ||||||
4 | PID-2.1 | Patient ID | 9999999999 | If PKB ID: If National ID: If Organisation Level ID: If Team Level ID: | Y - for National IDs N/A - for local IDs | ||||
5 | PID-2.4 | Patient ID assigning authority (e.g "NHS" for the UK) | NHS | If PKB ID: PKB If National ID: If Organisation Level ID: If Team Level ID: | N/A | ||||
6 | 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: If Organisation Level ID: If Team Level ID: | N/A | ||||
7 | PID-3 | O | Y | Patient identifier. See our identifiers and matching documentation for more information about acceptable identifiers. | |||||
8 | PID-3.1 | Patient ID | 9999999999 | As PID-2.1 | As PID-2.1 | ||||
9 | PID-3.4 | Patient ID assigning authority (e.g "NHS" for the UK) | NHS | As PID-2.4 | As PID-2.4 | ||||
10 | PID-3.5 | Patient ID type code | NH{status:01} | As PID-2.5 | As PID-2.5 | ||||
11 | PID-5 | O | Name. Each component is optional by default, but any that have been configured for soft matching must be provided. | ||||||
12 | PID-5.1 | Family name | Smith | [[Patient.Family Name]] | Y | ||||
13 | PID-5.2 | Given name | John | [[Patient.Given Name]] | Y | ||||
14 | PID-5.3 | Middle names | Joe | [[Patient.Middle Names]] | Y | ||||
15 | PID-5.5 | Title | Mr | [[Patient.Title]] | Y | ||||
16 | PID-7 | O | Date of birth | ||||||
17 | 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 | ||||
18 | PID-8 | O | Gender | ||||||
19 | PID-8.1 | Gender. Allowed values are defined in Code Set PKBCS01. | M | [[Patient.Gender]] | Y | ||||
20 | PID-11 | O | Address. Each component is optional by default, but any that have been configured for soft matching must be provided. | ||||||
21 | PID-11.1 | Address Line 1 | Flat name | [[Patient.Address Line 1]] | Y | ||||
22 | PID-11.2 | Address Line 2 | 1, The Road | [[Patient.Address Line 2]] | Y | ||||
23 | PID-11.3 | City | London | [[Patient.City]] | Y | ||||
24 | PID-11.4 | State | London | [[Patient.State]] | Y | ||||
25 | PID-11.5 | Postal code | SW1A 1AA | [[Patient.Postal Code]] | Y | ||||
26 | PID-11.6 | Country code | GBR | [[Patient.Country]] | Y | ||||
27 | PID-13 | O | Y | Home contact 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. | |||||
28 | 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. If PID-13.2 is PRN or PRS then this value competes to be added to [[Patient.Phone]]. Note: Only one phone number is stored in [[Patient.Phone]]. To determine which phone number is stored an order of precedence is applied: mobile (PRS), then home (PRN), then work (WPN). HL7 null is accepted as a value and precedence still applied. | Y - for phone numbers N/A - for email addresses | |||||
29 | 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 | ||||
30 | 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. | [[Patient.Contact.Value]] if PID-13.2 was NET. | N/A | |||||
31 | PID-14 | O | Y | Work contact 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. | |||||
32 | 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 competes to be added to [[Patient.Phone]]. Note: Only one phone number is stored in [[Patient.Phone]]. To determine which phone number is stored an order of precedence is applied: mobile (PRS), then home (PRN), then work (WPN). HL7 null is accepted as a value and precedence still applied. | Y - for phone numbers N/A - for email addresses | ||||
33 | 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 | ||||
34 | 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 | |||||
35 | 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. | ||||||
36 | PID-15.1 | Primary language | en | [[Patient.Language]] | Y | ||||
37 | PID-15.4 | Alternative primary language. This is only checked if PID-15.1 is not provided. | en | [[Patient.Language]] | Y | ||||
38 | 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. | ||||||
39 | PID-29.1 | Death timestamp | 201508011638 | [[Patient.Death Timestamp]] | Y | ||||
40 | PID-30 | O | Death indicator. If this is "Y" but no date of death is provided in PID-29, we change the patient's status but don't record a date of death. | ||||||
41 | PID-30.1 | Death indicator. Y = Yes, N = No. | Y | [[Patient.Status]] | Y |
PKB customer sites:deploy |developer |information governance |procurement |manual
©Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.
...
This API specification and design is licensed under aCreative Commons Attribution 4.0 International License.