Resources


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.

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
    • code = [[Data Point.Privacy Label]]
    • system = "http://fhir.patientsknowbest.com/codesystem/privacy-label"
Coding.code value mappings (PKB → FHIR):
  • GENERAL_HEALTH → GENERAL_HEALTH
  • MENTAL_HEALTH → MENTAL_HEALTH
  • SEXUAL_HEALTH → SEXUAL_HEALTH
  • SOCIAL_CARE → SOCIAL_CARE