# Provenance

Canonical page: https://docs.ovok.com/api/fhir/r4/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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-target"></span>`target` | [Reference](/fhir-elements/complex/reference) | `1..*` | Target Reference(s) (usually version specific) |
| <span id="element-occurred-x"></span>`occurred[x]` | [Period](/fhir-elements/complex/period), [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When the activity occurred |
| <span id="element-recorded"></span>`recorded` | [instant](/fhir-elements/primitive/instant) | `1..1` | When the activity was recorded / updated |
| <span id="element-policy"></span>`policy` | [uri](/fhir-elements/primitive/uri) | `0..*` | Policy or plan the activity was defined by |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..1` | Where the activity occurred, if relevant |
| <span id="element-reason"></span>`reason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Reason the activity is occurring |
| <span id="element-activity"></span>`activity` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Activity that occurred |
| <span id="element-agent"></span>`agent` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..*` | Actor involved |
| <span id="element-entity"></span>`entity` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | An entity used in this activity |
| <span id="element-signature"></span>`signature` | [Signature](/fhir-elements/complex/signature) | `0..*` | Signature on target |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [Provenance](https://hl7.org/fhir/R4/provenance.html).  
Maturity: Trial Use 3 (FMM 3).
