Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B

6.3.12.2 StructureDefinition: ProvenanceRelevantHistory

Patient Administration FHIR Infrastructure icon Work Group Informative Maturity Level Use Context : N/A 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.

Standards Status

6.3.12.2.1 Formal Views of Profile Content

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 : Informative

  • The element Provenance.agent is sliced based on the value of value:type

This indicates the differences between this profile and the base Provenance structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icondocoicon
.. Provenance 0..* Compartments : Encounter , Patient , Provenance Who, What, When for a set of resources
... target S 1 .. * Reference ( Resource ) Resource version
... occurred[x] S 1..1 dateTime When the activity occurred
... authorization S 0 .. * CodeableReference () Authorization (purposeOfUse) related to the event
... activity 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.
... Slices for agent S 1 .. * BackboneElement Who was involved with change
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... type 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.
.... agent:Author S 0..1 BackboneElement Author
..... type S 1..1 CodeableConcept How the agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AUT
..... who S 1..1 Reference ( Practitioner , | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) Author Reference

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Provenance structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icondocoicon
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages ( required ) : IETF language tag for a human language
Additional Bindings Purpose
Common Languages Starter
Raw Turtle
. . . text (+ also see Turtle/RDF Format Specification 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
... target S Σ 1..* Reference ( Resource ) Resource version
... occurred[x] S Σ 1..1 dateTime When the activity occurred
... recorded Σ 0..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference ( Location ) Where the activity occurred
... authorization S 0..* CodeableReference () Authorization (purposeOfUse) related to the event
Binding: PurposeOfUse icon ( example ) : The authorized purposeOfUse for the activity.
... why 0..1 markdown Why was the event performed?
... activity 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.
... basedOn 0..* Reference ( Resource ) Workflow authorization within which this event occurred
... patient Σ 0..1 Reference ( Patient ) The patient is the subject of the data created/updated (.target) by the activity
... encounter 0..1 Reference ( Encounter ) Encounter within which this event occurred or which the event is tightly associated
... Slices for agent S Σ C icon 1 .. * BackboneElement Who was involved with change
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 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.
..... role 0..* CodeableConcept What the agents role was
Binding: Example Security Role Type ( example ) : The role that a provenance agent played with respect to the activity.
..... who Σ C icon 1..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) The agent that participated in the event
..... onBehalfOf C icon 0..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService ) The agent that delegated
.... agent:Author S Σ C icon 0..1 BackboneElement Author
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AUT
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept What the agents role was
Binding: Example Security Role Type ( example ) : The role that a provenance agent played with respect to the activity.
..... who S Σ C icon 1..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) Author Reference
..... onBehalfOf C icon 0..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService ) The agent that delegated
... entity Σ 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 1..1 code revision | quotation | source | instantiates | removal
Binding: Provenance Entity Role ( required ) : How an entity was used in an activity.
.... what Σ 1..1 Reference ( Resource ) Identity of entity
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target

doco Documentation for this format icon

<!-- ProvenanceRelevantHistory -->doco

<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 icon   --></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 icon
    "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 .

Operation Definition Summary

@prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:OperationDefinition; fhir:Resource.id [ fhir:value "Encounter-everything"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ]; fhir:Extension.value [ fhir:value "2" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "trial-use" ] ]; fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/Encounter-everything"]; fhir:OperationDefinition.version [ fhir:value "4.0.1"]; fhir:OperationDefinition.name [ fhir:value "Fetch Encounter Record"]; fhir:OperationDefinition.status [ fhir:value "draft"]; fhir:OperationDefinition.kind [ fhir:value "operation"]; fhir:OperationDefinition.date [ fhir:value "2019-11-01T09:29:23+11:00"]; fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"]; fhir:OperationDefinition.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ], [ fhir:index 1; fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ] ] ]; fhir:OperationDefinition.description [ fhir:value "This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display).\r\rThe server SHOULD return all resources it has that:\r\r* are included in the encounter compartment for the identified encounter (have a reference to the encounter)\r* are referenced by the standard extenstion for associating an encounter (where no reference element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\r* the server believes are relevant to the context of the encounter for any other reason (internally defined/decided)\r* any resource referenced by the above, including binaries and attachments (to make a more complete package)\r\rIn the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (see [DAF](http://hl7.org/fhir/us/daf) for further guidance). Other applicable implementation guides may make additional rules about the information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)"]; fhir:OperationDefinition.code [ fhir:value "everything"]; fhir:OperationDefinition.comment [ fhir:value "The key differences between this operation and simply searching the encounter compartment are: \n\n* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging) \n* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones)\n\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment. \n\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single encounter, or determine whether the context has the rights to the nominated encounter, if there is one, or can determine an appropriate list of encouners to provide data for from the context of the request. If there is no nominated encounter (GET /Encounter/$everything) and the context is not associated with a single encounter record, the actual list of encounters is all encounters that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and encounter records is outside the scope of this specification (though see [The Smart App Launch Implementation Guide](http://hl7.org/fhir/smart-app-launch). \n\nWhen this operation is used to access multiple encounter records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made [asynchronously](async.html), and associated with [bulk data formats](formats.html#bulk). Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for [Searching](http.html#paging), using the [_count](search.html#count) parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.\n\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the encounter since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries."]; fhir:OperationDefinition.resource [ fhir:value "Encounter"; fhir:index 0 ]; fhir:OperationDefinition.system [ fhir:value "false"]; fhir:OperationDefinition.type [ fhir:value "false"]; fhir:OperationDefinition.instance [ fhir:value "true"]; fhir:OperationDefinition.parameter [ fhir:index 0; fhir:OperationDefinition.name [ fhir:value "_since" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time" ]; fhir:OperationDefinition.type [ fhir:value "instant" ] ], [ fhir:index 1; fhir:OperationDefinition.name [ fhir:value "_type" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "*" ]; fhir:OperationDefinition.documentation [ fhir:value "One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types" ]; fhir:OperationDefinition.type [ fhir:value "code" ] ], [ fhir:index 2; fhir:OperationDefinition.name [ fhir:value "_count" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "See discussion below on the utility of paging through the results of the $everything operation" ]; fhir:OperationDefinition.type [ fhir:value "integer" ] ], [ fhir:index 3; fhir:OperationDefinition.name [ fhir:value "return" ]; fhir:OperationDefinition.use [ fhir:value "out" ]; fhir:OperationDefinition.min [ fhir:value "1" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "The bundle type is \"searchset\"" ]; fhir:OperationDefinition.type [ fhir:value "Bundle" ] ] . # -------------------------------------------------------------------------------------

