Provider Connect Australia (PCA) FHIR Implementation Guide 2.4.0

This is release 2.4.0 of Provider Connect Australia (PCA) FHIR Implementation Guide. It is based on FHIR version 4.0.1. See the Directory of published versions.

SD.27 StructureDefinition-pca-provenance [Draft]

PCA Provenance

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:


SD.27.1 Formal views of profile content

The official URL for this profile is: 

http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-provenance

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.

This profile builds on Provenance.

This profile was published on 2023-09-15 10:45:26+1000 as a draft by Australian Digital Health Agency.

Description of profiles, differentials, snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceRecords an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
... id S0..1idLogical id of this artifact
... target S1..1Reference(PCA Practitioner | PCA Organization)Target Reference(s) (usually version specific)
... recorded S1..1instantWhen the activity was recorded / updated
... activity S0..1CodeableConceptActivity that occurred
Binding: PCA Provenance Activity Type (required)
... agent
.... type S0..1CodeableConceptHow the agent participated
Fixed Value: As shown
..... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
.... who S1..1Reference(PCA Organization) {c}Who participated
.... onBehalfOf S0..1Reference(PCA Organization)Who the agent is representing
... entity 1..*BackboneElementAn entity used in this activity
.... role S1..1codederivation | revision | quotation | source | removal
Fixed Value: source
.... what S1..1Reference(Resource)Identity of entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceRecords an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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..1Reference(PCA Practitioner | PCA Organization)Target Reference(s) (usually version specific)
... occurred[x] 0..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: PCA Provenance Activity Type (required)
... agent 1..*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 SΣ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Fixed Value: As shown
..... id0..0idUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..0idUnique id for inter-element referencing
...... extension0..0ExtensionAdditional content defined by implementations
...... system0..0uriIdentity of the terminology system
...... version0..0stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
...... display0..0stringRepresentation defined by the system
...... userSelected0..0booleanIf this coding was chosen directly by the user
..... text0..0stringPlain text representation of the concept
.... 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(PCA Organization) {c}Who participated
.... onBehalfOf S0..1Reference(PCA Organization)Who the agent is representing
... entity 1..*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 SΣ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Fixed Value: source
.... what SΣ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

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceRecords an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
... id S0..1idLogical id of this artifact
... target S1..1Reference(PCA Practitioner | PCA Organization)Target Reference(s) (usually version specific)
... recorded S1..1instantWhen the activity was recorded / updated
... activity S0..1CodeableConceptActivity that occurred
Binding: PCA Provenance Activity Type (required)
... agent
.... type S0..1CodeableConceptHow the agent participated
Fixed Value: As shown
..... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
.... who S1..1Reference(PCA Organization) {c}Who participated
.... onBehalfOf S0..1Reference(PCA Organization)Who the agent is representing
... entity 1..*BackboneElementAn entity used in this activity
.... role S1..1codederivation | revision | quotation | source | removal
Fixed Value: source
.... what S1..1Reference(Resource)Identity of entity

doco Documentation for this format

Snapshot view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceRecords an activity where specific data elements of a resource were retrieved/updated/verified from an external system of record
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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..1Reference(PCA Practitioner | PCA Organization)Target Reference(s) (usually version specific)
... occurred[x] 0..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: PCA Provenance Activity Type (required)
... agent 1..*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 SΣ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Fixed Value: As shown
..... id0..0idUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..0idUnique id for inter-element referencing
...... extension0..0ExtensionAdditional content defined by implementations
...... system0..0uriIdentity of the terminology system
...... version0..0stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: performer
...... display0..0stringRepresentation defined by the system
...... userSelected0..0booleanIf this coding was chosen directly by the user
..... text0..0stringPlain text representation of the concept
.... 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(PCA Organization) {c}Who participated
.... onBehalfOf S0..1Reference(PCA Organization)Who the agent is representing
... entity 1..*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 SΣ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Fixed Value: source
.... what SΣ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

 

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.27.2 - Search parameters

No additional search parameters defined for this resource profile.

 

SD.27.3 - Known issues

No known issues.