Skip to main content

Provenance

PropertyValue
Publisher
NameProvenance
URLhttp://hl7.org/fhir/StructureDefinition/Provenance
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Provenance0..*ProvenanceProvenance 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.
Provenance.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Provenance.meta0..1MetaThe 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.
Provenance.implicitRules0..1uriA 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.
Provenance.language0..1codeThe base language in which the resource is written.
Provenance.text0..1NarrativeA 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.
Provenance.contained0..*ResourceThese 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.
Provenance.extension0..*ExtensionMay 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.
Provenance.modifierExtension0..*ExtensionMay 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).
Provenance.target1..*ReferenceThe 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.
Provenance.occurred[x]0..1PeriodThe period during which the activity occurred.
Provenance.recorded1..1instantThe instant of time at which the activity was recorded.
Provenance.policy0..*uriPolicy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
Provenance.location0..1ReferenceWhere the activity occurred, if relevant.
Provenance.reason0..*CodeableConceptThe reason that the activity was taking place.
Provenance.activity0..1CodeableConceptAn 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.
Provenance.agent1..*BackboneElementAn actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
Provenance.agent.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Provenance.agent.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
Provenance.agent.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Provenance.agent.type0..1CodeableConceptThe participation the agent had with respect to the activity.
Provenance.agent.role0..*CodeableConceptThe function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
Provenance.agent.who1..1ReferenceThe individual, device or organization that participated in the event.
Provenance.agent.onBehalfOf0..1ReferenceThe individual, device, or organization for whom the change was made.
Provenance.entity0..*BackboneElementAn entity used in this activity.
Provenance.entity.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Provenance.entity.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
Provenance.entity.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Provenance.entity.role1..1codeHow the entity was used during the activity.
Provenance.entity.what1..1ReferenceIdentity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
Provenance.entity.agent0..*ProvenanceThe 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.
Provenance.signature0..*SignatureA digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
agentreferenceWho participatedProvenance.agent.who
agent-roletokenWhat the agents role wasProvenance.agent.role
agent-typetokenHow the agent participatedProvenance.agent.type
entityreferenceIdentity of entityProvenance.entity.what
locationreferenceWhere the activity occurred, if relevantProvenance.location
patientreferenceTarget Reference(s) (usually version specific)Provenance.target.where(resolve() is Patient)
recordeddateWhen the activity was recorded / updatedProvenance.recorded
signature-typetokenIndication of the reason the entity signed the object(s)Provenance.signature.type
targetreferenceTarget Reference(s) (usually version specific)Provenance.target
whendateWhen the activity occurred(Provenance.occurred.ofType(dateTime))
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value