This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Formal
definitions
Detailed
Descriptions
for
the
elements
in
the
Provenance
resource.
| Provenance | |
| Definition |
Provenance
|
| Control | 1..1 |
| Alternate Names | History; Event; Activity |
| Summary | true |
| Comments |
Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance. |
| Provenance.target | |
| Definition |
The
|
| Control | 1..* |
| Type |
|
| Summary | true |
| Comments |
Target references are usually version specific, but may 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 may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion. |
| Provenance.period | |
| Definition |
The period during which the activity occurred. |
| Control | 0..1 |
| Type | Period |
| Summary | true |
| Comments |
The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. |
| Provenance.recorded | |
| Definition |
The instant of time at which the activity was recorded. |
| Control | 1..1 |
| Type | instant |
| Summary | true |
| Comments |
This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource. |
| Provenance.reason | |
| Definition |
The reason that the activity was taking place. |
| Control |
|
| Binding | PurposeOfUse: The reason the activity took place. ( Extensible ) |
| Type | CodeableConcept |
| Summary | true |
|
|
|
| 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. |
| Control | 0..1 |
| Binding | ProvenanceEventCurrentState: The activity that took place. ( Extensible ) |
| Type | CodeableConcept |
| Summary | true |
| Provenance.location | |
| Definition |
Where the activity occurred, if relevant. |
| Control | 0..1 |
| Type |
|
| Summary | true |
| Provenance.policy | |
| Definition |
Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. |
| Control | 0..* |
| Type | uri |
| Summary | true |
| 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.agent | |
| Definition |
An
agent
takes
a
role
in
an
activity
such
that
the
agent
can
be
assigned
some
degree
of
responsibility
for
the
activity
taking
place.
An
agent
can
be
a
person,
|
| Control | 0..* |
| Summary | true |
| Comments |
Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
| Provenance.agent.role | |
| Definition |
The
|
| Control | 1..1 |
| Binding |
|
| Type | Coding |
| Summary | true |
| Comments | For example, author, performer, enterer, attester, etc. |
|
|
|
| Definition |
The
|
| Control |
|
|
|
|
|
|
true |
| Provenance.agent.userId | |
|
|
The
identity
of
|
| Control | 0..1 |
| Type | Identifier |
| Summary | true |
|
|
|
| Definition | A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest. |
| Control | 0..* |
| Summary | true |
| Provenance.agent.relatedAgent.type | |
| Definition |
The
type
of
|
| Control | 1..1 |
| Binding | v3 Code System RoleLinkType: Type of relationship between two provenance agents. ( Example ) |
| Type |
|
|
|
|
|
|
|
| Definition |
An internal reference to another agent listed in this provenance by its identifier. |
| Control |
|
| Type |
|
| Summary | true |
| Comments | The uri has the form #[id] where [id] is on another Provenance.agent in this same resource. |
| Provenance.entity | |
| Definition |
An entity used in this activity. |
| Control | 0..* |
| Summary | true |
| Comments | Multiple userIds may be associated with the same Practitioner or other individual across various appearances, each with distinct privileges. |
| Provenance.entity.role | |
| Definition |
How the entity was used during the activity. |
| Control | 1..1 |
| Binding |
ProvenanceEntityRole:
How
an
entity
was
used
in
an
|
| Type | code |
| Summary | true |
| Provenance.entity.type | |
| Definition |
The type of the entity. If the entity is a resource, then this is a resource type. |
| Control | 1..1 |
| Binding |
|
| Type | Coding |
|
|
If the type is "resource" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant. |
| Summary | true |
| Provenance.entity.reference | |
| Definition |
Identity
of
|
| Control | 1..1 |
| Type | uri |
| Summary | true |
| Comments |
Identity may be a reference to a resource or to something else, depending on the type. |
| Provenance.entity.display | |
| Definition |
Human-readable description of the entity. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| 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 generated the entity. |
| Control | 0..1 |
| Type | See Provenance.agent |
| Summary | true |
|
|
|
| Definition |
A
digital
signature
on
the
target
|
| Control |
|
| Type |
|
|
|
|