Developer documentation‎ > ‎FHIR API‎ > ‎Roadmap‎ > ‎

Patient

This is a draft document. Please be aware that the contents are subject to change.

FHIR Patient Resource

https://www.hl7.org/fhir/patient.html

Overview

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

Relevant Entities

Endpoints

Protection CategoryInteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
Non ClinicalreadGET/Patient/<id>None
  • Patient
  • Professional
Retrieve a specific Patient./Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

Mappings

FHIRPKBNotes
Resource id[[User.Public ID]] 
Patient.name
  • name: HumanName
    • family = [[User.Family Name]]
    • given[0] = [[User.Given Name]]
    • prefix[0] = [[User.Title]]

Patient.telecomFor each [[Contact]] for the [[Patient]] where [[Contact.Type]] = EMAIL_ADDRESS, add an entry to the telecom list.
  • 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 and the FHIR data model - 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:

  • deceasedDateTime = [[Patient.Death Timestamp]]
Else if the patient is recorded as dead but a death timestamp has not been recorded:
  • deceasedBoolean = true
Else
  • 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]]

Patient.gender value mappings (PKB → FHIR):
  • U → unknown
  • M → male
  • F → female
  • I → other
Note: PKB's values match NHS values, hence marginal discrepancy with FHIR.
Patient.identifierFor each [[National ID]] for the [[Patient]], add an entry to the identifier list.
  • 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.
  • 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.
  • 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.

Comments