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

Extension: PCA Bank Account

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account Version: 25.2.0.0
Active as of 2025-10-23 Computable Name: PcaBankAccount

Copyright/Legal: Copyright © 2024 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 extension applies to PCA Healthcare Service, PCA Practitioner and PCA Practitioner Role, and represents a bank account that is being published to a specific PCA Partner Service.

Context of Use

Must support

The meaning of the presence or absence of the must support flag is described in Must support, with the following exception:

  • Any values provided by publishing systems when adding or updating a healthcare service, practitioner or practitioner role will be ignored by the PCA service. Bank account details must be managed by a healthcare provider organisation via the PCA Portal. The PCA service will populate the extension when providing healthcare service, practitioner or practitioner role resources to subscribing systems.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Bank account details
... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:bsbNumber S 1..1 Extension BSB (Bank-State-Branch) number
..... url 1..1 uri "bsbNumber"
..... value[x] 0..1 string Value of extension
.... extension:bsbName S 1..1 Extension BSB (Bank-State-Branch) name
..... url 1..1 uri "bsbName"
..... value[x] 0..1 string Value of extension
.... extension:accountNumber S 1..1 Extension Bank account number
..... url 1..1 uri "accountNumber"
..... value[x] 0..1 string Value of extension
.... extension:accountName S 1..1 Extension Bank account name
..... url 1..1 uri "accountName"
..... value[x] 0..1 string Value of extension
.... extension:activePeriod S 0..1 Extension Period when the bank account is in use
..... url 1..1 uri "activePeriod"
..... value[x] 0..1 Period Value of extension
.... extension:partnerService S 1..1 Extension Partner service that the bank account is being published to
..... url 1..1 uri "partnerService"
..... value[x] 0..1 Reference(PCA Partner Service) Value of extension
.... extension:billingAddress S 1..1 Extension Billing address
..... url 1..1 uri "billingAddress"
..... value[x] 0..1 AustralianAddress Value of extension
... url 1..1 uri "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Bank account details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:bsbNumber S 1..1 Extension BSB (Bank-State-Branch) number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "bsbNumber"
..... value[x] 0..1 string Value of extension
.... extension:bsbName S 1..1 Extension BSB (Bank-State-Branch) name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "bsbName"
..... value[x] 0..1 string Value of extension
.... extension:accountNumber S 1..1 Extension Bank account number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "accountNumber"
..... value[x] 0..1 string Value of extension
.... extension:accountName S 1..1 Extension Bank account name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "accountName"
..... value[x] 0..1 string Value of extension
.... extension:activePeriod S 0..1 Extension Period when the bank account is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "activePeriod"
..... value[x] 0..1 Period Value of extension
.... extension:partnerService S 1..1 Extension Partner service that the bank account is being published to
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "partnerService"
..... value[x] 0..1 Reference(PCA Partner Service) Value of extension
.... extension:billingAddress S 1..1 Extension Billing address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "billingAddress"
..... value[x] 0..1 AustralianAddress Value of extension
... url 1..1 uri "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension applies to PCA Healthcare Service, PCA Practitioner and PCA Practitioner Role, and represents a bank account that is being published to a specific PCA Partner Service.

  • bsbNumber: string: BSB (Bank-State-Branch) number of the bank account.
  • bsbName: string: BSB (Bank-State-Branch) name of the bank account.
  • accountNumber: string: Account number of the bank account.
  • accountName: string: Account name of the bank account.
  • activePeriod: Period: The period when the bank account is in use. If not present, the bank account can be considered active.
  • partnerService: Reference: The partner service that the bank account is being published to.
  • billingAddress: Address: Billing address associated with bank account details.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Bank account details
... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:bsbNumber S 1..1 Extension BSB (Bank-State-Branch) number
..... url 1..1 uri "bsbNumber"
..... value[x] 0..1 string Value of extension
.... extension:bsbName S 1..1 Extension BSB (Bank-State-Branch) name
..... url 1..1 uri "bsbName"
..... value[x] 0..1 string Value of extension
.... extension:accountNumber S 1..1 Extension Bank account number
..... url 1..1 uri "accountNumber"
..... value[x] 0..1 string Value of extension
.... extension:accountName S 1..1 Extension Bank account name
..... url 1..1 uri "accountName"
..... value[x] 0..1 string Value of extension
.... extension:activePeriod S 0..1 Extension Period when the bank account is in use
..... url 1..1 uri "activePeriod"
..... value[x] 0..1 Period Value of extension
.... extension:partnerService S 1..1 Extension Partner service that the bank account is being published to
..... url 1..1 uri "partnerService"
..... value[x] 0..1 Reference(PCA Partner Service) Value of extension
.... extension:billingAddress S 1..1 Extension Billing address
..... url 1..1 uri "billingAddress"
..... value[x] 0..1 AustralianAddress Value of extension
... url 1..1 uri "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Bank account details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:bsbNumber S 1..1 Extension BSB (Bank-State-Branch) number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "bsbNumber"
..... value[x] 0..1 string Value of extension
.... extension:bsbName S 1..1 Extension BSB (Bank-State-Branch) name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "bsbName"
..... value[x] 0..1 string Value of extension
.... extension:accountNumber S 1..1 Extension Bank account number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "accountNumber"
..... value[x] 0..1 string Value of extension
.... extension:accountName S 1..1 Extension Bank account name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "accountName"
..... value[x] 0..1 string Value of extension
.... extension:activePeriod S 0..1 Extension Period when the bank account is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "activePeriod"
..... value[x] 0..1 Period Value of extension
.... extension:partnerService S 1..1 Extension Partner service that the bank account is being published to
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "partnerService"
..... value[x] 0..1 Reference(PCA Partner Service) Value of extension
.... extension:billingAddress S 1..1 Extension Billing address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "billingAddress"
..... value[x] 0..1 AustralianAddress Value of extension
... url 1..1 uri "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension applies to PCA Healthcare Service, PCA Practitioner and PCA Practitioner Role, and represents a bank account that is being published to a specific PCA Partner Service.

  • bsbNumber: string: BSB (Bank-State-Branch) number of the bank account.
  • bsbName: string: BSB (Bank-State-Branch) name of the bank account.
  • accountNumber: string: Account number of the bank account.
  • accountName: string: Account name of the bank account.
  • activePeriod: Period: The period when the bank account is in use. If not present, the bank account can be considered active.
  • partnerService: Reference: The partner service that the bank account is being published to.
  • billingAddress: Address: Billing address associated with bank account details.

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
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()

Notes:

No additional search parameters defined for this resource profile.