---
title: "Facade Patient"
canonical: "https://wiki.patientsknowbest.com/space/api/3364946397/Facade%20Patient"
format: markdown
---
[http://fhir.patientsknowbest.com/structuredefinition/facade-patient](http://fhir.patientsknowbest.com/structuredefinition/facade-patient)

[https://www.hl7.org/fhir/STU3/patient.html](https://www.hl7.org/fhir/STU3/patient.html)

## Overview

The Patient resource returns basic demographic information about a [[Patient]].

## Relevant PKB entities

- [[[Patient]]](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Patient-%26-Contact)
- [[[National ID]]](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Identifiers)
- [[[Local ID]]](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Identifiers)
  - [[[Organisation Level ID]]](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Identifiers)
  - [[[Team Level ID]]](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Identifiers)
- [[[Contact]]](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Patient-%26-Contact)

## Mappings

| **FHIR** | **PKB** | **Notes** |
| --- | --- | --- |
| Resource id | [[User.Public ID]] |  |
| Patient.extension | - extension[0]: Extension
  - url = "[http://fhir.patientsknowbest.com/structuredefinition/sharing-disabled](http://fhir.patientsknowbest.com/structuredefinition/sharing-disabled)"
  - valueBoolean = [[Patient.Sharing Disabled]] |  |
| Patient.name | - name: HumanName
  - family = [[User.Family Name]]
  - given[0] = [[User.Given Name]]
  - given[1] = [[User.Middle Names]]
  - prefix[0] = [[User.Title]] |  |
| Patient.telecom | For each [[Contact]] for the [[Patient]] where [[Contact.Type]] = EMAIL_ADDRESS, add an entry to the telecom list.<br>- telecom: ContactPoint
  - system = "email"
  - value = [[Contact.Value]] |  |
|  | - telecom: ContactPoint
  - system = "phone"
  - value = [[Patient.Phone]] |  |
| Patient.birthDate | [[Patient.Date of Birth]] | Note: as per both the [PKB Data Model](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3363700789/Data+Model#Patient-%26-Contact) and the [FHIR data model](https://www.hl7.org/fhir/STU3/patient-definitions.html#Patient.birthDate) - this is date only. No time information should be returned. |
| Patient.deceased[x] | <conditional>   
If the patient is recorded as dead and a death timestamp has been recorded:<br>- deceasedDateTime = [[Patient.Death Timestamp]]<br>Else if the patient is recorded as dead but a death timestamp has not been recorded:<br>- deceasedBoolean = true<br>Else<br>- deceasedBoolean = false |  |
| Patient.address | - address: Address
  - line[0] = [[Patient.Address Line 1]]
  - line[1] = [[Patient.Address Line 2]]
  - city = [[Patient.City]]
  - state = [[Patient.State]]
  - postalCode = [[Patient.Postal Code]]
  - country = [[Patient.Country]] |  |
| Patient.gender | [[Patient.Gender]]<br>[[Patient.Gender]] code mappings (PKB → FHIR):<br>- UNKNOWN → unknown
- MALE → male
- FEMALE → female
- INDETERMINATE → other | Note: PKB's values match NHS values, hence marginal discrepancy with FHIR. |
| Patient.identifier | For each [[National ID]] for the [[Patient]], add an entry to the identifier list.<br>- identifier: Identifier
  - value = [[National ID.Value]]
  - system = [[National ID Type.FHIR Identifier System]] |  |
|  | For each [[Organisation Level ID]] for the [[Patient]] visible to the caller, add an entry to the identifier list.<br>- identifier: Identifier
  - value = [[Organisation Level ID.Value]]
  - system =  "urn:uuid:"  + [[Organisation Level ID Type.Public ID]] | The Identifier.system can be provided as the "value" param to a NamingSystem search to retrieve additional information about the identifier namespace, where known. |
|  | For each [[Team Level ID]] for the [[Patient]] visible to the caller, add an entry to the identifier list.<br>- identifier: Identifier
  - value = [[Team Level ID.Value]]
  - system =  "urn:uuid:" + [[Team Level ID Type.Public ID]] | The Identifier.system can be provided as the "value" param to a NamingSystem search to retrieve additional information about the identifier namespace, where known. |