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

Provenance

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

FHIR Provenance Resource

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

Overview

The Provenance resource is the mechanism by which PKB will return source information.

Currently, this is only supported for instances of [[Data Point]].

Relevant Entities

Endpoints

None.

Provenance resources can only be returned as contained resources.

Mappings

FHIRPKBNotes
Resource idN/A 
Provenance.target
A Reference to the data for which the Provenance applies.
  • target: Reference
    • reference = the relative URL of the resource

Provenance.recorded[[Data Point.Persisted Timestamp]] 
Provenance.agent
  • agent: BackboneElement
    • whoReference = onBehalfOfReference (until we fully support secondary provenance, set whoReference to match onBehalfOfReference by default)
    • onBehalfOfReference: Reference <conditional>
    • If Source Person is present: <conditional>
      • If Source Person is a Professional:
        • reference = the relative URL of the Practitioner resource
        • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
      • Else if Source Person is a Patient: <conditional>
        • If Provenance.target references data in the same Patient's account:
          • reference = the relative URL of the Patient resource
          • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
        • Else:
          • reference = a reference to a contained RelatedPerson instance (see RelatedPerson mappings)
          • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
    • Else if Source Team is present:
      • reference = the relative URL of the Organization of the [[Team]]
      • display = [[Team.Name]]
    • Else if Source Org is present:
      • reference = the relative URL of the Organization of the [[Organisation]]
      • display = [[Organisation.Name]]
    • Else if Source Text is not blank: 
      • display = [[Source.Source Text]]
    • Else:
      • display = "No source information available"
 
Comments