Resources

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

Resource Mapping Summary

A summary of the resource mappings is given below. Please see the subpages for full details of each resource.

FHIR ResourcePKB Entities
CapabilityStatementN/A
Consent[[Consent Record]] 
NamingSystem[[Organisation Level ID Type]]
[[Team Level ID Type]]
Operation DefinitionN/A
Organization[[Organisation]]
[[Team]]
Patient[[Patient]]
[[National ID]]
[[Organisation Level ID]]
[[Team Level ID]] 
Practitioner 

[[Professional]]

Resource & Metadata

FHIR Resource

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

Overview

Any resource returned by PKB will comply with the standard Resource definition. This includes populating the Meta element with relevant metadata.

It is worth noting that [[Source]] information will not be returned as metadata.

Instead, callers should request a Provenance resource by specifying _revinclude=Provenance:target during the initial search for the data in question.

Note: although _revinclude is not available to instance service reads, a type service search can be made to emulate an instance service read by specifying the _id parameter and setting it to be the logical value of the resource you wish to retrieve. 

Endpoints

N/A 

Mappings

FHIRPKB
Meta.lastUpdatedWhere the resource corresponds to a PKB Data Point, [[Data Point.Persisted Timestamp]] will be returned in this field. This is the timestamp recorded by the server, not one provided by the client. 
Meta.securityWhere the resource corresponds to a PKB Data Point, there will be exactly one security label returned. The code value will indicate the Privacy Label of the data point.
  • Coding.system = http://pkb.io/fhir/CodeSystem/privacy-label
  • Coding.code = [[Data Point.Privacy Label]]
Coding.code value mappings (PKB → FHIR):
  • GENERAL_HEALTH → GENERAL_HEALTH
  • MENTAL_HEALTH → MENTAL_HEALTH
  • SEXUAL_HEALTH → SEXUAL_HEALTH
  • SOCIAL_CARE → SOCIAL_CARE 
Comments