AU Core Implementation Guide
0.2.2-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.2-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.2-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 provenance 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 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.

Usage:

Formal Views of Profile Content

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

This structure is derived from Provenance

 

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.