This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
R5
Snapshot
#1).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Security
Work
Group
|
Maturity
Level
:
|
Trial Use | Use Context : Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/provenance-relevant-history
Guidance on using Provenance for related history elements
This profile was published on Tue, Dec 3, 2013 00:00+1100 as a draft 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 structure is derived from Provenance .
| 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 .. * |
|
Authorization (purposeOfUse) related to the event |
|
S | 1..1 | CodeableConcept |
Record
activity
Binding: Provenance History Record Activity Codes ( extensible |
|
S | 1 .. * |
|
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 |
|
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
|
|
Author Reference |
Documentation
for
this
format
|
||||
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
0..* | Provenance |
Who,
What,
When
for
a
set
of
resources
|
|
Σ | 0..1 |
|
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: Common Languages ( preferred ) Max Binding: All Languages : IETF language tag |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation |
|
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 |
|
Σ
|
|
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, if relevant |
|
S
|
0..* |
|
|
|
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 ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task ) |
Workflow
authorization
within
which
this
event
occurred
|
|
| 0..1 | Reference ( Encounter ) | Encounter within which this event occurred or which the event is tightly associated | |
![]()
|
S
|
1 .. * |
|
Who
was
involved
with
change
Slice: Unordered, Open by value:type |
|
Content/Rules for all slices | |||
|
0..1 |
|
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 |
|
|
0..* | CodeableConcept |
What
the
agents
role
was
Binding: SecurityRoleType ( example |
|
Σ
|
1..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
|
|
|
0..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
|
|
S
|
0..1 | BackboneElement |
Author
|
|
0..1 |
|
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: 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: SecurityRoleType ( example |
|
S
Σ
|
1..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
Author Reference |
|
|
0..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
|
|
|
0..* | BackboneElement |
An
entity
used
in
this
activity
|
|
0..1 |
|
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 |
derivation
|
revision
|
quotation
|
source
|
instantiates
|
removal
Binding: ProvenanceEntityRole ( required |
|
Σ
|
1..1 | Reference ( Resource ) | Identity of entity |
|
|
0..* | See agent (Provenance) |
|
|
|
0..* | Signature |
Signature
on
target
|
Documentation
for
this
format
|
||||
<!-- Provenance Relevant History --><Provenance xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text>
<</contained><contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--0..* Extension Extensions that cannot be ignored --></modifierExtension> <target><!--
1..* Reference(Resource) Resource version --></target> <occurredDateTime value="[dateTime]"/><!--
1..1 When the activity occurred -->
<<recorded value="[instant]"/><!--0..1 When the activity was recorded / updated --> <policy value="[uri]"/><!--
0..* Policy or plan the activity was defined by --> <location><!--
0..1 Reference(Location) Where the activity occurred, if relevant --></location>
<</reason><authorization><!--0..* CodeableReference Authorization (purposeOfUse) related to the event --></authorization> <activity><!--
1..1 CodeableConcept Record activity --></activity> <basedOn><!--
0..* Reference(CarePlan) Workflow authorization within which this event occurred --></basedOn> <encounter><!--
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>0..1 BackboneElement <!--
0..1 Author --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<</type> <</role><type><!--1..1 CodeableConcept How the agent participated --></type> <role><!--
0..* CodeableConcept What the agents role was --></role> <who><!--
1..1 Reference(Practitioner) Author Reference --></who>
< Who the agent is representing</onBehalfOf><onBehalfOf><!--0..1 Reference(Practitioner) The agent that delegated --></onBehalfOf> </agent>
<<entity>0..* BackboneElement <!--
0..* An entity used in this activity --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<<role value="[code]"/><!--1..1 derivation | revision | quotation | source | instantiates | removal --> <what><!--
1..1 Reference(Resource) Identity of entity --></what>
<</agent><agent><!-- See http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent Entity is attributed to this agent --></agent> </entity> <signature><!--0..* Signature Signature on target --></signature> </Provenance>
{ // Provenance Relevant History
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"target" : [{ Reference(Resource) }], // C? R! Resource version
"occurredDateTime" : "<dateTime>", // C? R! When the activity occurred
"
"recorded" : "<instant>", // C?When the activity was recorded / updated
"policy" : ["<uri>"], // C?Policy or plan the activity was defined by
"location" : { Reference(Location) }, // C?Where the activity occurred, if relevant
"
"authorization" : [{ CodeableReference }], // C?Authorization (purposeOfUse) related to the event
"activity" : { CodeableConcept }, // C? R! Record activity
"basedOn" : [{ Reference(CarePlan) }], // C?Workflow authorization within which this event occurred
"encounter" : { Reference(Encounter) }, // C?Encounter within which this event occurred or which the event is tightly associated
"agent" : [ // sliced by value:type in the specified order, Open
{ // Author // C?
// from Element: extension
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored even if unrecognized
"
"
"type" : { CodeableConcept }, // C? R! How the agent participated
"role" : [{ CodeableConcept }], // C?What the agents role was
"who" : { Reference(Practitioner) }, // C? R! Author Reference
"
"onBehalfOf" : { Reference(Practitioner) } // C?The agent that delegated
}
],
"
"entity" : [{ BackboneElement }], // C?An entity used in this activity
"signature" : [{ Signature }], // C?Signature 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 structure is derived from Provenance .
| 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 .. * |
|
Authorization (purposeOfUse) related to the event |
|
S | 1..1 | CodeableConcept |
Record
activity
Binding: Provenance History Record Activity Codes ( extensible |
|
S | 1 .. * |
|
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 |
|
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
|
|
Author Reference |
Documentation
for
this
format
|
||||
Snapshot View
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
0..* | Provenance |
Who,
What,
When
for
a
set
of
resources
|
|
Σ | 0..1 |
|
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: Common Languages ( preferred ) Max Binding: All Languages : IETF language tag |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation |
|
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 |
|
Σ
|
|
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, if relevant |
|
S
|
0..* |
|
|
|
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 ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task ) |
Workflow
authorization
within
which
this
event
occurred
|
|
| 0..1 | Reference ( Encounter ) | Encounter within which this event occurred or which the event is tightly associated | |
![]()
|
S
|
1 .. * |
|
Who
was
involved
with
change
Slice: Unordered, Open by value:type |
|
Content/Rules for all slices | |||
|
0..1 |
|
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 |
|
|
0..* | CodeableConcept |
What
the
agents
role
was
Binding: SecurityRoleType ( example |
|
Σ
|
1..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
|
|
|
0..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
|
|
S
|
0..1 | BackboneElement |
Author
|
|
0..1 |
|
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: 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: SecurityRoleType ( example |
|
S
Σ
|
1..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
Author Reference |
|
|
0..1 |
Reference
(
Practitioner
|
PractitionerRole
|
|
|
|
|
0..* | BackboneElement |
An
entity
used
in
this
activity
|
|
0..1 |
|
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 |
derivation
|
revision
|
quotation
|
source
|
instantiates
|
removal
Binding: ProvenanceEntityRole ( required |
|
Σ
|
1..1 | Reference ( Resource ) | Identity of entity |
|
|
0..* | See agent (Provenance) |
|
|
|
0..* | Signature |
Signature
on
target
|
Documentation
for
this
format
|
||||
XML Template
<!-- Provenance Relevant History --><Provenance xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text>
<</contained><contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--0..* Extension Extensions that cannot be ignored --></modifierExtension> <target><!--
1..* Reference(Resource) Resource version --></target> <occurredDateTime value="[dateTime]"/><!--
1..1 When the activity occurred -->
<<recorded value="[instant]"/><!--0..1 When the activity was recorded / updated --> <policy value="[uri]"/><!--
0..* Policy or plan the activity was defined by --> <location><!--
0..1 Reference(Location) Where the activity occurred, if relevant --></location>
<</reason><authorization><!--0..* CodeableReference Authorization (purposeOfUse) related to the event --></authorization> <activity><!--
1..1 CodeableConcept Record activity --></activity> <basedOn><!--
0..* Reference(CarePlan) Workflow authorization within which this event occurred --></basedOn> <encounter><!--
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>0..1 BackboneElement <!--
0..1 Author --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<</type> <</role><type><!--1..1 CodeableConcept How the agent participated --></type> <role><!--
0..* CodeableConcept What the agents role was --></role> <who><!--
1..1 Reference(Practitioner) Author Reference --></who>
< Who the agent is representing</onBehalfOf><onBehalfOf><!--0..1 Reference(Practitioner) The agent that delegated --></onBehalfOf> </agent>
<<entity>0..* BackboneElement <!--
0..* An entity used in this activity --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension>
<<role value="[code]"/><!--1..1 derivation | revision | quotation | source | instantiates | removal --> <what><!--
1..1 Reference(Resource) Identity of entity --></what>
<</agent><agent><!-- See http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent Entity is attributed to this agent --></agent> </entity> <signature><!--0..* Signature Signature on target --></signature> </Provenance>
JSON Template
{ // Provenance Relevant History
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"target" : [{ Reference(Resource) }], // C? R! Resource version
"occurredDateTime" : "<dateTime>", // C? R! When the activity occurred
"
"recorded" : "<instant>", // C?When the activity was recorded / updated
"policy" : ["<uri>"], // C?Policy or plan the activity was defined by
"location" : { Reference(Location) }, // C?Where the activity occurred, if relevant
"
"authorization" : [{ CodeableReference }], // C?Authorization (purposeOfUse) related to the event
"activity" : { CodeableConcept }, // C? R! Record activity
"basedOn" : [{ Reference(CarePlan) }], // C?Workflow authorization within which this event occurred
"encounter" : { Reference(Encounter) }, // C?Encounter within which this event occurred or which the event is tightly associated
"agent" : [ // sliced by value:type in the specified order, Open
{ // Author // C?
// from Element: extension
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored even if unrecognized
"
"
"type" : { CodeableConcept }, // C? R! How the agent participated
"role" : [{ CodeableConcept }], // C?What the agents role was
"who" : { Reference(Practitioner) }, // C? R! Author Reference
"
"onBehalfOf" : { Reference(Practitioner) } // C?The agent that delegated
}
],
"
"entity" : [{ BackboneElement }], // C?An entity used in this activity
"signature" : [{ Signature }], // C?Signature on target
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Provenance.language | Common Languages | preferred | Common Languages |
|
|
Provenance History Record Activity Codes | extensible | Provenance History Record Activity Codes |
| Provenance.agent.type |
|
|
|
| Provenance.agent.role | SecurityRoleType | example | SecurityRoleType |
| Provenance.agent.type |
|
|
|
| Provenance.agent.role | SecurityRoleType | example | SecurityRoleType |
| Provenance.entity.role | ProvenanceEntityRole | required | ProvenanceEntityRole |