This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
Responsible
Owner:
Security
Work
Group
|
|
Security Category : Not Classified | Compartments : Device , Group , Patient , Practitioner , RelatedPerson |
Detailed Descriptions for the elements in the Provenance resource.
| Provenance | |||||||||||||||||||||
| Element Id | Provenance | ||||||||||||||||||||
| Definition |
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
|
||||||||||||||||||||
| Short Display | Who, What, When for a set of resources | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | DomainResource | ||||||||||||||||||||
| Alternate Names | History; Event; Activity | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments |
Some
parties
|
||||||||||||||||||||
| Provenance.target | |||||||||||||||||||||
| Element Id | Provenance.target | ||||||||||||||||||||
| Definition |
The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. |
||||||||||||||||||||
| Short Display | Target Reference(s) (usually version specific) | ||||||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||||||
| Type | Reference ( Any ) | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
Target
references
are
usually
version
specific,
but
might
not
be,
if
a
version
has
not
been
assigned
or
if
the
provenance
information
is
part
of
the
set
of
resources
being
maintained
(i.e.
a
document).
When
using
the
RESTful
API,
the
identity
of
the
resource
might
not
be
known
(especially
not
the
version
specific
one);
the
client
|
||||||||||||||||||||
| Provenance.occurred[x] | |||||||||||||||||||||
| Element Id | Provenance.occurred[x] | ||||||||||||||||||||
| Definition |
The period during which the activity occurred. |
||||||||||||||||||||
| Short Display | When the activity occurred | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | Period | dateTime | ||||||||||||||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
The
period
can
be
a
little
arbitrary;
where
possible,
the
time
|
||||||||||||||||||||
| Provenance.recorded | |||||||||||||||||||||
| Element Id | Provenance.recorded | ||||||||||||||||||||
| Definition |
The date and time at which the provenance information was recorded / updated, whether in the FHIR Provenance resource or in some other form that is later communicated in the FHIR Provenance. |
||||||||||||||||||||
| Short Display | When the activity was recorded / updated | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | instant | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
This can be a little different from the lastUpdated on the Provenance resource if there is a delay between recording the event and updating the provenance and target resource. |
||||||||||||||||||||
| Provenance.policy | |||||||||||||||||||||
| Element Id | Provenance.policy | ||||||||||||||||||||
| Definition |
Policy
or
plan
the
activity
was
defined
by.
Typically,
a
single
activity
|
||||||||||||||||||||
| Short Display | Policy or plan the activity was defined by | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | uri | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments |
For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. |
||||||||||||||||||||
| Provenance.location | |||||||||||||||||||||
| Element Id | Provenance.location | ||||||||||||||||||||
| Definition |
Where the activity occurred. |
||||||||||||||||||||
| Short Display | Where the activity occurred | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | Reference ( Location ) | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Provenance.authorization | |||||||||||||||||||||
| Element Id | Provenance.authorization | ||||||||||||||||||||
| Definition |
The authorization (e.g., PurposeOfUse) that was used during the event being recorded. |
||||||||||||||||||||
| Short Display | Authorization (purposeOfUse) related to the event | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Terminology Binding |
PurposeOfUse
(
Example
)
|
||||||||||||||||||||
| Type | CodeableReference | ||||||||||||||||||||
| Requirements |
Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags. |
||||||||||||||||||||
| Alternate Names | PurposeOfEvent | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Provenance.why | |||||||||||||||||||||
| Element Id | Provenance.why | ||||||||||||||||||||
| Definition |
Describes why the event recorded in this provenenace occurred in textual form. |
||||||||||||||||||||
| Short Display | Why was the event performed? | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||
| Alternate Names | reason | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Provenance.activity | |||||||||||||||||||||
| Element Id | Provenance.activity | ||||||||||||||||||||
| Definition |
An
activity
is
something
that
occurs
over
a
period
of
time
and
acts
upon
or
with
entities;
it
|
||||||||||||||||||||
| Short Display | Activity that occurred | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Terminology Binding |
ValueSet
of
|
||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Provenance.basedOn | |||||||||||||||||||||
| Element Id | Provenance.basedOn | ||||||||||||||||||||
| Definition |
A plan, proposal or order that is fulfilled in whole or in part by this provenance. |
||||||||||||||||||||
| Short Display | Workflow authorization within which this event occurred | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | Reference ( Any ) | ||||||||||||||||||||
| Requirements |
Allows tracing of authorization for the provenance and tracking whether proposals/recommendations were acted upon. |
||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Provenance.patient | |||||||||||||||||||||
| Element Id | Provenance.patient | ||||||||||||||||||||
| Definition |
The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity. |
||||||||||||||||||||
| Short Display | The patient is the subject of the data created/updated (.target) by the activity | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | Reference ( Patient ) | ||||||||||||||||||||
| Requirements |
When
the
.patient
is
populated
it
|
||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Provenance.encounter | |||||||||||||||||||||
| Element Id | Provenance.encounter | ||||||||||||||||||||
| Definition |
This
will
typically
be
the
encounter
the
event
occurred,
but
some
events
|
||||||||||||||||||||
| Short Display | Encounter within which this event occurred or which the event is tightly associated | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | Reference ( Encounter ) | ||||||||||||||||||||
| Requirements |
Links the provenance to the Encounter context. May also affect access control. |
||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments |
This
will
typically
be
the
encounter
the
provenance
was
created
during,
but
some
provenances
|
||||||||||||||||||||
| Provenance.agent | |||||||||||||||||||||
| Element Id | Provenance.agent | ||||||||||||||||||||
| Definition |
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
||||||||||||||||||||
| Short Display | Actor involved | ||||||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||||||
| Requirements |
An
agent
can
be
a
person,
an
organization,
software,
device,
or
other
entities
that
|
||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
Several
agents
|
||||||||||||||||||||
| Constraints |
|
||||||||||||||||||||
| Provenance.agent.type | |||||||||||||||||||||
| Element Id | Provenance.agent.type | ||||||||||||||||||||
| Definition |
The Functional Role of the agent with respect to the activity. |
||||||||||||||||||||
| Short Display | How the agent participated | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Terminology Binding | Participation Role Type ( Example ) | ||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||
| Requirements |
Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models. |
||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
For example: assembler, author, prescriber, signer, investigator, etc. |
||||||||||||||||||||
| Provenance.agent.role | |||||||||||||||||||||
| Element Id | Provenance.agent.role | ||||||||||||||||||||
| Definition |
The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity. |
||||||||||||||||||||
| Short Display | What the agents role was | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Terminology Binding | Example Security Role Type ( Example ) | ||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||
| Requirements |
Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.. |
||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments |
For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc. |
||||||||||||||||||||
| Provenance.agent.who | |||||||||||||||||||||
| Element Id | Provenance.agent.who | ||||||||||||||||||||
| Definition |
Indicates who or what performed in the event. |
||||||||||||||||||||
| Short Display | The agent that participated in the event | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Type | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Constraints |
|
||||||||||||||||||||
| Provenance.agent.onBehalfOf | |||||||||||||||||||||
| Element Id | Provenance.agent.onBehalfOf | ||||||||||||||||||||
| Definition |
The agent that delegated authority to perform the activity performed by the agent.who element. |
||||||||||||||||||||
| Short Display | The agent that delegated | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService ) | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Constraints |
|
||||||||||||||||||||
| Provenance.entity | |||||||||||||||||||||
| Element Id | Provenance.entity | ||||||||||||||||||||
| Definition |
An entity used in this activity. |
||||||||||||||||||||
| Short Display | An entity used in this activity | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Provenance.entity.role | |||||||||||||||||||||
| Element Id | Provenance.entity.role | ||||||||||||||||||||
| Definition |
How the entity was used during the activity. |
||||||||||||||||||||
| Short Display | revision | quotation | source | instantiates | removal | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Terminology Binding | Provenance Entity Role ( Required ) | ||||||||||||||||||||
| Type | code | ||||||||||||||||||||
| Meaning if Missing | No role declared or available. | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Provenance.entity.what | |||||||||||||||||||||
| Element Id | Provenance.entity.what | ||||||||||||||||||||
| Definition |
Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. |
||||||||||||||||||||
| Short Display | Identity of entity | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Type | Reference ( Any ) | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
The
what.identifier
|
||||||||||||||||||||
| Provenance.entity.agent | |||||||||||||||||||||
| Element Id | Provenance.entity.agent | ||||||||||||||||||||
| Definition |
The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which used the entity. |
||||||||||||||||||||
| Short Display | Entity is attributed to this agent | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | See Provenance.agent | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments |
A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity. |
||||||||||||||||||||
| Provenance.signature | |||||||||||||||||||||
| Element Id | Provenance.signature | ||||||||||||||||||||
| Definition |
A
digital
signature
on
the
target
Reference(s).
The
signer
|
||||||||||||||||||||
| Short Display | Signature on target | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | Signature | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||