STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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

6.5.7 Resource Provenance - Detailed Descriptions

Detailed Descriptions for the elements in the Provenance resource.

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 may impact security, privacy, and trust policies.

Control1..1
Alternate NamesHistory; Event; Activity
Summarytrue
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 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.

Control1..*
TypeReference(Any)
Summarytrue
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.

Control0..1
TypePeriod
Summarytrue
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.

Control1..1
Typeinstant
Summarytrue
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.

Control0..*
BindingPurposeOfUse: The reason the activity took place. (Extensible)
TypeCoding
Summarytrue
Provenance.activity
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.

Control0..1
BindingProvenanceEventCurrentState: The activity that took place. (Extensible)
TypeCoding
Summarytrue
Provenance.location
Definition

Where the activity occurred, if relevant.

Control0..1
TypeReference(Location)
Summarytrue
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.

Control0..*
Typeuri
Summarytrue
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 actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

Control1..*
Requirements

An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

Summarytrue
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 function of the agent with respect to the activity.

Control1..1
BindingProvenanceParticipantRole: The role that a provenance agent played with respect to the activity. (Extensible)
TypeCoding
Summarytrue
Comments

For example, author, performer, enterer, attester, etc.

Provenance.agent.actor
Definition

The individual, device or organization that participated in the event.

Control0..1
TypeReference(Practitioner | RelatedPerson | Patient | Device | Organization)
Summarytrue
Provenance.agent.userId
Definition

The identity of the agent as known by the authorization system.

Control0..1
TypeIdentifier
Summarytrue
Provenance.agent.relatedAgent
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.

Control0..*
Summarytrue
Provenance.agent.relatedAgent.type
Definition

The type of relationship between agents.

Control1..1
Bindingv3 Code System RoleLinkType: Type of relationship between two provenance agents. (Example)
TypeCodeableConcept
Summarytrue
Provenance.agent.relatedAgent.target
Definition

An internal reference to another agent listed in this provenance by its identifier.

Control1..1
Typeuri
Summarytrue
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.

Control0..*
Summarytrue
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.

Control1..1
BindingProvenanceEntityRole: How an entity was used in an activity. (Required)
Typecode
Summarytrue
Provenance.entity.type
Definition

The type of the entity. If the entity is a resource, then this is a resource type.

Control1..1
BindingResourceType: The type of an entity used in an activity. (Extensible)
TypeCoding
Requirements

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.

Summarytrue
Provenance.entity.reference
Definition

Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

Control1..1
Typeuri
Summarytrue
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.

Control0..1
Typestring
Summarytrue
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.

Control0..1
TypeSee Provenance.agent
Summarytrue
Comments

Provenance.entity.agent is used in cases 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
Definition

A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

Control0..*
TypeSignature
Summarytrue