This page is part of the US Core (v3.0.1: STU3 Ballot 3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-us-core-provenance Profile.
1. Provenance | |
Definition | The US Core Provenance Profile is based upon the Argonaut Data Query requirements. |
Control | 0..* |
Alternate Names | History, Event, Activity, Basic Provenance |
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. |
Invariants | Defined on this element 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()) |
2. Provenance.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
3. Provenance.meta | |
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. |
Control | 0..1 |
Type | Meta |
4. Provenance.implicitRules | |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. |
5. Provenance.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages |
Type | code |
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). |
6. Provenance.text | |
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. |
Control | 0..1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
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. |
7. Provenance.contained | |
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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
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. |
8. Provenance.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
9. Provenance.modifierExtension | |
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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Alternate Names | extensions, user content |
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. |
10. Provenance.target | |
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. |
Control | 1..* |
Type | Reference(Resource) |
Must Support | true |
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. |
11. Provenance.occurred[x] | |
Definition | The period during which the activity occurred. |
Control | 0..1 |
Type | Choice of: Period, dateTime |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. |
12. Provenance.recorded | |
Definition | The instant of time at which the activity was recorded. |
Control | 1..1 |
Type | instant |
Must Support | true |
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. |
13. Provenance.policy | |
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. |
Control | 0..* |
Type | uri |
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. |
14. Provenance.location | |
Definition | Where the activity occurred, if relevant. |
Control | 0..1 |
Type | Reference(Location) |
15. Provenance.reason | |
Definition | The reason that the activity was taking place. |
Control | 0..* |
Binding | The reason the activity took place. The codes SHALL be taken from V3 Value SetPurposeOfUse; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
16. Provenance.activity | |
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. |
Control | 0..1 |
Binding | The activity that took place. The codes SHALL be taken from ProvenanceActivityType; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
17. Provenance.agent | |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Provenance.agent. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. Provenance.agent.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
19. Provenance.agent.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
20. Provenance.agent.modifierExtension | |
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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Alternate Names | extensions, user content, modifiers |
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. |
21. Provenance.agent.type | |
Definition | The participation the agent had with respect to the activity. |
Control | 0..1 |
Binding | The codes SHALL be taken from US Core Provenance Participant Type Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Comments | For example: author, performer, enterer, attester, etc. |
22. Provenance.agent.role | |
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. |
Control | 0..* |
Binding | The role that a provenance agent played with respect to the activity. For example codes, see SecurityRoleType |
Type | CodeableConcept |
Comments | For example: doctor, nurse, clerk, etc. |
23. Provenance.agent.who | |
Definition | The individual, device or organization that participated in the event. |
Control | 1..1 |
Type | Reference(USCorePractitionerProfile | USCorePractitionerRoleProfile | RelatedPerson | USCorePatientProfile | Device | USCoreOrganizationProfile) |
Must Support | true |
Comments | whoIdentity should be used when the agent is not a Resource type. |
24. Provenance.agent.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Control | 0..1 |
Type | Reference(USCoreOrganizationProfile) |
Must Support | true |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
Invariants | Defined on this element provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device (: ($this.agent.who.resolve().is Practitioner or Device) implies exists()) |
25. Provenance.agent:ProvenanceAuthor | |
SliceName | ProvenanceAuthor |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Provenance.agent:ProvenanceAuthor.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
27. Provenance.agent:ProvenanceAuthor.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
28. Provenance.agent:ProvenanceAuthor.modifierExtension | |
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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Alternate Names | extensions, user content, modifiers |
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. |
29. Provenance.agent:ProvenanceAuthor.type | |
Definition | The participation the agent had with respect to the activity. |
Control | 1..1 |
Binding | The type of participation that a provenance agent played with respect to the activity. The codes SHALL be taken from ProvenanceParticipantType; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Comments | For example: author, performer, enterer, attester, etc. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type"/> <code value="author"/> </coding> </valueCodeableConcept> |
30. Provenance.agent:ProvenanceAuthor.role | |
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. |
Control | 0..* |
Binding | The role that a provenance agent played with respect to the activity. For example codes, see SecurityRoleType |
Type | CodeableConcept |
Comments | For example: doctor, nurse, clerk, etc. |
31. Provenance.agent:ProvenanceAuthor.who | |
Definition | The individual, device or organization that participated in the event. |
Control | 1..1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Comments | whoIdentity should be used when the agent is not a Resource type. |
32. Provenance.agent:ProvenanceAuthor.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Control | 0..1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
33. Provenance.agent:ProvenanceTransmitter | |
SliceName | ProvenanceTransmitter |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Provenance.agent:ProvenanceTransmitter.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
35. Provenance.agent:ProvenanceTransmitter.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
36. Provenance.agent:ProvenanceTransmitter.modifierExtension | |
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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Alternate Names | extensions, user content, modifiers |
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. |
37. Provenance.agent:ProvenanceTransmitter.type | |
Definition | The participation the agent had with respect to the activity. |
Control | 1..1 |
Binding | The type of participation that a provenance agent played with respect to the activity. The codes SHALL be taken from ProvenanceParticipantType; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Comments | For example: author, performer, enterer, attester, etc. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type"/> <code value="transmitter"/> </coding> </valueCodeableConcept> |
38. Provenance.agent:ProvenanceTransmitter.role | |
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. |
Control | 0..* |
Binding | The role that a provenance agent played with respect to the activity. For example codes, see SecurityRoleType |
Type | CodeableConcept |
Comments | For example: doctor, nurse, clerk, etc. |
39. Provenance.agent:ProvenanceTransmitter.who | |
Definition | The individual, device or organization that participated in the event. |
Control | 1..1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Comments | whoIdentity should be used when the agent is not a Resource type. |
40. Provenance.agent:ProvenanceTransmitter.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Control | 0..1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
41. Provenance.entity | |
Definition | An entity used in this activity. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. Provenance.entity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
43. Provenance.entity.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
44. Provenance.entity.modifierExtension | |
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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Alternate Names | extensions, user content, modifiers |
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. |
45. Provenance.entity.role | |
Definition | How the entity was used during the activity. |
Control | 1..1 |
Binding | How an entity was used in an activity. The codes SHALL be taken from ProvenanceEntityRole |
Type | code |
46. Provenance.entity.what | |
Definition | Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. |
Control | 1..1 |
Type | Reference(Resource) |
Comments | whatIdentity should be used for entities that are not a Resource type. |
47. Provenance.entity.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. |
Control | 0..* |
Type | See Provenance.agent:ProvenanceTransmitter |
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. |
48. Provenance.signature | |
Definition | A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. |
Control | 0..* |
Type | Signature |