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:

• 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	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

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
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 Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
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 (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	1..*	BackboneElement	Who was involved with change Slice: Unordered, Open by value:type prov-1: Who and onBehalfOf cannot be the same prov-2: If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner prov-3: If who is an organization, onBehalfOf can't be a PractitionerRole within that organization prov-4: If who is an organization, onBehalfOf can't be a healthcare service within that organization
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: Security Role Type (example): The role that a provenance agent played with respect to the activity.
who	ΣC	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService)	The agent that participated in the event
onBehalfOf	C	0..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService)	The agent that delegated
agent:Author	SΣC	0..1	BackboneElement	Author prov-1: Who and onBehalfOf cannot be the same prov-2: If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner prov-3: If who is an organization, onBehalfOf can't be a PractitionerRole within that organization prov-4: If who is an organization, onBehalfOf can't be a healthcare service within that organization
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: Security Role Type (example): The role that a provenance agent played with respect to the activity.
who	SΣC	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService)	Author Reference
onBehalfOf	C	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
Documentation for this format

<!-- 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
  }

Summary

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

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
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 Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
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 (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	1..*	BackboneElement	Who was involved with change Slice: Unordered, Open by value:type prov-1: Who and onBehalfOf cannot be the same prov-2: If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner prov-3: If who is an organization, onBehalfOf can't be a PractitionerRole within that organization prov-4: If who is an organization, onBehalfOf can't be a healthcare service within that organization
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: Security Role Type (example): The role that a provenance agent played with respect to the activity.
who	ΣC	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService)	The agent that participated in the event
onBehalfOf	C	0..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Group | HealthcareService)	The agent that delegated
agent:Author	SΣC	0..1	BackboneElement	Author prov-1: Who and onBehalfOf cannot be the same prov-2: If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner prov-3: If who is an organization, onBehalfOf can't be a PractitionerRole within that organization prov-4: If who is an organization, onBehalfOf can't be a healthcare service within that organization
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: Security Role Type (example): The role that a provenance agent played with respect to the activity.
who	SΣC	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | Group | HealthcareService)	Author Reference
onBehalfOf	C	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
Documentation for this format

<!-- 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
  }