Skip to main content

Provenance

Trial Use 3 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​

alphahttps://api.dev.ovok.com/fhir/R4/Provenance
InteractionMethodPath
ReadGET/fhir/R4/Provenance/[id]
VreadGET/fhir/R4/Provenance/[id]/_history/[vid]
UpdatePUT/fhir/R4/Provenance/[id]
PatchPATCH/fhir/R4/Provenance/[id]
DeleteDELETE/fhir/R4/Provenance/[id]
CreatePOST/fhir/R4/Provenance
SearchGET/fhir/R4/Provenance
HistoryGET/fhir/R4/Provenance/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
targetReference1..*Target Reference(s) (usually version specific)
occurred[x]Period / dateTime0..1When the activity occurred
recordedinstant1..1When the activity was recorded / updated
policyuri0..*Policy or plan the activity was defined by
locationReference0..1Where the activity occurred, if relevant
reasonCodeableConcept0..*Reason the activity is occurring
activityCodeableConcept0..1Activity that occurred
agentBackboneElement1..*Actor involved
entityBackboneElement0..*An entity used in this activity
signatureSignature0..*Signature on target

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
agentstringhttp://hl7.org/fhir/SearchParameter/Provenance-agent
agent-rolestringhttp://hl7.org/fhir/SearchParameter/Provenance-agent-role
agent-typestringhttp://hl7.org/fhir/SearchParameter/Provenance-agent-type
entitystringhttp://hl7.org/fhir/SearchParameter/Provenance-entity
locationstringhttp://hl7.org/fhir/SearchParameter/Provenance-location
patientstringhttp://hl7.org/fhir/SearchParameter/Provenance-patient
recordedstringhttp://hl7.org/fhir/SearchParameter/Provenance-recorded
signature-typestringhttp://hl7.org/fhir/SearchParameter/Provenance-signature-type
targetstringhttp://hl7.org/fhir/SearchParameter/Provenance-target
whenstringhttp://hl7.org/fhir/SearchParameter/Provenance-when

Reference​

  • Official FHIR R4 spec: Provenance
  • Maturity: Trial Use 3 (FMM 3).