This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
FHIR Infrastructure Work Group |
Informative | Use Context: Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/provenance-relevant-history
This profile is provided for guidance purposes only. There is no expectation that implementers must adhere to this profile. It is included in the specification to help implementers understand how they might use Provenance to satisfy the typical needs envisioned by the 'relevantHistory' elements found in various Event and Request resources. This profile identifies the data elements most likely to be relevant to implementers who are using Provenance to convey the `relevant history` of a resource, as discussed in the [request pattern](request.html#history). For the purposes of this profile, mustSupport should be interpreted as 'SHOULD be considered for population and SHOULD be understood by consumers.' Implementers are not obligated to handle all of these element and are not prohibited from also making use of additional data elements
This profile was published on Sat, Nov 1, 2025 00:00+0000 with unknown status 'active" by Health Level Seven International.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Provenance.
Summary
Mandatory: 3 elements (+2 nested mandatory elements)
Must-Support: 9 elements
Slices
This structure defines the following Slices:
This indicates the differences between this profile and the base Provenance structure.
Name ![]() | Flags ![]() | Card. ![]() | Type ![]() | Description & Constraints ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
S | 1..* | Reference(Resource) | Resource version |
![]() ![]() |
S | 1..1 | dateTime | When the activity occurred |
![]() ![]() |
S | 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event |
![]() ![]() |
S | 1..1 | CodeableConcept | Record activity Binding: Provenance History Record Activity Codes (extensible): Types of activities that are relevant for tracking event history using Provenance. |
![]() ![]() |
S | 1..* | BackboneElement | Who was involved with change Slice: Unordered, Open by value:type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Event History Agent Role Codes (extensible): Types of roles that agents can play when tracking event history using Provenance. |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Author |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the agent participated Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AUT | |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService) | Author Reference |
![]() | ||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Provenance structure.
Name ![]() | Flags ![]() | Card. ![]() | Type ![]() | Description & Constraints ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: All Languages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Reference(Resource) | Resource version | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | When the activity occurred | ||||
![]() ![]() |
Σ | 0..1 | instant | When the activity was recorded / updated | ||||
![]() ![]() |
0..* | uri | Policy or plan the activity was defined by | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the activity occurred | |||||
![]() ![]() |
S | 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | ||||
![]() ![]() |
0..1 | markdown | Why was the event performed? | |||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Record activity Binding: Provenance History Record Activity Codes (extensible): Types of activities that are relevant for tracking event history using Provenance. | ||||
![]() ![]() |
0..* | Reference(Resource) | Workflow authorization within which this event occurred | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
![]() ![]() |
SΣC ![]() |
1..* | BackboneElement | Who was involved with change Slice: Unordered, Open by value:type | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Event History Agent Role Codes (extensible): Types of roles that agents can play when tracking event history using Provenance. | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: Security Role Type (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
ΣC ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService) | The agent that participated in the event | ||||
![]() ![]() ![]() ![]() |
C ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService) | The agent that delegated | ||||
![]() ![]() ![]() |
SΣC ![]() |
0..1 | BackboneElement | Author | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Event History Agent Role Codes (extensible): Types of roles that agents can play when tracking event history using Provenance. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AUT | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: Security Role Type (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
SΣC ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService) | Author Reference | ||||
![]() ![]() ![]() ![]() |
C ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService) | The agent that delegated | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | An entity used in this activity | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: Provenance Entity Role (required): How an entity was used in an activity. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
![]() ![]() ![]() |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
![]() ![]() |
0..* | Signature | Signature on target | |||||
![]() | ||||||||
<!-- ProvenanceRelevantHistory --><Provenance xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <target><!-- I 1..* Reference(Resource) Resource version --></target> <occurredDateTime value="[dateTime]"/><!-- I 1..1 When the activity occurred --> <recorded value="[instant]"/><!-- I 0..1 When the activity was recorded / updated --> <policy value="[uri]"/><!-- I 0..* Policy or plan the activity was defined by --> <location><!-- I 0..1 Reference(Location) Where the activity occurred --></location> <authorization><!-- I 0..* CodeableReference Authorization (purposeOfUse) related to the event
--></authorization> <why value="[markdown]"/><!-- I 0..1 Why was the event performed? --> <activity><!-- I 1..1 CodeableConcept Record activity --></activity> <basedOn><!-- I 0..* Reference(Resource) Workflow authorization within which this event occurred --></basedOn> <patient><!-- I 0..1 Reference(Patient) The patient is the subject of the data created/updated (.target) by the activity --></patient> <encounter><!-- I 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated --></encounter> <-- agent sliced by value:type in the specified orderOpen--> <agent> I 0..1 BackboneElement <!-- I 0..1 Author --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type><!-- I 1..1 CodeableConcept How the agent participated --></type> <role><!-- I 0..* CodeableConcept What the agents role was --></role> <who><!-- I 1..1 Reference(Practitioner) Author Reference --></who> <onBehalfOf><!-- I 0..1 Reference(Practitioner) The agent that delegated --></onBehalfOf> </agent> <entity> I 0..* BackboneElement <!-- I 0..* An entity used in this activity --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <role value="[code]"/><!-- I 1..1 revision | quotation | source | instantiates | removal --> <what><!-- I 1..1 Reference(Resource) Identity of entity --></what> <agent><!-- See http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent Entity is attributed to this agent --></agent> </entity> <signature><!-- I 0..* Signature Signature on target --></signature> </Provenance>
{ // ProvenanceRelevantHistory
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"target" : [{ Reference(Resource) }], // I R! Resource version
"occurredDateTime" : "<dateTime>", // I R! When the activity occurred
"recorded" : "<instant>", // IWhen the activity was recorded / updated
"policy" : ["<uri>"], // IPolicy or plan the activity was defined by
"location" : { Reference(Location) }, // IWhere the activity occurred
"authorization" : [{ CodeableReference }], // IAuthorization (purposeOfUse) related to the event
"why" : "<markdown>", // IWhy was the event performed?
"activity" : { CodeableConcept }, // I R! Record activity
"basedOn" : [{ Reference(Resource) }], // IWorkflow authorization within which this event occurred
"patient" : { Reference(Patient) }, // IThe patient is the subject of the data created/updated (.target) by the activity
"encounter" : { Reference(Encounter) }, // IEncounter within which this event occurred or which the event is tightly associated
"agent" : [ // sliced by value:type in the specified order, Open
{ // Author // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
"type" : { CodeableConcept }, // I R! How the agent participated
"role" : [{ CodeableConcept }], // IWhat the agents role was
"who" : { Reference(Practitioner) }, // I R! Author Reference
"onBehalfOf" : { Reference(Practitioner) } // IThe agent that delegated
}
],
"entity" : [{ BackboneElement }], // IAn entity used in this activity
"signature" : [{ Signature }], // ISignature on target
}
This structure is derived from Provenance.
Summary
Mandatory: 3 elements (+2 nested mandatory elements)
Must-Support: 9 elements
Slices
This structure defines the following Slices:
Differential View
This indicates the differences between this profile and the base Provenance structure.
Name ![]() | Flags ![]() | Card. ![]() | Type ![]() | Description & Constraints ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
S | 1..* | Reference(Resource) | Resource version |
![]() ![]() |
S | 1..1 | dateTime | When the activity occurred |
![]() ![]() |
S | 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event |
![]() ![]() |
S | 1..1 | CodeableConcept | Record activity Binding: Provenance History Record Activity Codes (extensible): Types of activities that are relevant for tracking event history using Provenance. |
![]() ![]() |
S | 1..* | BackboneElement | Who was involved with change Slice: Unordered, Open by value:type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Event History Agent Role Codes (extensible): Types of roles that agents can play when tracking event history using Provenance. |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Author |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the agent participated Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AUT | |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService) | Author Reference |
![]() | ||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Provenance structure.
Name ![]() | Flags ![]() | Card. ![]() | Type ![]() | Description & Constraints ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: All Languages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Reference(Resource) | Resource version | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | When the activity occurred | ||||
![]() ![]() |
Σ | 0..1 | instant | When the activity was recorded / updated | ||||
![]() ![]() |
0..* | uri | Policy or plan the activity was defined by | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the activity occurred | |||||
![]() ![]() |
S | 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | ||||
![]() ![]() |
0..1 | markdown | Why was the event performed? | |||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Record activity Binding: Provenance History Record Activity Codes (extensible): Types of activities that are relevant for tracking event history using Provenance. | ||||
![]() ![]() |
0..* | Reference(Resource) | Workflow authorization within which this event occurred | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
![]() ![]() |
SΣC ![]() |
1..* | BackboneElement | Who was involved with change Slice: Unordered, Open by value:type | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Event History Agent Role Codes (extensible): Types of roles that agents can play when tracking event history using Provenance. | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: Security Role Type (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
ΣC ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService) | The agent that participated in the event | ||||
![]() ![]() ![]() ![]() |
C ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService) | The agent that delegated | ||||
![]() ![]() ![]() |
SΣC ![]() |
0..1 | BackboneElement | Author | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Event History Agent Role Codes (extensible): Types of roles that agents can play when tracking event history using Provenance. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AUT | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: Security Role Type (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
SΣC ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService) | Author Reference | ||||
![]() ![]() ![]() ![]() |
C ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService) | The agent that delegated | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | An entity used in this activity | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: Provenance Entity Role (required): How an entity was used in an activity. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
![]() ![]() ![]() |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
![]() ![]() |
0..* | Signature | Signature on target | |||||
![]() | ||||||||
XML Template
<!-- ProvenanceRelevantHistory --><Provenance xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <target><!-- I 1..* Reference(Resource) Resource version --></target> <occurredDateTime value="[dateTime]"/><!-- I 1..1 When the activity occurred --> <recorded value="[instant]"/><!-- I 0..1 When the activity was recorded / updated --> <policy value="[uri]"/><!-- I 0..* Policy or plan the activity was defined by --> <location><!-- I 0..1 Reference(Location) Where the activity occurred --></location> <authorization><!-- I 0..* CodeableReference Authorization (purposeOfUse) related to the event
--></authorization> <why value="[markdown]"/><!-- I 0..1 Why was the event performed? --> <activity><!-- I 1..1 CodeableConcept Record activity --></activity> <basedOn><!-- I 0..* Reference(Resource) Workflow authorization within which this event occurred --></basedOn> <patient><!-- I 0..1 Reference(Patient) The patient is the subject of the data created/updated (.target) by the activity --></patient> <encounter><!-- I 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated --></encounter> <-- agent sliced by value:type in the specified orderOpen--> <agent> I 0..1 BackboneElement <!-- I 0..1 Author --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type><!-- I 1..1 CodeableConcept How the agent participated --></type> <role><!-- I 0..* CodeableConcept What the agents role was --></role> <who><!-- I 1..1 Reference(Practitioner) Author Reference --></who> <onBehalfOf><!-- I 0..1 Reference(Practitioner) The agent that delegated --></onBehalfOf> </agent> <entity> I 0..* BackboneElement <!-- I 0..* An entity used in this activity --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <role value="[code]"/><!-- I 1..1 revision | quotation | source | instantiates | removal --> <what><!-- I 1..1 Reference(Resource) Identity of entity --></what> <agent><!-- See http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent Entity is attributed to this agent --></agent> </entity> <signature><!-- I 0..* Signature Signature on target --></signature> </Provenance>
JSON Template
{ // ProvenanceRelevantHistory
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"target" : [{ Reference(Resource) }], // I R! Resource version
"occurredDateTime" : "<dateTime>", // I R! When the activity occurred
"recorded" : "<instant>", // IWhen the activity was recorded / updated
"policy" : ["<uri>"], // IPolicy or plan the activity was defined by
"location" : { Reference(Location) }, // IWhere the activity occurred
"authorization" : [{ CodeableReference }], // IAuthorization (purposeOfUse) related to the event
"why" : "<markdown>", // IWhy was the event performed?
"activity" : { CodeableConcept }, // I R! Record activity
"basedOn" : [{ Reference(Resource) }], // IWorkflow authorization within which this event occurred
"patient" : { Reference(Patient) }, // IThe patient is the subject of the data created/updated (.target) by the activity
"encounter" : { Reference(Encounter) }, // IEncounter within which this event occurred or which the event is tightly associated
"agent" : [ // sliced by value:type in the specified order, Open
{ // Author // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
"type" : { CodeableConcept }, // I R! How the agent participated
"role" : [{ CodeableConcept }], // IWhat the agents role was
"who" : { Reference(Practitioner) }, // I R! Author Reference
"onBehalfOf" : { Reference(Practitioner) } // IThe agent that delegated
}
],
"entity" : [{ BackboneElement }], // IAn entity used in this activity
"signature" : [{ Signature }], // ISignature on target
}
Alternate definitions: Master Definition (XML, JSON), Schematron
| Path | Name | Conformance | ValueSet |
| Provenance.language | All Languages | required | All Languages |
| Provenance.authorization | PurposeOfUse | example | PurposeOfUse |
| Provenance.activity | Provenance History Record Activity Codes | extensible | Provenance History Record Activity Codes |
| Provenance.agent.type | Provenance Event History Agent Role Codes | extensible | Provenance Event History Agent Role Codes |
| Provenance.agent.role | Security Role Type | example | Security Role Type |
| Provenance.agent.type | Provenance Event History Agent Role Codes | extensible | Provenance Event History Agent Role Codes |
| Provenance.agent.role | Security Role Type | example | Security Role Type |
| Provenance.entity.role | Provenance Entity Role | required | Provenance Entity Role |