Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #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

Security Work GroupMaturity Level: 3 Trial UseSecurity Category: Not Classified Compartments: Device, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the Provenance resource.

Provenance
Element IdProvenance
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.

Cardinality0..*
TypeDomainResource
Alternate NamesHistory; Event; Activity
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
Element IdProvenance.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.

Cardinality1..*
TypeReference(Any)
Summarytrue
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 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.occurred[x]
Element IdProvenance.occurred[x]
Definition

The period during which the activity occurred.

Cardinality0..1
TypePeriod|dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

Provenance.recorded
Element IdProvenance.recorded
Definition

The instant of time at which the activity was recorded.

Cardinality1..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.policy
Element IdProvenance.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.

Cardinality0..*
Typeuri
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 IdProvenance.location
Definition

Where the activity occurred, if relevant.

Cardinality0..1
TypeReference(Location)
Provenance.reason
Element IdProvenance.reason
Definition

The reason that the activity was taking place.

Cardinality0..*
Terminology BindingV3 Value SetPurposeOfUse (Extensible)
TypeCodeableConcept
Provenance.activity
Element IdProvenance.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.

Cardinality0..1
Terminology BindingProvenance activity type (Extensible)
TypeCodeableConcept
Provenance.agent
Element IdProvenance.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.

Cardinality1..*
Requirements

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

Comments

Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.

Provenance.agent.type
Element IdProvenance.agent.type
Definition

The primary act of participation of the agent with respect to the activity.

Cardinality0..1
Terminology BindingProvenance participant type (Extensible)
TypeCodeableConcept
Requirements

Note: The .type of author could be .role of primary author. Note there are overlapping codes to be used in specific circumstances. See ISO 21298:2018 - Health Informatics - Functional and structural roles.

Summarytrue
Comments

For example: assembler, author, doctor, nurse, clerk, etc.

Provenance.agent.role
Element IdProvenance.agent.role
Definition

The functional or structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.

Cardinality0..*
Terminology BindingSecurityRoleType (Example)
TypeCodeableConcept
Requirements

Note: The .type of author could be .role of primary author. Note there are overlapping codes to be used in specific circumstances. See ISO 21298:2018 - Health Informatics - Functional and structural roles.

Comments

For example: PRIMAUTH, REVIEWER, VERF, etc.

Provenance.agent.who
Element IdProvenance.agent.who
Definition

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

Cardinality1..1
TypeReference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
PatternsReference(Practitioner,PractitionerRole,RelatedPerson,Patient,Device,Organization): Common patterns = Participant
Summarytrue
Comments

whoIdentity should be used when the agent is not a Resource type.

Provenance.agent.onBehalfOf
Element IdProvenance.agent.onBehalfOf
Definition

The individual, device, or organization for whom the change was made.

Cardinality0..1
TypeReference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
PatternsReference(Practitioner,PractitionerRole,RelatedPerson,Patient,Device,Organization): Common patterns = Participant
Comments

onBehalfOfIdentity should be used when the agent is not a Resource type.

Provenance.entity
Element IdProvenance.entity
Definition

An entity used in this activity.

Cardinality0..*
Provenance.entity.role
Element IdProvenance.entity.role
Definition

How the entity was used during the activity.

Cardinality1..1
Terminology BindingProvenanceEntityRole (Required)
Typecode
Summarytrue
Provenance.entity.what
Element IdProvenance.entity.what
Definition

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

Cardinality1..1
TypeReference(Any)
Summarytrue
Comments

whatIdentity should be used for entities that are not a Resource type.

Provenance.entity.agent
Element IdProvenance.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.

Cardinality0..*
TypeSee Provenance.agent
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 IdProvenance.signature
Definition

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

Cardinality0..*
TypeSignature