Common
Class Provenance

"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." - HL7 FHIR, Provenance

Attributes
«CS» Code activity activity

"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." - HL7 FHIR, Provenance.activity

ProvenanceAgent agent agent

"An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place." - HL7 FHIR, Provenance.agent

ProvenanceEntity entity entity

"An entity used in this activity." - HL7 FHIR, Provenance.entity

Location location location

"Where the activity occurred, if relevant." - HL7 FHIR, Provenance.location

«IVL_TS» Period occurred occurred

"The period during which the activity occurred." - HL7 FHIR, Provenance.occurred[x]

String policy policy

"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." - HL7 FHIR, Provenance.policy

«CS» Code reason reason

"The reason that the activity was taking place." - HL7 FHIR, Provenance.reason

«TS» PointInTime recorded recorded

"The instant of time at which the activity was recorded." - HL7 FHIR, Provenance.recorded

Signature signature signature

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

«ANY» Any target target

"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." - HL7 FHIR, Provenance.target


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameProvenance
Name Expression
NamespaceCommon
Owned Template Signature
OwnerCommon
Owning Template Parameter
PackageCommon
Qualified NameFHIM::Common::Provenance
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 activity
Public «CS» Code activity

"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." - HL7 FHIR, Provenance.activity

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameactivity
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::activity
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 agent
Public ProvenanceAgent agent

"An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place." - HL7 FHIR, Provenance.agent

Constraints:
Properties:

AggregationNone
Alias
Associationprovenance_agent
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
Nameagent
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::agent
Stereotype
Template Parameter
TypeProvenanceAgent
Upper*
Upper Value(*)
VisibilityPublic


 entity
Public ProvenanceEntity entity

"An entity used in this activity." - HL7 FHIR, Provenance.entity

Constraints:
Properties:

AggregationNone
Alias
Associationprovenance_entity
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameentity
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::entity
Stereotype
Template Parameter
TypeProvenanceEntity
Upper*
Upper Value(*)
VisibilityPublic


 location
Public Location location

"Where the activity occurred, if relevant." - HL7 FHIR, Provenance.location

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namelocation
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::location
Stereotype
Template Parameter
TypeLocation
Upper1
Upper Value(1)
VisibilityPublic


 occurred
Public «IVL_TS» Period occurred

"The period during which the activity occurred." - HL7 FHIR, Provenance.occurred[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameoccurred
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::occurred
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 policy
Public String policy

"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." - HL7 FHIR, Provenance.policy

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namepolicy
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::policy
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 reason
Public «CS» Code reason

"The reason that the activity was taking place." - HL7 FHIR, Provenance.reason

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namereason
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::reason
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 recorded
Public «TS» PointInTime recorded

"The instant of time at which the activity was recorded." - HL7 FHIR, Provenance.recorded

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namerecorded
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::recorded
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 signature
Public Signature signature

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namesignature
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::signature
Stereotype
Template Parameter
TypeSignature
Upper*
Upper Value(*)
VisibilityPublic


 target
Public «ANY» Any target

"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." - HL7 FHIR, Provenance.target

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProvenance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
Nametarget
Name Expression
NamespaceProvenance
Opposite
OwnerProvenance
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::Provenance::target
Stereotype
Template Parameter
Type«ANY» Any
Upper*
Upper Value(*)
VisibilityPublic