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.18 StructureDefinition-pca-organization [Draft]

PCA Organization

This profile of Organization defines an organisation, in an Australian healthcare context, as supported by the Provider Connect Australia (PCA).

Must support

The meaning of the presence or absence of the must support flag is described in Must support, except for the extension:pca-active-in-system-of-record element. When an Organization is provided to a subscribing system the value for this element is populated by the PCA service to indicate if the organisation is currently active in the system of record from which the name and identifier elements were obtained.

Extensions

Extensions introduced in this profile:

Usage notes

Identifiers

The PCA Organization profile explicitly supports the following identifier slices (as indicated by the must support flag):

  • Healthcare Provider Identifier – Organisation (HPI-O)
  • Australian Business Number (ABN)
  • PCA Organization Identifier (PCA-OI)

A PCA Organization resource may also have additional identifiers specific to other PCA business partners, and their identifier systems may or may not match other identifier slices defined in AU Base Organization.

Organisation type

The PCA Organization profile is used to represent different types of organisations within the PCA service.

  • A HI organisation is an organisation sourced from the HI service. It has a type of ‘HIO’, and an AU HPI-O identifier.

  • A legal entity organisation is an organisation with an Australian Business Number (ABN) or a sole trader without an ABN. It has a type of ‘LEO’, and an AU Australian Business Number identifier (except for sole traders without an ABN). A legal entity organisation is further classified as either a participating organisation (that is, an organisation that has a participation agreement with PCA), or a subsidiary of a participating organisation:

    • A participating publishing organisation will additionally include a type of ‘PPO’.
    • A participating subscribing organisation will additionally include a type of ‘PSO’.
    • A subsidiary organisation will only have a type of ‘LEO’.
Address lines

When a PCA Organization is retrieved by a publishing or subscribing system, the line elements for address (if present) are populated by PCA using the same rules that are defined in the usage notes of the PCA Postal Address extension.

Supported interactions

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


SD.18.1 Formal views of profile content

The official URL for this profile is: 

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

This profile of Organization defines an organisation, in an Australian healthcare context, as supported by the Provider Connect Australia (PCA) service.

This profile builds on AUBaseOrganisation.

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
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
inv-pca-1: Organization shall not have both ABN and HPI-O identifiers
inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization
inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization
inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist
inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist
inv-pca-6: If type is 'HIO', no ABN identifier shall exist
inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO'
inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO'
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... pca-active-in-system-of-record S0..1(Complex)Whether this organization's record is active in a system of record (ABR, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
... pca-part-of-legal-entity S0..1Reference(PCA Organization)The legal entity of which this organisation is part
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity
... Slices for identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hpio S0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn S0..1AUAustralianBusinessNumberAustralian Business Number (ABN)
.... identifier:pca-oi S0..1PcaOrganizationIdentifierPCA Organization Identifier (PCA-OI) issued by the PCA service
... active S1..1booleanWhether the organization's record is still in active use
... type S1..*CodeableConceptKind of organization
Binding: PCA Organization Type (required)
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom S0..*ContactPointA contact detail for the organization
... address SC0..*AustralianAddressAn address for the organization
inv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier
inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier
inv-pca-11: address shall contain a maximum of 3 line elements
... partOf S0..1Reference(PCA Organization)The organization of which this organization forms a part

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
inv-pca-1: Organization shall not have both ABN and HPI-O identifiers
inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization
inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization
inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist
inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist
inv-pca-6: If type is 'HIO', no ABN identifier shall exist
inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO'
inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO'
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-active-in-system-of-record S0..1(Complex)Whether this organization's record is active in a system of record (ABR, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
... pca-part-of-legal-entity S0..1Reference(PCA Organization)The legal entity of which this organisation is part
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn SC0..1AUAustralianBusinessNumberAustralian Business Number (ABN)
.... identifier:pca-oi S0..1PcaOrganizationIdentifierPCA Organization Identifier (PCA-OI) issued by the PCA service
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*CodeableConceptKind of organization
Binding: PCA Organization Type (required)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
... address SC0..*AustralianAddressAn address for the organization
inv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier
inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier
inv-pca-11: address shall contain a maximum of 3 line elements
... partOf SΣ0..1Reference(PCA Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... 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
.... purpose 0..1CodeableConceptThe type of contact
Binding: Contact Purpose (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
inv-pca-1: Organization shall not have both ABN and HPI-O identifiers
inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization
inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization
inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist
inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist
inv-pca-6: If type is 'HIO', no ABN identifier shall exist
inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO'
inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO'
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... pca-active-in-system-of-record S0..1(Complex)Whether this organization's record is active in a system of record (ABR, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
... pca-part-of-legal-entity S0..1Reference(PCA Organization)The legal entity of which this organisation is part
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity
... Slices for identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hpio S0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn S0..1AUAustralianBusinessNumberAustralian Business Number (ABN)
.... identifier:pca-oi S0..1PcaOrganizationIdentifierPCA Organization Identifier (PCA-OI) issued by the PCA service
... active S1..1booleanWhether the organization's record is still in active use
... type S1..*CodeableConceptKind of organization
Binding: PCA Organization Type (required)
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom S0..*ContactPointA contact detail for the organization
... address SC0..*AustralianAddressAn address for the organization
inv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier
inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier
inv-pca-11: address shall contain a maximum of 3 line elements
... partOf S0..1Reference(PCA Organization)The organization of which this organization forms a part

doco Documentation for this format

Snapshot view

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
inv-pca-1: Organization shall not have both ABN and HPI-O identifiers
inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization
inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization
inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist
inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist
inv-pca-6: If type is 'HIO', no ABN identifier shall exist
inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO'
inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO'
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-active-in-system-of-record S0..1(Complex)Whether this organization's record is active in a system of record (ABR, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
... pca-part-of-legal-entity S0..1Reference(PCA Organization)The legal entity of which this organisation is part
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn SC0..1AUAustralianBusinessNumberAustralian Business Number (ABN)
.... identifier:pca-oi S0..1PcaOrganizationIdentifierPCA Organization Identifier (PCA-OI) issued by the PCA service
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*CodeableConceptKind of organization
Binding: PCA Organization Type (required)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
... address SC0..*AustralianAddressAn address for the organization
inv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier
inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier
inv-pca-11: address shall contain a maximum of 3 line elements
... partOf SΣ0..1Reference(PCA Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... 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
.... purpose 0..1CodeableConceptThe type of contact
Binding: Contact Purpose (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

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

 

SD.18.2 - Search parameters

No additional search parameters defined for this resource profile.

 

SD.18.3 - Known issues

No known issues.