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
| Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization | Version: 25.2.0.0 | |||
| Active as of 2025-10-23 | Computable Name: PcaOrganization | |||
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 profile of Organization defines an organisation, in an Australian healthcare context, as supported by the Provider Connect Australia (PCA) service.
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 introduced in this profile:
Instances of the telecom element are used to record the organisation's phone number, fax number, mobile number, email address and website, where applicable.
The PCA Organization profile explicitly supports the following identifier slices (as indicated by the must support flag):
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 Core Organization.
The PCA Organization profile is used to represent different types of organisations within the PCA service. An Organisation may have multiple types assigned.
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):
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 service interactions for this profile are defined in the following capability statements:
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context Constraints: org-1, inv-pca-1, inv-pca-2, inv-pca-3, inv-pca-4, inv-pca-5, inv-pca-6, inv-pca-7, inv-pca-8 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..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 |
![]() ![]() ![]() |
S | 0..1 | Reference(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 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 |
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems |
![]() ![]() ![]() |
SOΣC | 0..1 | AUAustralianBusinessNumber | Identifies this organization across multiple systems |
![]() ![]() ![]() |
SOΣC | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service Constraints: au-core-org-01 |
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
SOΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization |
![]() ![]() |
S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 |
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2, inv-pca-9, inv-pca-10, inv-pca-11 |
![]() ![]() |
SΣ | 0..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | required | PCA Organization Type | 📦25.2.0.0 | This IG |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:pca-oi | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| inv-pca-1 | error | Organization | Organization shall not have both ABN and HPI-O identifiers |
identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-2 | error | Organization | If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization |
extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/')
|
| inv-pca-3 | error | Organization | If present, partOf.reference shall be a relative reference to an Organization |
partOf.reference.exists() implies partOf.reference.startsWith('Organization/')
|
| inv-pca-4 | error | Organization | If type is 'LEO', no HPI-O identifier shall exist |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not()
|
| inv-pca-5 | error | Organization | If and only if type is 'HIO', HPI-O identifier shall exist |
(type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists())
|
| inv-pca-6 | error | Organization | If type is 'HIO', no ABN identifier shall exist |
type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-7 | error | Organization | The types shall include one and only one of 'LEO' and 'HIO' |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1
|
| inv-pca-8 | error | Organization | If one type is 'PPO' or 'PSO' another type shall be 'LEO' |
(type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not())
|
| inv-pca-9 | error | Organization.address | If present, at most one instance of the address element shall contain a DPID address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
|
| inv-pca-10 | error | Organization.address | If present, at most one instance of the address element shall contain a G-NAF address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
|
| inv-pca-11 | error | Organization.address | address shall contain a maximum of 3 line elements |
line.count() < 4
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from AUCoreOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context Constraints: inv-pca-1, inv-pca-2, inv-pca-3, inv-pca-4, inv-pca-5, inv-pca-6, inv-pca-7, inv-pca-8 |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..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 |
![]() ![]() ![]() |
S | 0..1 | Reference(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 |
![]() ![]() |
S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 0..1 | AUHPIO | Identifies this organization across multiple systems |
![]() ![]() ![]() |
S | 0..1 | AUAustralianBusinessNumber | Identifies this organization across multiple systems |
![]() ![]() ![]() |
S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service |
![]() ![]() |
S | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
S | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
![]() ![]() |
S | 1..1 | string | Name used for the organization |
![]() ![]() |
S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() |
SC | 0..* | AustralianAddress | An address for the organization Constraints: inv-pca-9, inv-pca-10, inv-pca-11 |
![]() ![]() |
S | 0..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | required | PCA Organization Type | 📦25.2.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| inv-pca-1 | error | Organization | Organization shall not have both ABN and HPI-O identifiers |
identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-2 | error | Organization | If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization |
extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/')
|
| inv-pca-3 | error | Organization | If present, partOf.reference shall be a relative reference to an Organization |
partOf.reference.exists() implies partOf.reference.startsWith('Organization/')
|
| inv-pca-4 | error | Organization | If type is 'LEO', no HPI-O identifier shall exist |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not()
|
| inv-pca-5 | error | Organization | If and only if type is 'HIO', HPI-O identifier shall exist |
(type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists())
|
| inv-pca-6 | error | Organization | If type is 'HIO', no ABN identifier shall exist |
type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-7 | error | Organization | The types shall include one and only one of 'LEO' and 'HIO' |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1
|
| inv-pca-8 | error | Organization | If one type is 'PPO' or 'PSO' another type shall be 'LEO' |
(type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not())
|
| inv-pca-9 | error | Organization.address | If present, at most one instance of the address element shall contain a DPID address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
|
| inv-pca-10 | error | Organization.address | If present, at most one instance of the address element shall contain a G-NAF address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
|
| inv-pca-11 | error | Organization.address | address shall contain a maximum of 3 line elements |
line.count() < 4
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context Constraints: org-1, inv-pca-1, inv-pca-2, inv-pca-3, inv-pca-4, inv-pca-5, inv-pca-6, inv-pca-7, inv-pca-8 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..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 | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(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 | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 | ||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUAustralianBusinessNumber | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() |
SOΣC | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service Constraints: au-core-org-01 | ||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() |
SOΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) | ||||
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization | ||||
![]() ![]() |
S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2, inv-pca-9, inv-pca-10, inv-pca-11 | ||||
![]() ![]() |
SΣ | 0..1 | Reference(PCA Organization) | The organization of which this organization forms a part | ||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | required | PCA Organization Type | 📦25.2.0.0 | This IG |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦6.0.0-ballot | AU Base Implementation Guide v6.0 |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:pca-oi | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| inv-pca-1 | error | Organization | Organization shall not have both ABN and HPI-O identifiers |
identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-2 | error | Organization | If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization |
extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/')
|
| inv-pca-3 | error | Organization | If present, partOf.reference shall be a relative reference to an Organization |
partOf.reference.exists() implies partOf.reference.startsWith('Organization/')
|
| inv-pca-4 | error | Organization | If type is 'LEO', no HPI-O identifier shall exist |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not()
|
| inv-pca-5 | error | Organization | If and only if type is 'HIO', HPI-O identifier shall exist |
(type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists())
|
| inv-pca-6 | error | Organization | If type is 'HIO', no ABN identifier shall exist |
type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-7 | error | Organization | The types shall include one and only one of 'LEO' and 'HIO' |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1
|
| inv-pca-8 | error | Organization | If one type is 'PPO' or 'PSO' another type shall be 'LEO' |
(type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not())
|
| inv-pca-9 | error | Organization.address | If present, at most one instance of the address element shall contain a DPID address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
|
| inv-pca-10 | error | Organization.address | If present, at most one instance of the address element shall contain a G-NAF address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
|
| inv-pca-11 | error | Organization.address | address shall contain a maximum of 3 line elements |
line.count() < 4
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from AUCoreOrganization
Summary
Mandatory: 2 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context Constraints: org-1, inv-pca-1, inv-pca-2, inv-pca-3, inv-pca-4, inv-pca-5, inv-pca-6, inv-pca-7, inv-pca-8 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..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 |
![]() ![]() ![]() |
S | 0..1 | Reference(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 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 |
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems |
![]() ![]() ![]() |
SOΣC | 0..1 | AUAustralianBusinessNumber | Identifies this organization across multiple systems |
![]() ![]() ![]() |
SOΣC | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service Constraints: au-core-org-01 |
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
SOΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization |
![]() ![]() |
S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 |
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2, inv-pca-9, inv-pca-10, inv-pca-11 |
![]() ![]() |
SΣ | 0..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | required | PCA Organization Type | 📦25.2.0.0 | This IG |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:pca-oi | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| inv-pca-1 | error | Organization | Organization shall not have both ABN and HPI-O identifiers |
identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-2 | error | Organization | If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization |
extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/')
|
| inv-pca-3 | error | Organization | If present, partOf.reference shall be a relative reference to an Organization |
partOf.reference.exists() implies partOf.reference.startsWith('Organization/')
|
| inv-pca-4 | error | Organization | If type is 'LEO', no HPI-O identifier shall exist |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not()
|
| inv-pca-5 | error | Organization | If and only if type is 'HIO', HPI-O identifier shall exist |
(type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists())
|
| inv-pca-6 | error | Organization | If type is 'HIO', no ABN identifier shall exist |
type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-7 | error | Organization | The types shall include one and only one of 'LEO' and 'HIO' |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1
|
| inv-pca-8 | error | Organization | If one type is 'PPO' or 'PSO' another type shall be 'LEO' |
(type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not())
|
| inv-pca-9 | error | Organization.address | If present, at most one instance of the address element shall contain a DPID address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
|
| inv-pca-10 | error | Organization.address | If present, at most one instance of the address element shall contain a G-NAF address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
|
| inv-pca-11 | error | Organization.address | address shall contain a maximum of 3 line elements |
line.count() < 4
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
Differential View
This structure is derived from AUCoreOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context Constraints: inv-pca-1, inv-pca-2, inv-pca-3, inv-pca-4, inv-pca-5, inv-pca-6, inv-pca-7, inv-pca-8 |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..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 |
![]() ![]() ![]() |
S | 0..1 | Reference(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 |
![]() ![]() |
S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 0..1 | AUHPIO | Identifies this organization across multiple systems |
![]() ![]() ![]() |
S | 0..1 | AUAustralianBusinessNumber | Identifies this organization across multiple systems |
![]() ![]() ![]() |
S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service |
![]() ![]() |
S | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
S | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
![]() ![]() |
S | 1..1 | string | Name used for the organization |
![]() ![]() |
S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() |
SC | 0..* | AustralianAddress | An address for the organization Constraints: inv-pca-9, inv-pca-10, inv-pca-11 |
![]() ![]() |
S | 0..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | required | PCA Organization Type | 📦25.2.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| inv-pca-1 | error | Organization | Organization shall not have both ABN and HPI-O identifiers |
identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-2 | error | Organization | If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization |
extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/')
|
| inv-pca-3 | error | Organization | If present, partOf.reference shall be a relative reference to an Organization |
partOf.reference.exists() implies partOf.reference.startsWith('Organization/')
|
| inv-pca-4 | error | Organization | If type is 'LEO', no HPI-O identifier shall exist |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not()
|
| inv-pca-5 | error | Organization | If and only if type is 'HIO', HPI-O identifier shall exist |
(type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists())
|
| inv-pca-6 | error | Organization | If type is 'HIO', no ABN identifier shall exist |
type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-7 | error | Organization | The types shall include one and only one of 'LEO' and 'HIO' |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1
|
| inv-pca-8 | error | Organization | If one type is 'PPO' or 'PSO' another type shall be 'LEO' |
(type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not())
|
| inv-pca-9 | error | Organization.address | If present, at most one instance of the address element shall contain a DPID address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
|
| inv-pca-10 | error | Organization.address | If present, at most one instance of the address element shall contain a G-NAF address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
|
| inv-pca-11 | error | Organization.address | address shall contain a maximum of 3 line elements |
line.count() < 4
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context Constraints: org-1, inv-pca-1, inv-pca-2, inv-pca-3, inv-pca-4, inv-pca-5, inv-pca-6, inv-pca-7, inv-pca-8 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..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 | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(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 | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 | ||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUAustralianBusinessNumber | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() |
SOΣC | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service Constraints: au-core-org-01 | ||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() |
SOΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) | ||||
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization | ||||
![]() ![]() |
S | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2, inv-pca-9, inv-pca-10, inv-pca-11 | ||||
![]() ![]() |
SΣ | 0..1 | Reference(PCA Organization) | The organization of which this organization forms a part | ||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | required | PCA Organization Type | 📦25.2.0.0 | This IG |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦6.0.0-ballot | AU Base Implementation Guide v6.0 |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:pca-oi | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| inv-pca-1 | error | Organization | Organization shall not have both ABN and HPI-O identifiers |
identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-2 | error | Organization | If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization |
extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/')
|
| inv-pca-3 | error | Organization | If present, partOf.reference shall be a relative reference to an Organization |
partOf.reference.exists() implies partOf.reference.startsWith('Organization/')
|
| inv-pca-4 | error | Organization | If type is 'LEO', no HPI-O identifier shall exist |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not()
|
| inv-pca-5 | error | Organization | If and only if type is 'HIO', HPI-O identifier shall exist |
(type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists())
|
| inv-pca-6 | error | Organization | If type is 'HIO', no ABN identifier shall exist |
type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not()
|
| inv-pca-7 | error | Organization | The types shall include one and only one of 'LEO' and 'HIO' |
type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1
|
| inv-pca-8 | error | Organization | If one type is 'PPO' or 'PSO' another type shall be 'LEO' |
(type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not())
|
| inv-pca-9 | error | Organization.address | If present, at most one instance of the address element shall contain a DPID address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
|
| inv-pca-10 | error | Organization.address | If present, at most one instance of the address element shall contain a G-NAF address identifier |
extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
|
| inv-pca-11 | error | Organization.address | address shall contain a maximum of 3 line elements |
line.count() < 4
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from AUCoreOrganization
Summary
Mandatory: 2 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
No additional search parameters defined for this resource profile.