Wales FHIR Implementation Guide

DataStandardsWales-Provenance

Overview

The Provenance resource tracks information about the activity that created, revised, deleted, or signed a version of a resource, describing the entities and agents involved.

The DataStandardsWales-Provenance profile is derived from the HL7 R4 Provenance. It defines additional rules for use within health and care organisations in Wales.

A direct link to the Data Standards Wales asset can be accessed here - Data Standards Wales Provenance

Formal Views of Profile Content

Snapshot View
Differential View
Hybrid View
Examples

DataStandardsWalesProvenance (Provenance)	I		Provenance	There are no (further) constraints on this element Element id Provenance Short description Who, What, When for a set of resources Alternate names History, Event, Activity 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. 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. Data type Provenance Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act workflow: Event rim: ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN] w3c.prov: Activity
id	Σ	0..1	string	There are no (further) constraints on this element Element id Provenance.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Provenance.meta Short description Metadata about the resource Definition 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Provenance.implicitRules Short description A set of rules under which this content was created Definition 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. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Provenance.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition 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. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Provenance.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition 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. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	Element id Provenance.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
extensionDataStandardsWalesDemographicsAsRecorded	I	0..1	Extension(Complex)	Element id Provenance.extension:extensionDataStandardsWalesDemographicsAsRecorded Short description Demographics as recorded Alternate names extensions, user content Definition Demographics details recorded as at the time of the care record change Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(Complex) Extension URL https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DemographicsAsRecorded Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A rim: n/a
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
target	S Σ	1..*	Reference(Resource)	There are no (further) constraints on this element Element id Provenance.target Short description Target Reference(s) (usually version specific) 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. 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. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: ./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player fhirauditevent: AuditEvent.entity.reference w3c.prov: Entity Created/Updated
occurred[x]		0..1		There are no (further) constraints on this element Element id Provenance.occurred[x] Short description When the activity occurred Definition The period during which the activity occurred. Comments The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurred[x] w5: FiveWs.done[x] rim: ./effectiveTime[type=IVL_TS] w3c.prov: Activity.startTime & Activity.endTime
occurredPeriod			Period	There are no (further) constraints on this element Data type Period
occurredDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
recorded	S Σ	1..1	instant	There are no (further) constraints on this element Element id Provenance.recorded Short description When the activity was recorded / updated Definition The instant of time at which the activity was recorded. 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. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS]) fhirauditevent: AuditEvent.recorded w3c.prov: Activity.when
policy		0..*	uri	There are no (further) constraints on this element Element id Provenance.policy Short description Policy or plan the activity was defined by 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel fhirauditevent: AuditEvent.agent.policy
location		0..1	Reference(DataStandardsWalesLocation)	Element id Provenance.location Short description Where the activity occurred, if relevant Definition Where the activity occurred, if relevant. Data type Reference(DataStandardsWalesLocation) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.location w5: FiveWs.where[x] rim: unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"] fhirauditevent: AuditEvent.agent.location w3c.prov: Activity.location
reason		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Provenance.reason Short description Reason the activity is occurring Definition The reason that the activity was taking place. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonCode w5: FiveWs.why[x] rim: unique(./reasonCode) fhirauditevent: AuditEvent.purposeOfEvent w3c.prov: Activity.Activity
activity		0..1	CodeableConceptBinding	Element id Provenance.activity Short description Activity that occurred 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. Data type CodeableConcept Binding The activity that took place. DataStandardsWalesProvenanceActivity (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.code w5: FiveWs.why[x] rim: Act.code w3c.prov: Activity.Activity
agent	S	1..*	BackboneElement	There are no (further) constraints on this element Element id Provenance.agent Short description Actor involved Definition An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer w5: FiveWs.who rim: ./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV'] fhirauditevent: AuditEvent.agent w3c.prov: Agent
id		0..1	string	There are no (further) constraints on this element Element id Provenance.agent.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.agent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.agent.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Provenance.agent.type Short description How the agent participated Definition The participation the agent had with respect to the activity. Comments For example: author, performer, enterer, attester, etc. Data type CodeableConcept Binding The type of participation that a provenance agent played with respect to the activity. ProvenanceParticipantType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.function rim: .role fhirauditevent: AuditEvent.agent.type w3c.prov: Agent.Attribution
role		0..*	CodeableConcept	There are no (further) constraints on this element Element id Provenance.agent.role Short description What the agents role was Definition The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. Comments For example: doctor, nurse, clerk, etc. Data type CodeableConcept Binding The role that a provenance agent played with respect to the activity. SecurityRoleType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .typecode fhirauditevent: AuditEvent.agent.role
who	Σ	1..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson)	Element id Provenance.agent.who Short description Who participated Definition The individual, device or organization that participated in the event. Comments whoIdentity should be used when the agent is not a Resource type. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.actor w5: FiveWs.actor rim: .id
onBehalfOf		0..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson)	Element id Provenance.agent.onBehalfOf Short description Who the agent is representing Definition The individual, device, or organization for whom the change was made. Comments onBehalfOfIdentity should be used when the agent is not a Resource type. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]
entity		0..*	BackboneElement	There are no (further) constraints on this element Element id Provenance.entity Short description An entity used in this activity Definition An entity used in this activity. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf fhirauditevent: AuditEvent.entity w3c.prov: Entity
id		0..1	string	There are no (further) constraints on this element Element id Provenance.entity.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.entity.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.entity.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
role	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Provenance.entity.role Short description derivation \| revision \| quotation \| source \| removal Definition How the entity was used during the activity. Data type code Binding How an entity was used in an activity. ProvenanceEntityRole (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./typeCode fhirauditevent: AuditEvent.entity.lifecycle w3c.prov: Entity.role
what	Σ	1..1	Reference(Resource)	There are no (further) constraints on this element Element id Provenance.entity.what Short description Identity of entity Definition Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. Comments whatIdentity should be used for entities that are not a Resource type. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./text/reference fhirauditevent: AuditEvent.entity.reference w3c.prov: Entity.Identity
agent		0..*	see (agent)	There are no (further) constraints on this element Element id Provenance.entity.agent Short description Entity is attributed to this 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. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./author/role
signature	S	0..*	Signature	There are no (further) constraints on this element Element id Provenance.signature Short description Signature on target Definition A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. Data type Signature Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./signatureText
id		0..1	string	There are no (further) constraints on this element Element id Provenance.signature.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.signature.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
type	Σ	1..*	CodingBinding	There are no (further) constraints on this element Element id Provenance.signature.type Short description Indication of the reason the entity signed the object(s) Definition An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. Comments Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". Data type Coding Binding An indication of the reason that an entity signed the object. SignatureTypeCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
when	Σ	1..1	instant	There are no (further) constraints on this element Element id Provenance.signature.when Short description When the signature was created Definition When the digital signature was signed. Comments This should agree with the information in the signature. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
who	Σ	1..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization)	Element id Provenance.signature.who Short description Who signed Definition A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). Comments This should agree with the information in the signature. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
onBehalfOf	Σ	0..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization)	Element id Provenance.signature.onBehalfOf Short description The party represented Definition A reference to an application-usable description of the identity that is represented by the signature. Requirements used when the signature is on behalf of a non-signer. Comments The party that can't sign. For example a child. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
targetFormat		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.signature.targetFormat Short description The technical format of the signed resources Definition A mime type that indicates the technical format of the target resources signed by the signature. Comments "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
sigFormat		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.signature.sigFormat Short description The technical format of the signature Definition A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
data		0..1	base64Binary	There are no (further) constraints on this element Element id Provenance.signature.data Short description The actual signature content (XML DigSig. JWS, picture, etc.) Definition The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. Comments Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

