AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Provenance

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-provenance Version: 0.2.1-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreProvenance

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Provenance resource to record, search, and fetch basic encounter information for a patient. It is based on the core FHIR Provenance resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Provenance when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

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

Specific feedback is sought on the need for AU Core to support targeted Provenance. Provenance.target may point at a specific element within the targetted 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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)Target Reference(s) (usually version specific)
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantWhen the activity was recorded / updated
... activity S0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent S1..*BackboneElementActor involved
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who participated
.... onBehalfOf S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who the agent is representing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Provenance.activityextensibleProvenanceActivityType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] S0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity S0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent S1..*BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

.... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who participated
.... onBehalfOf S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.entity.rolerequiredProvenanceEntityRole

Differential View

This structure is derived from Provenance

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)Target Reference(s) (usually version specific)
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantWhen the activity was recorded / updated
... activity S0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent S1..*BackboneElementActor involved
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who participated
.... onBehalfOf S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who the agent is representing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Provenance.activityextensibleProvenanceActivityType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] S0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity S0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent S1..*BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

.... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who participated
.... onBehalfOf S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core System Device | AU Core Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.entity.rolerequiredProvenanceEntityRole

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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
  • CarePlan
  • CareTeam
  • Composition
  • Condition
  • Coverage
  • Device
  • DiagnosticReport
  • DocumentReference
  • Encounter
  • HealthcareService
  • Immunization
  • List
  • MedicationAdministration
  • MedicationDispense
  • MedicationRequest
  • MedicationStatement
  • Observation
  • Organization
  • Patient
  • Practitioner
  • PractitionerRole
  • Procedure
  • RelatedPerson
  • ServiceRequest
  • Specimen

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.