Provider Connect Australia (PCA)
2.4.3 - active
Provider Connect Australia (PCA) - Local Development build (v2.4.3) 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: 2.4.3 | |||
Active as of 2024-03-19 | 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:
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 Base Organization.
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:
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:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseOrganisation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An 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..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | When the resource version last changed |
pca-active-in-system-of-record | 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 |
pca-part-of-legal-entity | 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 |
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
identifier:abn | S | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) |
identifier:pca-oi | S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
type | S | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
name | S | 1..1 | string | Name used for the organization |
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
telecom | S | 0..* | ContactPoint | A contact detail for the organization |
address | SC | 0..* | AustralianAddress | An 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..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | PcaOrganizationType (a valid code from PCA Organization Type)http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
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 |
---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
versionId | SΣ | 0..1 | id | Version specific identifier |
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
pca-active-in-system-of-record | 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 |
pca-part-of-legal-entity | 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 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check |
identifier:abn | SC | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits |
identifier:pca-oi | S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
name | SΣC | 1..1 | string | Name used for the organization |
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
address | SC | 0..* | AustralianAddress | An address for the organization inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' org-2: An address of an organization can never be of use 'home' 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..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | PcaOrganizationType (a valid code from PCA Organization Type)http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
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 | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
pca-active-in-system-of-record | 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 | ||||
pca-part-of-legal-entity | 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 | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check | ||||
identifier:abn | SC | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits | ||||
identifier:pca-oi | S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
address | SC | 0..* | AustralianAddress | An address for the organization inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' org-2: An address of an organization can never be of use 'home' 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..1 | Reference(PCA Organization) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.type | required | PcaOrganizationType (a valid code from PCA Organization Type)http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type from this IG | ||||
Organization.contact.purpose | extensible | ContactPurposehttp://terminology.hl7.org.au/ValueSet/contact-purpose |
Id | Grade | Path(s) | Details | Requirements |
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 |
This structure is derived from AUBaseOrganisation
Summary
Mandatory: 3 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBaseOrganisation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An 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..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | When the resource version last changed |
pca-active-in-system-of-record | 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 |
pca-part-of-legal-entity | 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 |
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
identifier:abn | S | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) |
identifier:pca-oi | S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
type | S | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
name | S | 1..1 | string | Name used for the organization |
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
telecom | S | 0..* | ContactPoint | A contact detail for the organization |
address | SC | 0..* | AustralianAddress | An 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..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | PcaOrganizationType (a valid code from PCA Organization Type)http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
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 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
versionId | SΣ | 0..1 | id | Version specific identifier |
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
pca-active-in-system-of-record | 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 |
pca-part-of-legal-entity | 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 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check |
identifier:abn | SC | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits |
identifier:pca-oi | S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) |
name | SΣC | 1..1 | string | Name used for the organization |
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
address | SC | 0..* | AustralianAddress | An address for the organization inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' org-2: An address of an organization can never be of use 'home' 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..1 | Reference(PCA Organization) | The organization of which this organization forms a part |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | PcaOrganizationType (a valid code from PCA Organization Type)http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
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 | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
pca-active-in-system-of-record | 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 | ||||
pca-part-of-legal-entity | 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 | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check | ||||
identifier:abn | SC | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits | ||||
identifier:pca-oi | S | 0..1 | PcaOrganizationIdentifier | PCA Organization Identifier (PCA-OI) issued by the PCA service | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: PCA Organization Type (required) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
address | SC | 0..* | AustralianAddress | An address for the organization inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' org-2: An address of an organization can never be of use 'home' 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..1 | Reference(PCA Organization) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.type | required | PcaOrganizationType (a valid code from PCA Organization Type)http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type from this IG | ||||
Organization.contact.purpose | extensible | ContactPurposehttp://terminology.hl7.org.au/ValueSet/contact-purpose |
Id | Grade | Path(s) | Details | Requirements |
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 |
This structure is derived from AUBaseOrganisation
Summary
Mandatory: 3 elements
Must-Support: 17 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.