DataStandardsWalesProvenance (Provenance)	I		Provenance	There are no (further) constraints on this element Element id Provenance Short description Who, What, When for a set of resources Alternate names History, Event, Activity 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. 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. Data type Provenance Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act workflow: Event rim: ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN] w3c.prov: Activity
id	Σ	0..1	string	There are no (further) constraints on this element Element id Provenance.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Provenance.meta Short description Metadata about the resource Definition 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Provenance.implicitRules Short description A set of rules under which this content was created Definition 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. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Provenance.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition 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. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Provenance.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition 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. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	Element id Provenance.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
extensionDataStandardsWalesDemographicsAsRecorded	I	0..1	Extension(Complex)	Element id Provenance.extension:extensionDataStandardsWalesDemographicsAsRecorded Short description Demographics as recorded Alternate names extensions, user content Definition Demographics details recorded as at the time of the care record change Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(Complex) Extension URL https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DemographicsAsRecorded Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A rim: n/a
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
target	S Σ	1..*	Reference(Resource)	There are no (further) constraints on this element Element id Provenance.target Short description Target Reference(s) (usually version specific) 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. 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. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: ./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player fhirauditevent: AuditEvent.entity.reference w3c.prov: Entity Created/Updated
occurred[x]		0..1		There are no (further) constraints on this element Element id Provenance.occurred[x] Short description When the activity occurred Definition The period during which the activity occurred. Comments The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurred[x] w5: FiveWs.done[x] rim: ./effectiveTime[type=IVL_TS] w3c.prov: Activity.startTime & Activity.endTime
occurredPeriod			Period	There are no (further) constraints on this element Data type Period
occurredDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
recorded	S Σ	1..1	instant	There are no (further) constraints on this element Element id Provenance.recorded Short description When the activity was recorded / updated Definition The instant of time at which the activity was recorded. 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. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS]) fhirauditevent: AuditEvent.recorded w3c.prov: Activity.when
policy		0..*	uri	There are no (further) constraints on this element Element id Provenance.policy Short description Policy or plan the activity was defined by 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel fhirauditevent: AuditEvent.agent.policy
location		0..1	Reference(DataStandardsWalesLocation)	Element id Provenance.location Short description Where the activity occurred, if relevant Definition Where the activity occurred, if relevant. Data type Reference(DataStandardsWalesLocation) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.location w5: FiveWs.where[x] rim: unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"] fhirauditevent: AuditEvent.agent.location w3c.prov: Activity.location
reason		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Provenance.reason Short description Reason the activity is occurring Definition The reason that the activity was taking place. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonCode w5: FiveWs.why[x] rim: unique(./reasonCode) fhirauditevent: AuditEvent.purposeOfEvent w3c.prov: Activity.Activity
activity		0..1	CodeableConceptBinding	Element id Provenance.activity Short description Activity that occurred 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. Data type CodeableConcept Binding The activity that took place. DataStandardsWalesProvenanceActivity (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.code w5: FiveWs.why[x] rim: Act.code w3c.prov: Activity.Activity
agent	S	1..*	BackboneElement	There are no (further) constraints on this element Element id Provenance.agent Short description Actor involved Definition An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer w5: FiveWs.who rim: ./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV'] fhirauditevent: AuditEvent.agent w3c.prov: Agent
id		0..1	string	There are no (further) constraints on this element Element id Provenance.agent.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.agent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.agent.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Provenance.agent.type Short description How the agent participated Definition The participation the agent had with respect to the activity. Comments For example: author, performer, enterer, attester, etc. Data type CodeableConcept Binding The type of participation that a provenance agent played with respect to the activity. ProvenanceParticipantType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.function rim: .role fhirauditevent: AuditEvent.agent.type w3c.prov: Agent.Attribution
role		0..*	CodeableConcept	There are no (further) constraints on this element Element id Provenance.agent.role Short description What the agents role was Definition The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. Comments For example: doctor, nurse, clerk, etc. Data type CodeableConcept Binding The role that a provenance agent played with respect to the activity. SecurityRoleType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .typecode fhirauditevent: AuditEvent.agent.role
who	Σ	1..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson)	Element id Provenance.agent.who Short description Who participated Definition The individual, device or organization that participated in the event. Comments whoIdentity should be used when the agent is not a Resource type. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.actor w5: FiveWs.actor rim: .id
onBehalfOf		0..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson)	Element id Provenance.agent.onBehalfOf Short description Who the agent is representing Definition The individual, device, or organization for whom the change was made. Comments onBehalfOfIdentity should be used when the agent is not a Resource type. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]
entity		0..*	BackboneElement	There are no (further) constraints on this element Element id Provenance.entity Short description An entity used in this activity Definition An entity used in this activity. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf fhirauditevent: AuditEvent.entity w3c.prov: Entity
id		0..1	string	There are no (further) constraints on this element Element id Provenance.entity.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.entity.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.entity.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
role	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Provenance.entity.role Short description derivation \| revision \| quotation \| source \| removal Definition How the entity was used during the activity. Data type code Binding How an entity was used in an activity. ProvenanceEntityRole (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./typeCode fhirauditevent: AuditEvent.entity.lifecycle w3c.prov: Entity.role
what	Σ	1..1	Reference(Resource)	There are no (further) constraints on this element Element id Provenance.entity.what Short description Identity of entity Definition Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. Comments whatIdentity should be used for entities that are not a Resource type. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./text/reference fhirauditevent: AuditEvent.entity.reference w3c.prov: Entity.Identity
agent		0..*	see (agent)	There are no (further) constraints on this element Element id Provenance.entity.agent Short description Entity is attributed to this 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. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./author/role
signature	S	0..*	Signature	There are no (further) constraints on this element Element id Provenance.signature Short description Signature on target Definition A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. Data type Signature Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./signatureText
id		0..1	string	There are no (further) constraints on this element Element id Provenance.signature.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.signature.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
type	Σ	1..*	CodingBinding	There are no (further) constraints on this element Element id Provenance.signature.type Short description Indication of the reason the entity signed the object(s) Definition An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. Comments Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". Data type Coding Binding An indication of the reason that an entity signed the object. SignatureTypeCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
when	Σ	1..1	instant	There are no (further) constraints on this element Element id Provenance.signature.when Short description When the signature was created Definition When the digital signature was signed. Comments This should agree with the information in the signature. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
who	Σ	1..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization)	Element id Provenance.signature.who Short description Who signed Definition A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). Comments This should agree with the information in the signature. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
onBehalfOf	Σ	0..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization)	Element id Provenance.signature.onBehalfOf Short description The party represented Definition A reference to an application-usable description of the identity that is represented by the signature. Requirements used when the signature is on behalf of a non-signer. Comments The party that can't sign. For example a child. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
targetFormat		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.signature.targetFormat Short description The technical format of the signed resources Definition A mime type that indicates the technical format of the target resources signed by the signature. Comments "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
sigFormat		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.signature.sigFormat Short description The technical format of the signature Definition A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
data		0..1	base64Binary	There are no (further) constraints on this element Element id Provenance.signature.data Short description The actual signature content (XML DigSig. JWS, picture, etc.) Definition The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. Comments Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