Mandatory: 3 elements (+2 nested mandatory elements)
Must-Support: 9 elements

Slices

This structure defines the following Slices :

  • The element Provenance.agent is sliced based on the value of value:type

Usage note: every effort has been made to ensure that Differential View

This indicates the examples are correct differences between this profile and useful, but they the base Provenance structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icondocoicon
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 1 .. * Reference ( Resource ) Resource version
... occurred[x] S 1..1 dateTime When the activity occurred
... authorization S 0 .. * CodeableReference () Authorization (purposeOfUse) related to the event
... activity 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.
... Slices for agent S 1 .. * BackboneElement Who was involved with change
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... type 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.
.... agent:Author S 0..1 BackboneElement Author
..... type S 1..1 CodeableConcept How the agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AUT
..... who S 1..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) Author Reference

doco Documentation for this format icon

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 icon Flags icon Card. icon Type icon Description & Constraints icondocoicon
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages ( required ) : IETF language tag for a human language
Additional Bindings Purpose
Common Languages Starter
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
... target S Σ 1..* Reference ( Resource ) Resource version
... occurred[x] S Σ 1..1 dateTime When the activity occurred
... recorded Σ 0..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference ( Location ) Where the activity occurred
... authorization S 0..* CodeableReference () Authorization (purposeOfUse) related to the event
Binding: PurposeOfUse icon ( example ) : The authorized purposeOfUse for the activity.
... why 0..1 markdown Why was the event performed?
... activity 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.
... basedOn 0..* Reference ( Resource ) Workflow authorization within which this event occurred
... patient Σ 0..1 Reference ( Patient ) The patient is the subject of the data created/updated (.target) by the activity
... encounter 0..1 Reference ( Encounter ) Encounter within which this event occurred or which the event is tightly associated
... Slices for agent S Σ C icon 1 .. * BackboneElement Who was involved with change
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 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.
..... role 0..* CodeableConcept What the agents role was
Binding: Example Security Role Type ( example ) : The role that a normative part provenance agent played with respect to the activity.
..... who Σ C icon 1..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) The agent that participated in the event
..... onBehalfOf C icon 0..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService ) The agent that delegated
.... agent:Author S Σ C icon 0..1 BackboneElement Author
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 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 specification. following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AUT
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept What the agents role was
Binding: Example Security Role Type ( example ) : The role that a provenance agent played with respect to the activity.
..... who S Σ C icon 1..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService ) Author Reference
..... onBehalfOf C icon 0..1 Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService ) The agent that delegated
... entity Σ 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 1..1 code revision | quotation | source | instantiates | removal
Binding: Provenance Entity Role ( required ) : How an entity was used in an activity.
.... what Σ 1..1 Reference ( Resource ) Identity of entity
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target

doco Documentation for this format icon

XML Template 


<!-- ProvenanceRelevantHistory -->doco

<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 icon   --></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 icon
    "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

6.3.12.2.2 Terminology Bindings

Path Name Conformance ValueSet
Provenance.language All Languages required All Languages
Provenance.authorization PurposeOfUse example PurposeOfUse icon
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 Example Security Role Type example Example Security Role Type
Provenance.agent.type Provenance Event History Agent Role Codes extensible Provenance Event History Agent Role Codes
Provenance.agent.role Example Security Role Type example Example Security Role Type
Provenance.entity.role Provenance Entity Role required Provenance Entity Role
. .