Scope and Usage
All resources in a system have a provenance; each resource was created via some activity by one or more agents, potentially using other resources as the input to that activity. Provenance resources record that information.
In the context of the allele model, Provenance resources are attached to Contextual and Canonical Alleles. The Provenance of a Contextual Allele describes how how that Contextual Allele came to be loaded into the implementing system. The Provenance of a Canonical Allele provides information on the canonicalization process that aggregated the associated Contextual Alleles.
Note that a Provenance resource may have multiple targets, implying that multiple alleles may share a Provenance resource. For instance, if a script loads alleles into a system, that single activity may create multiple allele instances. These alleles may then share a Provenance resource, or each may have its own Provenance, which contains the same information. This choice is left to the discretion of the implementing system.
The ClinGen Provenance model is a simplification of the FHIR provenance model, which is in turn based on the W3C Provenance model. In the FHIR model, the Provenance resource fills the role of the Activity in W3C. FHIR entities linked to the provenance via the entity attribute are, in the W3C parlance, the used entities. See FHIR Provenance Resource and W3C Provenance.
Resource Model
Defintions & Bindings
Provenance
- Definition
- Resource representing the origin of a Contextual Allele or Canonical Allele
- Control
- 1..1
Provenance.target
- Definition
- The set of resources that were created by the activities described in this Provenance resource.
- Type
- CanonicalAllele or ContextualAllele
- Control
- 1..*
Provenance.period
- Definition
- The time period over which the target resource was created.
- Type
- FHIR Period
- Control
- 1..1
Provenance.recorded
- Definition
- The instant time at which provenance was recorded.
- Type
- dateTime
- Control
- 1..1
Provenance.reason
- Definition
- The reason the activity was taking place.
- Type
- CodeableConcept
- Control
- 0..1
Provenance.entity
- Definition
- An entity that was used in the activity
- Control
- 0..*
Provenance.entity.role
- Definition
- The role fulfilled by an entity in an activity
- Type
- Code
- Control
- 1
Schema
schema: Provenance.xsd
Examples
| id | name |
|---|