Provenance class
Provenance Provenance of a resource is a record that describes entities
- Mixed-in types
- Annotations
-
- @freezed
Constructors
-
Provenance({@Default(R4ResourceType.Provenance) @JsonKey(unknownEnumValue: R4ResourceType.Provenance) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, required List<Reference> target, Period? occurredPeriod, FhirDateTime? occurredDateTime, @JsonKey(name: '_occurredDateTime') Element? occurredDateTimeElement, FhirInstant? recorded, @JsonKey(name: '_recorded') Element? recordedElement, List<FhirUri> ? policy, @JsonKey(name: '_policy') List<Element?> ? policyElement, Reference? location, List<CodeableConcept> ? reason, CodeableConcept? activity, required List<ProvenanceAgent> agent, List<ProvenanceEntity> ? entity, List<Signature> ? signature}) -
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.
constfactory
-
Provenance.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Provenance.fromJsonString(String source)
-
Acts like a constructor, returns a Provenance, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Provenance.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- activity → CodeableConcept?
-
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.no setterinherited -
agent
→ List<
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.no setterinherited -
contained
→ List<
Resource> ? -
contained
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.no setterinherited -
copyWith
→ $ProvenanceCopyWith<
Provenance> -
no setterinherited
- dbId → int?
-
no setterinherited
-
entity
→ List<
ProvenanceEntity> ? -
entity
An entity used in this activity.no setterinherited -
extension_
→ List<
FhirExtension> ? -
extension_
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.no setterinherited - fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.no setterinherited - implicitRulesElement → Element?
-
implicitRulesElement
Extensions for implicitRulesno setterinherited - language → FhirCode?
-
language
The base language in which the resource is written.no setterinherited - languageElement → Element?
-
languageElement
Extensions for languageno setterinherited - location → Reference?
-
location
Where the activity occurred, if relevant.no setterinherited - meta → FhirMeta?
-
meta
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.no setterinherited -
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).no setterinherited - occurredDateTime → FhirDateTime?
-
occurredDateTime
The period during which the activity occurred.no setterinherited - occurredDateTimeElement → Element?
-
occurredDateTimeElement
Extensions for occurredDateTimeno setterinherited - occurredPeriod → Period?
-
occurredPeriod
The period during which the activity occurred.no setterinherited - path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
policy
→ List<
FhirUri> ? -
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.no setterinherited -
policyElement
→ List<
Element?> ? -
policyElement
Extensions for policyno setterinherited -
reason
→ List<
CodeableConcept> ? -
reason
The reason that the activity was taking place.no setterinherited - recorded → FhirInstant?
-
recorded
The instant of time at which the activity was recorded.no setterinherited - recordedElement → Element?
-
recordedElement
Extensions for recordedno setterinherited - resourceType → R4ResourceType
-
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
signature
→ List<
Signature> ? -
signature
A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.no setterinherited -
target
→ List<
Reference> -
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.no setterinherited - text → Narrative?
-
text
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.no setterinherited - thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited