Skip to content

Provenance Profile

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-emr-core-provenance
Statusdraft · 1.33.0
BaseProvenance (constraint)
SourceFSH · JSON

Attribution for AI-mediated writes, cross-boundary writes and record-lifecycle events such as linking an arriving result to a chart or entering a resource into the record: what was produced, when, by which agent (human or non-human), from what inputs, and -- for generated text -- which verbatim source passage each statement rests on. Used standalone against a produced resource, and contained in an AI-suggestion review Task against the suggestion contained alongside it.

Salient fields

The profile's synthesized-accessor contract: fields TypedFhir surfaces as first-class typed properties, each computed from the instance by a restricted FHIRPath expression. See Salient Fields for what they are, how they shape LLM contexts, and how to declare them.

Key Type Expression Rendered as Description
activity coded activity What kind of activity produced the target i
date dateTime occurredDateTime \| occurredPeriod.start \| recorded When the activity happened i

activity

Short What kind of activity produced the target
Definition An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
Comments Bound EXTENSIBLE by the base, to provenance-activity-type, and a profile cannot unbind it. That value set has no concept for AI-mediated authorship or for linking a record to a chart, so it is not asserted for either. For AI-mediated activity the examples carry activity.text. LINKING IS CODED: where a record is linked to its target -- an arriving result or document attached to a patient's chart -- activity carries the ISO 21089 record-lifecycle event link (or unlink) from http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle, which any reader can interpret, and the nexus-link-method extension on activity says how: automatic, confirmed or manual. A validator warns that the ISO code is not in the extensible value set; that warning is expected. The method is required wherever the event is present and cannot appear without it (nexus-prov-link-method, nexus-prov-link-method-event). For a link or unlink, target SHOULD be version-specific -- the version that carries the resulting subject -- so that correcting a misfiled record (an unlink from the wrong target, then a link to the right one, each with its own method) shows which chart the record left. What the match was made on and how confident the matcher was are not part of the method; carry them in activity.text.
Expression activity
Type coded
Prose inherited from Provenance.activity

date

Short When the activity happened
Definition The period during which the activity occurred.
Comments Preferred over recorded as THE date. A provenance written asynchronously (a queued write-back) has a recorded well after the action; dating the action to the bookkeeping timestamp misplaces it in every timeline.
Expression occurredDateTime | occurredPeriod.start | recorded
Type dateTime
Prose inherited from Provenance.occurred[x]