Person

Owned by Andrew Turner (Unlicensed)
Last updated: Dec 06, 2022 by Tom Pick (Unlicensed)
1 min read

https://www.hl7.org/fhir/STU3/person.html

Status

In development. API spec subject to change.

Overview

Some users in PKB are allowed to belong to multiple teams. For example, a Professional can be associated with multiple Teams.

The Person type service allows a caller to search for other users which are known to represent the same person as a given user.

A Person resource is typically only created when more than one user is known to exist for a given person; a Person resource might not be returned if the provided user has no other known users.

Relevant PKB entities

Endpoints

Interaction

HTTP

URL

Supported Parameters

Permitted User Types

Description

Examples

search

GET

/Person

  • link.  Required. Multi-value support: none. Modifier-support: [<type>].

  • Professional

Finds other users known to represent the same person.

/Person?link=Practitioner/ fe486948-b6e2-4826-9a7a-f78cf671fea9

Mappings

FHIR

PKB

Notes

Resource id

[[Person.Public ID]]

 

Person.link

  • link: BackboneElement

    • target: Reference

      • reference = the relative URL of the Practitioner

      • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]