Skip to content

Provenance Profile

Canonical../StructureDefinition/nexus-emr-core-provenance
Statusdraft · 1.26.0
BaseProvenance (constraint)
SourceFSH · JSON

Attribution for AI-mediated and cross-boundary writes: 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.

Elements / Snapshot

The full effective definition: base Provenance with this profile's constraints applied.

Element Flags Card. Type Description & Constraints
Provenance 0..* Nexus EMR Provenance Core i
Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, provenance-target-required, provenance-ai-action-names-agent
id 0..1 http://hl7.org/fhirpath/System.String Logical id of this artifact i
meta 0..1 Meta Metadata about the resource
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
versionId 0..1 id Version specific identifier i
Invariants: ele-1
lastUpdated 0..1 instant When the resource version last changed i
Invariants: ele-1
source S 0..1 uri Identifies EMR instance & pipeline version the resource came from i
Invariants: ele-1
profile 0..* canonical Profiles this resource claims to conform to i
Invariants: ele-1
security 0..* Coding Security Labels applied to this resource i
Binding: security-labels (extensible)
Invariants: ele-1
tag 0..* Coding Tags applied to this resource i
Binding: common-tags (example)
Invariants: ele-1
implicitRules ?! 0..1 uri A set of rules under which this content was created i
Invariants: ele-1
language 0..1 code Language of the resource content i
Binding: languages (preferred)
Invariants: ele-1
text S 0..1 Narrative Narrative i
Invariants: ele-1
contained 0..* Resource Contained, inline Resources i
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
extension:attributedFact S 0..* Extension(Attributed Fact) Per-fact citations for AI-generated text (statement + verbatim quotes) i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored i
Invariants: ele-1, ext-1
target S 1..* Reference(Resource) The resource(s) this provenance describes i
Invariants: ele-1
occurred[x] S 0..1 Period, dateTime When the activity happened i
Invariants: ele-1
recorded S 1..1 instant When this provenance record was created i
Invariants: ele-1
policy 0..* uri Policy or plan the activity was defined by i
Invariants: ele-1
location 0..1 Reference(Location) Where the activity occurred, if relevant
Invariants: ele-1
reason 0..* CodeableConcept Reason the activity is occurring
Binding: v3-PurposeOfUse (extensible)
Invariants: ele-1
activity S 0..1 CodeableConcept What kind of activity produced the target i
Binding: provenance-activity-type (extensible)
Invariants: ele-1
agent S 1..* BackboneElement Who took part in the action i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
type S 1..1 CodeableConcept The agent's role (author, verifier, attester, ...) i
Binding: provenance-agent-type (extensible)
Invariants: ele-1
role 0..* CodeableConcept What the agents role was i
Binding: security-role-type (example)
Invariants: ele-1
who S 1..1 Reference(Practitioner Profile | PractitionerRole Profile | Patient Profile | RelatedPerson Profile | Organization Profile | App Device Profile | Device Profile) The agent itself -- Practitioner, Device (AI/system), Organization, Patient i
Invariants: ele-1
onBehalfOf S 0..1 Reference(Practitioner Profile | PractitionerRole Profile | Organization Profile) The party the agent acted for i
Invariants: ele-1
entity S 0..* BackboneElement The inputs the activity derived from -- for AI, the record context it was given i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
role S 1..1 code derivation | revision | quotation | source | removal
Binding: provenance-entity-role (required)
Invariants: ele-1
what S 1..1 Reference(Resource) The input resource i
Invariants: ele-1
agent 0..* Entity is attributed to this agent i
Invariants: ele-1
signature 0..* Signature Signature on target
Invariants: ele-1