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.34 StructureDefinition-pca-bank-account [Draft]

PCA Bank Account

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

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 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 or practitioner role resources to subscribing systems.

SD.34.1 Formal views of profile content

The official URL for this profile is: 

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

This extension applies to PCA Healthcare Service and PCA Practitioner Role, and is used to record bank account details.

This profile builds on Extension.

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
.. Extension 0..*ExtensionBank account details
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:bsbNumber S1..1ExtensionBSB (Bank-State-Branch) number
.... url 1..1uri"bsbNumber"
.... value[x] 0..1stringValue of extension
... extension:bsbName S1..1ExtensionBSB (Bank-State-Branch) name
.... url 1..1uri"bsbName"
.... value[x] 0..1stringValue of extension
... extension:accountNumber S1..1ExtensionBank account number
.... url 1..1uri"accountNumber"
.... value[x] 0..1stringValue of extension
... extension:accountName S1..1ExtensionBank account name
.... url 1..1uri"accountName"
.... value[x] 0..1stringValue of extension
... extension:activePeriod S0..1ExtensionPeriod when the bank account is in use
.... url 1..1uri"activePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:partnerService S1..1ExtensionPartner service that the bank account is being published to
.... url 1..1uri"partnerService"
.... value[x] 0..1Reference(PCA Partner Service)Value of extension
... url 1..1uri"http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBank account details
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:bsbNumber S1..1ExtensionBSB (Bank-State-Branch) number
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"bsbNumber"
.... value[x] 0..1stringValue of extension
... extension:bsbName S1..1ExtensionBSB (Bank-State-Branch) name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"bsbName"
.... value[x] 0..1stringValue of extension
... extension:accountNumber S1..1ExtensionBank account number
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"accountNumber"
.... value[x] 0..1stringValue of extension
... extension:accountName S1..1ExtensionBank account name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"accountName"
.... value[x] 0..1stringValue of extension
... extension:activePeriod S0..1ExtensionPeriod when the bank account is in use
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"activePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:partnerService S1..1ExtensionPartner service that the bank account is being published to
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"partnerService"
.... value[x] 0..1Reference(PCA Partner Service)Value of extension
... url 1..1uri"http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"

doco Documentation for this format

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionBank account details
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:bsbNumber S1..1ExtensionBSB (Bank-State-Branch) number
.... url 1..1uri"bsbNumber"
.... value[x] 0..1stringValue of extension
... extension:bsbName S1..1ExtensionBSB (Bank-State-Branch) name
.... url 1..1uri"bsbName"
.... value[x] 0..1stringValue of extension
... extension:accountNumber S1..1ExtensionBank account number
.... url 1..1uri"accountNumber"
.... value[x] 0..1stringValue of extension
... extension:accountName S1..1ExtensionBank account name
.... url 1..1uri"accountName"
.... value[x] 0..1stringValue of extension
... extension:activePeriod S0..1ExtensionPeriod when the bank account is in use
.... url 1..1uri"activePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:partnerService S1..1ExtensionPartner service that the bank account is being published to
.... url 1..1uri"partnerService"
.... value[x] 0..1Reference(PCA Partner Service)Value of extension
... url 1..1uri"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 & Constraintsdoco
.. Extension 0..*ExtensionBank account details
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:bsbNumber S1..1ExtensionBSB (Bank-State-Branch) number
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"bsbNumber"
.... value[x] 0..1stringValue of extension
... extension:bsbName S1..1ExtensionBSB (Bank-State-Branch) name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"bsbName"
.... value[x] 0..1stringValue of extension
... extension:accountNumber S1..1ExtensionBank account number
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"accountNumber"
.... value[x] 0..1stringValue of extension
... extension:accountName S1..1ExtensionBank account name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"accountName"
.... value[x] 0..1stringValue of extension
... extension:activePeriod S0..1ExtensionPeriod when the bank account is in use
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"activePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:partnerService S1..1ExtensionPartner service that the bank account is being published to
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"partnerService"
.... value[x] 0..1Reference(PCA Partner Service)Value of extension
... url 1..1uri"http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account"

doco Documentation for this format

 

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

 

SD.34.2 - Search parameters

No additional search parameters defined for this resource profile.

 

SD.34.3 - Known issues

No known issues.