Record a FHIR Provenance resource to document the source, author, and data lineage of a created or updated FHIR resource

In-depth guide

Steps

1. After creating or updating a target resource, construct a Provenance resource with target referencing the target resource (e.g., Provenance.target = [{reference: 'Observation/123'}])
2. Set recorded to the current timestamp (FHIR instant), and activity to a code from the W3C PROV or HL7 provenance activity codes (e.g., CREATE, UPDATE, TRANSFORM)
3. Populate agent[] with at least one agent: type (role of the agent — author, custodian, transmitter), who (reference to Practitioner, Device, Organization, or Patient), and optionally onBehalfOf
4. If the data was derived from an external source, add entity[] with role=derivation or role=source and what referencing the source document or system
5. POST the Provenance to [base]/Provenance; consider including it in the same transaction Bundle as the target resource creation so both succeed or fail atomically
6. To query provenance later, use GET [base]/Provenance?target=[ResourceType]/[id] or use _revinclude=Provenance:target on the target resource query