--- title: "Aggregated Patient" canonical: "https://wiki.patientsknowbest.com/space/api/3711074317/Aggregated%20Patient" format: markdown --- [http://fhir.patientsknowbest.com/structuredefinition/aggregated-patient](http://fhir.patientsknowbest.com/structuredefinition/aggregated-patient) [https://www.hl7.org/fhir/R4/patient.html](https://www.hl7.org/fhir/R4/patient.html) ## Description This profile is… - a description of how non-FHIR patient data will be mapped to FHIR in the [Aggregated FHIR endpoint](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3364388935) by PKB This profile is not… - a spec for all Patient resources returned from the Aggregated FHIR endpoint; resources sent to a Customer FHIR endpoint are not guaranteed to conform to this profile - a spec describing how Patient resources must be sent to a Customer FHIR endpoint; some of the elements used in this profile might only be meaningful for migrated data and cannot be provided to a Customer FHIR endpoint ## Relevant PKB entities - [[[Patient]]](https://wiki.patientsknowbest.com/space/api/3749543951) | **FHIR** | **PKB** | **Notes** | | --- | --- | --- | | Resource id | [[Patient.Aggregated ID]] | | | Resource meta | - meta: Meta - lastUpdated = time of most recent update, automatically maintained by the FHIR server. It is normal for this to be slightly later than any value returned in the [http://fhir.patientsknowbest.com/structuredefinition/version-persisted](http://fhir.patientsknowbest.com/structuredefinition/version-persisted) extension. | | | Patient.extension | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/user-type“](https://pkbdev.atlassian.net/wiki/spaces/TECHNOLOGY/pages/3818389511) - valueString = “PATIENT” | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/registered-on”](#) - valueDateTime = [[Patient.Registered On]] | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/language-code”](#) - valueString = [[Patient.Language]] | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/time-zone-id”](#) - valueString = [[Patient.Time Zone]] | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/frozen-by-team”](#) - valueReference: Reference - reference = The relative URL of the [[Patient.Access Frozen Source Team]] | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/two-factor-auth-state”](#) - valueString = [[Patient.2FA State]] | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/two-factor-auth-mandatory](http://fhir.patientsknowbest.com/structuredefinition/two-factor-auth-mandatory)” - valueBoolean = [[Patient.2FA Mandatory]] | | | | - extension[x]: Extension - system = “[http://fhir.patientsknowbest.com/structuredefinition/skype-id”](#) - valueString = [[Patient.Skype ID]] | | | | - extension[x]: Extension - system = "[http://fhir.patientsknowbest.com/structuredefinition/notification-option](http://fhir.patientsknowbest.com/structuredefinition/notification-option)" - valueString = [[Patient.Notification Option]] | | | Patient.identifier | - identifier[x]: Identifier - system = “[http://fhir.patientsknowbest.com/id/pkbperson-legacy-identifier”](#) - value = [[Patient.Legacy User ID]] | | | | For each [[National ID]]:
- identifier[x]: Identifier - system = [[National ID->National ID Type.FHIR Identifier System]] - value = [[National ID.Value]] | | | | For each [[Organisation Level ID]]:
- identifier[x]: Identifier - type: CodeableConcept - text = “Org level identifier” - system = “urn:uuid:” + [[Organisation Level ID->Organisation Level ID Type.Public ID]] - value = [[Organisation Level ID.Value]] - assigner: Reference - reference = the relative URL of the Organization resource | | | | For each [[Team Level ID]]:
- identifier[x]: Identifier - type: CodeableConcept - text = “Team level identifier” - system = “urn:uuid:” + [[Team Level ID->Team Level ID Type.Public ID]] - value = [[Team Level ID.Value]] - assigner: Reference - reference = the relative URL of the Organization resource | | | Patient.name | - name: HumanName - family = [[Patient.Family Name]] - given[x] = [[Patient.Given Name]] - given[x] = [[Patient.Middle Names]] - prefix = [[Patient.Title]] | | | Patient.telecom | - telecom[x]: ContactPoint - system = “phone” - value = [[Patient.Phone]] | | | | For each [[Patient.Contact]] where Type == EMAIL_ADDRESS:
- telecom[x]: ContactPoint - system = “email” - value = [[Patient.Contact.Value]] | | | Patient.gender | [[Patient.Gender]]
[[Patient.Gender]] code mappings (PKB → FHIR):
UNKNOWN → unknown
MALE → male
FEMALE → female
INDETERMINATE → other | | | Patient.birthDate | [[Patient.Date of Birth]] | | | Patient.deceased[x] |
If the patient is recorded as dead and a death timestamp has been recorded:
- deceasedDateTime = [[Patient.Death Timestamp]]
Else if the patient is recorded as dead but a death timestamp has not been recorded:
- deceasedBoolean = true | | | Patient.address | - address: Address - line[x] = [[Patient.Address Line 1]] - line[x] = [[Patient.Address Line 2]] - city = [[Patient.City]] - state = [[Patient.State]] - postalCode = [[Patient.Postal Code]] - country = [[Patient.Country]] | |