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

Person

https://www.hl7.org/fhir/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

InteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
searchGET/Person
  • link. Required. Multi-value support: none. Modifier-support: [<type>].
  • Professional
Finds other users known to represent the same person./Person?link=Practitioner/bdaa24d0-3cd5-469c-aa69-db676fa31bbe

Mappings

FHIRPKBNotes
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]]

Comments