The Provenance resource implements the FHIR R4 Provenance specification and US Core v3.1.1 Provenance profile

Fields

Name Type Cardinality Required Description
target Reference 1..* * Target Reference(s) (usually version specific)
occuredPeriod Period 0..1   When the activity occurred
occuredDateTime date 0..1   When the activity occurred
recorded instant 1..1 * When the activity was recorded / updated
policy uri 0..*   Policy or plan the activity was defined by
location Reference 0..1   Where the activity occurred, if relevant
reason CodeableConcept 0..*   Reason the activity is occurring
activity CodeableConcept 0..1   Activity that occurred
agent BackboneElement 1..* * Actor involved
agent.type CodeableConcept 0..*   How the agent participated - Binding (see Profiles for details)
agent.who Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) 1..1 * Who participated
agent.onBehalfOf Reference(US Core Organization Profile) 0..1   Who the agent is representing (see Profiles for details)
entity BackboneElement 0..*   An entity used in this activity
signature Signature 0..*   Indicates if the individual is deceased or not

Interactions

Read

Get an Provenance entry by id

GET /Provenance/:id

Query Provenance resources

GET /Provenance?:query_parameters

Parameters

Errors

Code Description
400 Invalid parameters
404 Resource not found

Profiles

Per the US Core profile the author and transmitter Provenance agents are encoded as follows:

  • author: system=http://terminology.hl7.org/CodeSystem/provenance-participant-type, code=author
  • transmitter: system=http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type, code=transmitter