Provenance
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Provenance/[id] |
| Vread | GET | /fhir/R4/Provenance/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Provenance/[id] |
| Patch | PATCH | /fhir/R4/Provenance/[id] |
| Delete | DELETE | /fhir/R4/Provenance/[id] |
| Create | POST | /fhir/R4/Provenance |
| Search | GET | /fhir/R4/Provenance |
| History | GET | /fhir/R4/Provenance/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
target | Reference | 1..* | Target Reference(s) (usually version specific) |
occurred[x] | Period, dateTime | 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 |
entity | BackboneElement | 0..* | An entity used in this activity |
signature | Signature | 0..* | Signature on target |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
agent | reference | Who participated |
agent-role | token | What the agents role was |
agent-type | token | How the agent participated |
entity | reference | Identity of entity |
location | reference | Where the activity occurred, if relevant |
patient | reference | Target Reference(s) (usually version specific) |
recorded | date | When the activity was recorded / updated |
signature-type | token | Indication of the reason the entity signed the object(s) |
target | reference | Target Reference(s) (usually version specific) |
when | date | When the activity occurred |
Reference
Official FHIR R4 spec: Provenance.
Maturity: Trial Use 3 (FMM 3).