DataStandardsWalesProvenance (Provenance)	I		Provenance	There are no (further) constraints on this element Element id Provenance Short description Who, What, When for a set of resources Alternate names History, Event, Activity 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. 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. Data type Provenance Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act workflow: Event rim: ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN] w3c.prov: Activity
id	Σ	0..1	string	There are no (further) constraints on this element Element id Provenance.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Provenance.meta Short description Metadata about the resource Definition 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Provenance.implicitRules Short description A set of rules under which this content was created Definition 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. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Provenance.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition 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. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Provenance.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition 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. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	Element id Provenance.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
extensionDataStandardsWalesDemographicsAsRecorded	I	0..1	Extension(Complex)	Element id Provenance.extension:extensionDataStandardsWalesDemographicsAsRecorded Short description Demographics as recorded Alternate names extensions, user content Definition Demographics details recorded as at the time of the care record change Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(Complex) Extension URL https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DemographicsAsRecorded Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A rim: n/a
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
target	S Σ	1..*	Reference(Resource)	There are no (further) constraints on this element Element id Provenance.target Short description Target Reference(s) (usually version specific) 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. 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. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: ./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player fhirauditevent: AuditEvent.entity.reference w3c.prov: Entity Created/Updated
occurred[x]		0..1		There are no (further) constraints on this element Element id Provenance.occurred[x] Short description When the activity occurred Definition The period during which the activity occurred. Comments The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurred[x] w5: FiveWs.done[x] rim: ./effectiveTime[type=IVL_TS] w3c.prov: Activity.startTime & Activity.endTime
occurredPeriod			Period	There are no (further) constraints on this element Data type Period
occurredDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
recorded	S Σ	1..1	instant	There are no (further) constraints on this element Element id Provenance.recorded Short description When the activity was recorded / updated Definition The instant of time at which the activity was recorded. 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. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS]) fhirauditevent: AuditEvent.recorded w3c.prov: Activity.when
policy		0..*	uri	There are no (further) constraints on this element Element id Provenance.policy Short description Policy or plan the activity was defined by 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel fhirauditevent: AuditEvent.agent.policy
location		0..1	Reference(DataStandardsWalesLocation)	Element id Provenance.location Short description Where the activity occurred, if relevant Definition Where the activity occurred, if relevant. Data type Reference(DataStandardsWalesLocation) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.location w5: FiveWs.where[x] rim: unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"] fhirauditevent: AuditEvent.agent.location w3c.prov: Activity.location
reason		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Provenance.reason Short description Reason the activity is occurring Definition The reason that the activity was taking place. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonCode w5: FiveWs.why[x] rim: unique(./reasonCode) fhirauditevent: AuditEvent.purposeOfEvent w3c.prov: Activity.Activity
activity		0..1	CodeableConceptBinding	Element id Provenance.activity Short description Activity that occurred 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. Data type CodeableConcept Binding The activity that took place. DataStandardsWalesProvenanceActivity (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.code w5: FiveWs.why[x] rim: Act.code w3c.prov: Activity.Activity
agent	S	1..*	BackboneElement	There are no (further) constraints on this element Element id Provenance.agent Short description Actor involved Definition An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer w5: FiveWs.who rim: ./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV'] fhirauditevent: AuditEvent.agent w3c.prov: Agent
id		0..1	string	There are no (further) constraints on this element Element id Provenance.agent.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.agent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.agent.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Provenance.agent.type Short description How the agent participated Definition The participation the agent had with respect to the activity. Comments For example: author, performer, enterer, attester, etc. Data type CodeableConcept Binding The type of participation that a provenance agent played with respect to the activity. ProvenanceParticipantType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.function rim: .role fhirauditevent: AuditEvent.agent.type w3c.prov: Agent.Attribution
role		0..*	CodeableConcept	There are no (further) constraints on this element Element id Provenance.agent.role Short description What the agents role was Definition The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. Comments For example: doctor, nurse, clerk, etc. Data type CodeableConcept Binding The role that a provenance agent played with respect to the activity. SecurityRoleType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .typecode fhirauditevent: AuditEvent.agent.role
who	Σ	1..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson)	Element id Provenance.agent.who Short description Who participated Definition The individual, device or organization that participated in the event. Comments whoIdentity should be used when the agent is not a Resource type. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.actor w5: FiveWs.actor rim: .id
onBehalfOf		0..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson)	Element id Provenance.agent.onBehalfOf Short description Who the agent is representing Definition The individual, device, or organization for whom the change was made. Comments onBehalfOfIdentity should be used when the agent is not a Resource type. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization \| DataStandardsWalesRelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]
entity		0..*	BackboneElement	There are no (further) constraints on this element Element id Provenance.entity Short description An entity used in this activity Definition An entity used in this activity. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf fhirauditevent: AuditEvent.entity w3c.prov: Entity
id		0..1	string	There are no (further) constraints on this element Element id Provenance.entity.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.entity.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.entity.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
role	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Provenance.entity.role Short description derivation \| revision \| quotation \| source \| removal Definition How the entity was used during the activity. Data type code Binding How an entity was used in an activity. ProvenanceEntityRole (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./typeCode fhirauditevent: AuditEvent.entity.lifecycle w3c.prov: Entity.role
what	Σ	1..1	Reference(Resource)	There are no (further) constraints on this element Element id Provenance.entity.what Short description Identity of entity Definition Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. Comments whatIdentity should be used for entities that are not a Resource type. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./text/reference fhirauditevent: AuditEvent.entity.reference w3c.prov: Entity.Identity
agent		0..*	see (agent)	There are no (further) constraints on this element Element id Provenance.entity.agent Short description Entity is attributed to this 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. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./author/role
signature	S	0..*	Signature	There are no (further) constraints on this element Element id Provenance.signature Short description Signature on target Definition A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. Data type Signature Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./signatureText
id		0..1	string	There are no (further) constraints on this element Element id Provenance.signature.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Provenance.signature.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
type	Σ	1..*	CodingBinding	There are no (further) constraints on this element Element id Provenance.signature.type Short description Indication of the reason the entity signed the object(s) Definition An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. Comments Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". Data type Coding Binding An indication of the reason that an entity signed the object. SignatureTypeCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
when	Σ	1..1	instant	There are no (further) constraints on this element Element id Provenance.signature.when Short description When the signature was created Definition When the digital signature was signed. Comments This should agree with the information in the signature. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
who	Σ	1..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization)	Element id Provenance.signature.who Short description Who signed Definition A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). Comments This should agree with the information in the signature. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
onBehalfOf	Σ	0..1	Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization)	Element id Provenance.signature.onBehalfOf Short description The party represented Definition A reference to an application-usable description of the identity that is represented by the signature. Requirements used when the signature is on behalf of a non-signer. Comments The party that can't sign. For example a child. Data type Reference(DataStandardsWalesPractitioner \| DataStandardsWalesPractitionerRole \| DataStandardsWalesRelatedPerson \| DataStandardsWalesPatient \| DataStandardsWalesDevice \| DataStandardsWalesOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
targetFormat		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.signature.targetFormat Short description The technical format of the signed resources Definition A mime type that indicates the technical format of the target resources signed by the signature. Comments "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
sigFormat		0..1	codeBinding	There are no (further) constraints on this element Element id Provenance.signature.sigFormat Short description The technical format of the signature Definition A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
data		0..1	base64Binary	There are no (further) constraints on this element Element id Provenance.signature.data Short description The actual signature content (XML DigSig. JWS, picture, etc.) Definition The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. Comments Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

Example Provenance record linked to a Patient demographic update as result of an HL7v2 patient demographic update

Example Provenance record with multiple targets e.g. for growth chart observations

Example Provenance record showing the DemographicsAsRecorded extension

Mandatory and Must Support Data Elements

Refer to the Mandatory and Must Support page for guidance on how these elements should be interpreted.

Each Provenance must have:

One or more targets
A recorded timestamp
One or more agents

Each Provenance must support:

One or more entities if relevant

Implementation Guidance

The Provenance.agent field SHOULD include all agents involved in the activity. Typical agents include

Devices such as software systems or components
Clinical devices
Human users

The Provenance.entity field MAY be used to indicate one or more entities in this activity, and may be used to refer, for example, to an HL7v2 message used to update demographic information within a Patient resource.

The Provenance.recorded field SHALL be include a timestamp to indicate when the activity was recorded/updated.

The Provenance.target field SHALL be populated to reference the FHIR resource(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.

Please see the Provenance page within the Guidance section for further information.

Extensions

Some use cases require the original demographic data at time of recording to stored directly against the clinical data e.g. for diagnostic reports in Wales. This additional provenace can be captured using the DataStandardsWales-DemographicsAsRecorded extension.