Entity: Organisation

Entity: Organisation

Public ID String

An ID for this Organisation.

Organization.id

Aggregated ID String

Organisations that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated.

Legacy Organisation ID String

An ID for this Organisation.

Name String

The name of this Organisation.

Organization.name

Code String

A PKB-assigned identifier for this Organisation.

Time Zone String

The default time zone for time stamps from this Organisation.

Active Boolean

Whether this Organisation is currently using PKB.

Type Enum

• prov

• dept

• team

• govt

• ins

• pay

• edu

• reli

• crs

• cg

• bus

• other

Entity: Team

Public ID String

An ID for this Team.

Organization.id

Aggregated ID String

Teams that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated.

Legacy Team ID String

An ID for this Team.

Name String

The name of this Team.

Organization.name

Code String

A PKB-assigned identifier for this Team.

Time Zone String

The default time zone for time stamps from this Team.

Entity: Person

Public ID String

An ID for this Person.

Entity: User

Legacy User ID String

An ID for this User.

Public ID String

An ID for this User.

For Patient
PID-2.1
PID-3.1
ZID-1.1

For Patient

Patient.id

Else

Practitioner.id

Aggregated ID String

Users that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated.

Title String

Title.

For Patient

PID-5.5

For Patient

Patient.name

Else

Practitioner.name

Profile page

Given Name String

The first name of the User.

For Patient

PID-5.2

For Patient

Patient.name

Else

Practitioner.name

Profile page
Dashboard page

Family Name String

The last name of the User.

For Patient

PID-5.1

For Patient

Patient.name

Else

Practitioner.name

Profile page
Dashboard page

HL7 API

FHIR API (Facade)

Custom REST API

Web (Patient)

Address Line 1 String

First line of the address.

Address Line 2 String

Second line of the address.

City String

The nearest city or town.

State String

The state.

Postal Code String

The postal code.

Date of Birth Local Date

Date of birth.

Phone String

The phone number of the professional.

Job Title String

What the professional does.

Email String

The email address of the professional.

Attribute

HL7 API

FHIR API (Facade)

Custom REST API

Web (Patient)

Public ID String

An ID for this Role.