Trial Use 4
Foundation
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.
Endpoints
devhttps://api.sandbox.ovok.com/fhir/R5/Provenance
| Interaction | Method | Path |
|---|
| Read | GET | /fhir/R5/Provenance/[id] |
| Vread | GET | /fhir/R5/Provenance/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Provenance/[id] |
| Patch | PATCH | /fhir/R5/Provenance/[id] |
| Delete | DELETE | /fhir/R5/Provenance/[id] |
| Create | POST | /fhir/R5/Provenance |
| Search | GET | /fhir/R5/Provenance?... |
| History | GET | /fhir/R5/Provenance/[id]/_history |
| Type-history | GET | /fhir/R5/Provenance/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|
target | Reference | 1..* | Target Reference(s) (usually version specific) |
occurred[x] | Period / dateTime | 0..1 | When the activity occurred |
recorded | instant | 0..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 |
authorization | CodeableReference | 0..* | Authorization (purposeOfUse) related to the event |
activity | CodeableConcept | 0..1 | Activity that occurred |
basedOn | Reference | 0..* | Workflow authorization within which this event occurred |
patient | Reference | 0..1 | The patient is the subject of the data created/updated (.target) by the activity |
encounter | Reference | 0..1 | Encounter within which this event occurred or which the event is tightly associated |
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 |
|---|
activity | token | Activity that occurred |
agent | reference | Who participated |
agent-role | token | What the agents role was |
agent-type | token | How the agent participated |
based-on | reference | Reference to the service request. |
encounter | reference | Encounter related to the activity recorded in the AuditEvent |
| | |
entity | reference | Identity of entity |
location | reference | Where the activity occurred, if relevant |
patient | reference | The entity that caused the expenses |
| | |
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 R5 spec:
Provenance
- Maturity: Trial Use 4 (FMM 4).