Provider Connect Australia (PCA)
2.4.2 - active

Provider Connect Australia (PCA) - Local Development build (v2.4.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: PCA Provenance

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-provenance | Version: 2.4.2
Active as of 2024-03-19 | Computable Name: PcaProvenance
Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile of Provenance is used to record an activity performed by the PCA service (conditionally on behalf of a participating organisation when the target element references a PCA Organization resource) whereby specific data elements of a PCA Organization or PCA Practitioner resource have been initially retrieved, updated or verified from an external system of record.

### Must support

The meaning of the presence or absence of the must support flag is described in Must support.

### Extensions

No extensions have been introduced in this profile.

### Usage notes

A Provenance resource whose target element references a PCA Organization resource records an initial retrieval, update or verification activity for the following elements:

- Where the entity used as the source of the Provenance activity (i.e. entity.what) is ‘Australian Business Register (ABR)’:
  - Organization.identifier (AUAustralianBusinessNumber profile)
  - Organization.name
  - Organization.alias
- Where the entity used as the source of the Provenance activity (i.e. entity.what) is ‘Healthcare Identifiers (HI) Service’
  - Organization.identifier (AUHPIO profile)
  - Organization.name

A Provenance resource whose target element references a PCA Practitioner resource records an initial retrieval, update or verification activity for the following elements:

- Where the entity used as the source of the Provenance activity (i.e. entity.what) is ‘Australian Health Practitioner Regulation Agency (Ahpra)’
  - Practitioner.identifier (AUAhpraRegistrationNumber profile)
  - Practitioner.name
- Where the entity used as the source of the Provenance activity (i.e. entity.what) is ‘Healthcare Identifiers (HI) Service’:
  - Practitioner.identifier (AUHPII profile)

For each Provenance resource created by the the PCA service, the agent.who element will include a contained Organization resource with the following fixed values:

- Organization.name: ‘Provider Connect Australia’
- Organization.identifier: ‘84425496912’ (i.e. the ABN of Australian Digital Health Agency)

### Supported interactions

Supported service interactions for this profile are defined in the following capability statements:

- For publishing systems: PCA Publisher Agent
- For subscribing systems: PCA Subscriber Agent

Usage:

- This Resource Profile is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

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

- 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 | Records an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
id | S | 0..1 | id | Logical id of this artifact
target | S | 1..1 | Reference(PCA Practitioner | PCA Organization) | Target Reference(s) (usually version specific)
recorded | S | 1..1 | instant | When the activity was recorded / updated
activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: PCA Provenance Activity Type (required)
agent |  |  |  |
type | S | 0..1 | CodeableConcept | How the agent participated Fixed Value: As shown
coding |  | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex)
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: performer
who | S | 1..1 | Reference(PCA Organization) {c} | Who participated
onBehalfOf | S | 0..1 | Reference(PCA Organization) | Who the agent is representing
entity |  | 1..* | BackboneElement | An entity used in this activity
role | S | 1..1 | code | derivation | revision | quotation | source | removal Fixed Value: source
what | S | 1..1 | Reference(Resource) | Identity of entity
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Provenance.activity | required | PcaProvenanceActivityType `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-provenance-activity-type` from this IG

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Records an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
id | S Σ | 0..1 | id | Logical id of this artifact
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..1 | Reference(PCA Practitioner | PCA Organization) | Target Reference(s) (usually version specific)
recorded | S Σ | 1..1 | instant | When the activity was recorded / updated
activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: PCA Provenance Activity Type (required)
agent |  | 1..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Fixed Value: As shown
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
coding |  | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 0..0 | uri | Identity of the terminology system
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: performer
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text |  | 0..0 | string | Plain text representation of the concept
who | S Σ | 1..1 | Reference(PCA Organization) {c} | Who participated
onBehalfOf | S | 0..1 | Reference(PCA Organization) | Who the agent is representing
entity |  | 1..* | BackboneElement | An entity used in this activity
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | S Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
what | S Σ | 1..1 | Reference(Resource) | Identity of entity
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Provenance.activity | required | PcaProvenanceActivityType `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-provenance-activity-type` from this IG
Provenance.agent.type | extensible | Fixed Value: performer `http://hl7.org/fhir/ValueSet/provenance-agent-type` from the FHIR Standard
Provenance.entity.role | required | Fixed Value: source `http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1` from the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Records an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
id | S Σ | 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..1 | Reference(PCA Practitioner | PCA Organization) | Target Reference(s) (usually version specific)
occurred[x] |  | 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: PCA Provenance Activity Type (required)
agent |  | 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 | S Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Fixed Value: As shown
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
coding |  | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 0..0 | uri | Identity of the terminology system
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: performer
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text |  | 0..0 | string | Plain text representation of the concept
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(PCA Organization) {c} | Who participated
onBehalfOf | S | 0..1 | Reference(PCA Organization) | Who the agent is representing
entity |  | 1..* | 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 | S Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
what | S Σ | 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 / Code | 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 | required | PcaProvenanceActivityType `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-provenance-activity-type` from this IG
Provenance.agent.type | extensible | Fixed Value: performer `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 | Fixed Value: source `http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1` from the FHIR Standard

This structure is derived from Provenance

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

- PCA Practitioner (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner)
- PCA Organization (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization)

Differential View

This structure is derived from Provenance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Records an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
id | S | 0..1 | id | Logical id of this artifact
target | S | 1..1 | Reference(PCA Practitioner | PCA Organization) | Target Reference(s) (usually version specific)
recorded | S | 1..1 | instant | When the activity was recorded / updated
activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: PCA Provenance Activity Type (required)
agent |  |  |  |
type | S | 0..1 | CodeableConcept | How the agent participated Fixed Value: As shown
coding |  | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex)
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: performer
who | S | 1..1 | Reference(PCA Organization) {c} | Who participated
onBehalfOf | S | 0..1 | Reference(PCA Organization) | Who the agent is representing
entity |  | 1..* | BackboneElement | An entity used in this activity
role | S | 1..1 | code | derivation | revision | quotation | source | removal Fixed Value: source
what | S | 1..1 | Reference(Resource) | Identity of entity
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Provenance.activity | required | PcaProvenanceActivityType `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-provenance-activity-type` from this IG

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Records an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
id | S Σ | 0..1 | id | Logical id of this artifact
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..1 | Reference(PCA Practitioner | PCA Organization) | Target Reference(s) (usually version specific)
recorded | S Σ | 1..1 | instant | When the activity was recorded / updated
activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: PCA Provenance Activity Type (required)
agent |  | 1..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Fixed Value: As shown
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
coding |  | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 0..0 | uri | Identity of the terminology system
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: performer
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text |  | 0..0 | string | Plain text representation of the concept
who | S Σ | 1..1 | Reference(PCA Organization) {c} | Who participated
onBehalfOf | S | 0..1 | Reference(PCA Organization) | Who the agent is representing
entity |  | 1..* | BackboneElement | An entity used in this activity
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | S Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
what | S Σ | 1..1 | Reference(Resource) | Identity of entity
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Provenance.activity | required | PcaProvenanceActivityType `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-provenance-activity-type` from this IG
Provenance.agent.type | extensible | Fixed Value: performer `http://hl7.org/fhir/ValueSet/provenance-agent-type` from the FHIR Standard
Provenance.entity.role | required | Fixed Value: source `http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1` from the FHIR Standard

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Records an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
id | S Σ | 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..1 | Reference(PCA Practitioner | PCA Organization) | Target Reference(s) (usually version specific)
occurred[x] |  | 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: PCA Provenance Activity Type (required)
agent |  | 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 | S Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Fixed Value: As shown
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
coding |  | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 0..0 | uri | Identity of the terminology system
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: performer
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text |  | 0..0 | string | Plain text representation of the concept
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(PCA Organization) {c} | Who participated
onBehalfOf | S | 0..1 | Reference(PCA Organization) | Who the agent is representing
entity |  | 1..* | 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 | S Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
what | S Σ | 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 / Code | 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 | required | PcaProvenanceActivityType `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-provenance-activity-type` from this IG
Provenance.agent.type | extensible | Fixed Value: performer `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 | Fixed Value: source `http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1` from the FHIR Standard

This structure is derived from Provenance

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

- PCA Practitioner (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner)
- PCA Organization (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization)

Other representations of profile: CSV, Excel, Schematron

### Notes:

No additional search parameters defined for this resource profile.