Usage scenarios

The following are supported usage scenarios for this profile:

• Query for Provenance records associated with a specific FHIR resource
• Query for Provenance records associated with all FHIR resources of a specific type

Comparison with other national and international specifications

A resource conforming to this profile:

• MAY be conformant to US Core Provenance if all instances of Provenance.agent.onBehalfOf are supplied as Organization

No equivalent International Patient Access or International Patient Summary profile.

A resource conforming to US Core MAY conform to AU Core.

Profile specific implementation guidance

• see guidance in the core FHIR specification on using the provenance resource

Feedback is requested on the proposal to remove support for _revinclude parameter: Provenance:target across the set of resources in AU Core. Please comment on FHIR-43850.

Input is requested on the need for AU Core to support targeted Provenance. Provenance.target may point at a specific element within the targeted resource using the target element extension or target path extension. These extensions are only available at this time in R5 but can be supported in R4 AU Core if needed.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
target	S	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
occurred[x]	S	0..1	Period, dateTime	When the activity occurred
recorded	S	1..1	instant	When the activity was recorded / updated
activity	S	0..1	CodeableConcept	Activity that occurred
agent	S	1..*	BackboneElement	Actor involved
who	S	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who participated
onBehalfOf	S	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who the agent is representing
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	SΣ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
occurred[x]	S	0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	SΣ	1..1	instant	When the activity was recorded / updated
activity	S	0..1	CodeableConcept	Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
agent	S	1..*	BackboneElement	Actor involved
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who participated
onBehalfOf	S	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who the agent is representing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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)	Target Reference(s) (usually version specific)
occurred[x]	S	0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	SΣ	1..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, if relevant
reason		0..*	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
activity	S	0..1	CodeableConcept	Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
agent	S	1..*	BackboneElement	Actor involved
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	Σ	0..1	CodeableConcept	How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
role		0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
who	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who participated
onBehalfOf	S	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who the agent is representing
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	derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard
Provenance.agent.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
target	S	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
occurred[x]	S	0..1	Period, dateTime	When the activity occurred
recorded	S	1..1	instant	When the activity was recorded / updated
activity	S	0..1	CodeableConcept	Activity that occurred
agent	S	1..*	BackboneElement	Actor involved
who	S	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who participated
onBehalfOf	S	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who the agent is representing
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	SΣ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
occurred[x]	S	0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	SΣ	1..1	instant	When the activity was recorded / updated
activity	S	0..1	CodeableConcept	Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
agent	S	1..*	BackboneElement	Actor involved
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who participated
onBehalfOf	S	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who the agent is representing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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)	Target Reference(s) (usually version specific)
occurred[x]	S	0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	SΣ	1..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, if relevant
reason		0..*	CodeableConcept	Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
activity	S	0..1	CodeableConcept	Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
agent	S	1..*	BackboneElement	Actor involved
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	Σ	0..1	CodeableConcept	How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
role		0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
who	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who participated
onBehalfOf	S	0..1	Reference(AU Core Practitioner | AU Core PractitionerRole | RelatedPerson | AU Core Patient | Device | AU Core Organization)	Who the agent is representing
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	derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard
Provenance.agent.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

• AU Core Practitioner (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner)
• AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
• AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
• AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

Maturity: 0

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

AU Core Provenance SHALL be supported for the following resource types that conform to an AU Core profile:

• AllergyIntolerance
• Condition
• Encounter
• Immunization
• MedicationRequest
• MedicationStatement
• Observation
• Organization
• Patient
• Practitioner
• PractitionerRole
• Procedure

Mandatory Search Parameters

The following search parameter combinations SHALL be supported:

1. SHALL support searching for all resources (that are one of the resource types listed above) for a patient and all the Provenance records for those resources using a combination of the patient and _revinclude search parameters:

   GET [base]/[Resource]?patient=[id]&_revinclude=Provenance:target

   Example:

   1. GET [base]/AllergyIntolerance?patient=75&_revinclude=Provenance:target

   Implementation Notes: Fetches a bundle of all resources of a particular type for the specified patient (how to search by reference) and any corresponding Provenance resources.

2. SHALL support searching for a particular resource (that are one of the resource types listed above) and all its Provenance resources using combination of the _id and the _revinclude search parameters:

   GET [base]/[Resource]?_id=[id]&_revinclude=Provenance:target

   Example:

   1. GET [base]/AllergyIntolerance?_id=2425&_revinclude=Provenance:target

   Implementation Notes: Fetches a bundle of a resource of a particular type (within the clients authorization scope) and any corresponding Provenance resources. (how to search by token)

Optional Search Parameters

No optional search parameters for this profile.