Health Connect Australia Provider Directory FHIR Implementation Guide
26.0.0
Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD/ and changes regularly. See the Directory of published versions
| Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization | Version: 26.0.0 | |||
| Active as of 2026-11-03 | Computable Name: HCPD_Organization | |||
Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/ |
||||
This profile defines a Health Connect Provider Directory entry for an organisation.
This profile addresses the business need for standardised organisation representation in the Health Connect Provider Directory, ensuring consistent capture of healthcare organisation details including identifiers, classifications, and contact information for directory services.
No data is entered directly into Health Connect; all Directory content is sourced from authoritative systems including PCA, HI-Service, and NHSD.
Extensions introduced in this profile:
The extension:suppressed is used to indicate if this resource should be hidden from display in the Provider Directory. An Organisation may elect to hide their visibility from those searching the Health Connect Provider Directory system. When this extension is applied to a HCPD Organization resource, its use is constrained to just the organisation-initiated code. When present it SHALL be excluded from Provider Directory listings. For more details, please see the extension intro notes.
The extension:hi-org-classification is used to indicate whether an organisation's HPI-O and HSP-O record in the HI Service is classified as a 'seed' or 'network' type. Note HSP-O can only be of 'seed' type.
The following identifiers both profile the aforementioned classification extension within their definitions: * HCPD HPI-O on Organization.identifier[hpio] * HCPD HSP-O on Organization.identifier[hspo]
The following guidance maps key information requirements for HCPD Organization records to fields in the profile. Where a requirement references the HI Service as the authoritative source, publishers SHOULD prefer and validate values-such as organisation identifiers and names-against the HI Service where practicable.
The HCPD Organization profile supports the identifier slices introduced in AU Core (as indicated by the must support flag). At least one authoritative identifier (for example HPI-O, HSP-O, ABN, or other recognised identifier) SHOULD be provided to enable consistent and correct identification of the healthcare organisation and to support validation against the HI Service where applicable. Organisation identifiers can also be used as search parameters to locate organisation records.
A HCPD Organization resource may also contain additional business partner identifiers. These are considered secondary to the HPI-O/HSP-O and MAY not match identifier slices defined in AU Core Organization.
Where the organisation name must not be disclosed, implementers MAY populate Organization.name using the Data Absent Reason extension and set the code to masked.
Note: HI Service is expected to assign only one national identifier type to an Organization (either HPI‑O or HSP‑O), not both. As such, the profile defines the following invariants:
inv-01-identifier-hpi-or-hsp-required: Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. (severity: error)inv-02-identifier-not-both-hpio-hspo: Warn if both HPI-O and HSP-O identifiers are present on the same Organization. (severity: warning)Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.type | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | Not State | Unknown |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| inv-01-identifier-hpi-or-hsp-required | error | Organization | Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() or identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists()
|
| inv-02-identifier-not-both-hpio-hspo | warning | Organization | Warn if both HPI-O and HSP-O identifiers are present on the same Organization; HI Service is expected to assign only one. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists().not() and identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists().not()
|
This structure is derived from AUCoreOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Organization |
C | 0..* | AUCoreOrganization(2.0.0) | Australian Organisation Directory Entry | ||||||||||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
   extension:deactivated |
0..1 | (Complex) | Who initiated deactivation URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
| |||||||||||||
   Slices for extension |
Content/Rules for all slices | |||||||||||||||
  extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation | |||||||||||||
 value[x] |
||||||||||||||||
 coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||||||
| extension:suppressed |
0..1 | (Complex) | Hide Resource in Directory URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
| |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression | |||||||||||||
| value[x] |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||||||
 identifier |
1..* | Identifier(4.0.1), AUHPIO(6.0.0), AUPAIOIdentifier(6.0.0), AUCSPRegistrationNumber(6.0.0), AUAustralianBusinessNumber(6.0.0), AUAustralianCompanyNumber(6.0.0), AUAustralianRegisteredBodyNumber(6.0.0), AUNATAAccreditationNumber(6.0.0), AUPharmacyApprovalNumber(6.0.0) | Identifies this organization across multiple systems | |||||||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||||||
 identifier:hpio |
0..1 | HCPD_HPIO_Identifier(26.0.0) | HPI-O identifier
| |||||||||||||
| identifier:abn |
1..1 | AUAustralianBusinessNumber(6.0.0) | Identifies this organization across multiple systems
| |||||||||||||
| identifier:hspo |
0..1 | HCPD_HSPO_Identifier(26.0.0) | HSP-O identifier
| |||||||||||||
 identifier:acn |
0..1 | AUAustralianCompanyNumber(6.0.0) | Identifies this organization across multiple systems
| |||||||||||||
| active |
1..1 | boolean | Whether the organization's record is still in active use
| |||||||||||||
| name |
1..1 | string | Name of Directory Entry Organisation
| |||||||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:dataAbsentReason |
0..1 | code | Use when business name is to be masked URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||||||||||
| telecom |
0..* | ContactPoint | A contact detail for the organization
| |||||||||||||
| system |
0..1 | code | phone | fax | email | pager | url | sms | other
| |||||||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||||||
| Slices for address |
1..1 | Address(4.0.1), AustralianAddress(6.0.0) | Addresses of Directory Entry Organisation Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| address:physical |
1..1 | Address(4.0.1), AustralianAddress(6.0.0) | Registered Business Address of the organisation, as recorded against the HPI-O record. | |||||||||||||
 type |
1..1 | code | postal | physical | both Required Pattern: physical (extensions allowed) | |||||||||||||
 partOf |
0..1 | Reference(HCPD Organization(26.0.0)) | The organization of which this organization forms a part
| |||||||||||||
| Documentation for this format | ||||||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| inv-01-identifier-hpi-or-hsp-required | error | Organization | Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() or identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists()
|
| inv-02-identifier-not-both-hpio-hspo | warning | Organization | Warn if both HPI-O and HSP-O identifiers are present on the same Organization; HI Service is expected to assign only one. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists().not() and identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists().not()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization(2.0.0) | Australian Organisation Directory Entry Constraints: org-1, inv-01-identifier-hpi-or-hsp-required, inv-02-identifier-not-both-hpio-hspo | ||||||||||||
 id |
0..1 | id | Logical id of this artifact | |||||||||||||
 meta |
0..1 | Meta | Metadata about the resource | |||||||||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | Who initiated deactivation URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
 Slices for extension |
Content/Rules for all slices | |||||||||||||||
 extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
| extension:suppressed |
0..1 | (Complex) | Hide Resource in Directory URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
| value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
C | 1..* | Identifier(4.0.1)  , AUHPIO(6.0.0) , AUPAIOIdentifier(6.0.0) , AUCSPRegistrationNumber(6.0.0) , AUAustralianBusinessNumber(6.0.0) , AUAustralianCompanyNumber(6.0.0) , AUAustralianRegisteredBodyNumber(6.0.0) , AUNATAAccreditationNumber(6.0.0) , AUPharmacyApprovalNumber(6.0.0) |
Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||
| identifier:hpio |
C | 0..1 | HCPD_HPIO_Identifier(26.0.0) | HPI-O identifier Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
| ||||||||||||
| identifier:abn |
C | 1..1 | AUAustralianBusinessNumber(6.0.0) |
Identifies this organization across multiple systems
| ||||||||||||
| identifier:hspo |
C | 0..1 | HCPD_HSPO_Identifier(26.0.0) | HSP-O identifier
| ||||||||||||
| identifier:acn |
C | 0..1 | AUAustralianCompanyNumber(6.0.0) |
Identifies this organization across multiple systems
| ||||||||||||
| active |
1..1 | boolean | Whether the organization's record is still in active use
| |||||||||||||
| type |
0..* | CodeableConcept | Kind of organization Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred) | |||||||||||||
| name |
C | 1..1 | string | Name of Directory Entry Organisation
| ||||||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:dataAbsentReason |
0..1 | code | Use when business name is to be masked URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) Constraints: ext-1 | |||||||||||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||||||||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||||||||||
| telecom |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||||||
| Slices for address |
C | 1..1 | Address(4.0.1) , AustralianAddress(6.0.0) |
Addresses of Directory Entry Organisation Slice: Unordered, Open by value:type Constraints: org-2
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||
| address:physical |
C | 1..1 | Address(4.0.1) , AustralianAddress(6.0.0) |
Registered Business Address of the organisation, as recorded against the HPI-O record. Constraints: org-2 | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||||||
| type |
1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical (extensions allowed) | |||||||||||||
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||||||
| line |
0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||||||||||
| city |
0..1 | string | Name of city, town etc. Example General: Erewhon | |||||||||||||
| district |
0..1 | string | District name (aka county) Example General: Madison | |||||||||||||
| state |
0..1 | string | Sub-unit of country (abbreviations ok) | |||||||||||||
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |||||||||||||
| country |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||||||||||
| period |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||||||
| partOf |
0..1 | Reference(HCPD Organization(26.0.0)) | 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 Constraints: ext-1 | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactPurpose (6.0.0) (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 | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.type | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | Not State | Unknown |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📍6.0.0 | AU Base Implementation Guide v6.0 |
| Id | Grade | Path(s) | Description | Expression |
| inv-01-identifier-hpi-or-hsp-required | error | Organization | Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() or identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists()
|
| inv-02-identifier-not-both-hpio-hspo | warning | Organization | Warn if both HPI-O and HSP-O identifiers are present on the same Organization; HI Service is expected to assign only one. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists().not() and identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists().not()
|
This structure is derived from AUCoreOrganization
Summary
Mandatory: 6 elements
Must-Support: 8 elements
Fixed: 2 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: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization(2.0.0) | Australian Organisation Directory Entry Constraints: org-1, inv-01-identifier-hpi-or-hsp-required, inv-02-identifier-not-both-hpio-hspo | ||||||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | Who initiated deactivation URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
| extension:suppressed |
0..1 | (Complex) | Hide Resource in Directory URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
| value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
C | 1..* | Identifier(4.0.1) , AUHPIO(6.0.0) , AUPAIOIdentifier(6.0.0) , AUCSPRegistrationNumber(6.0.0) , AUAustralianBusinessNumber(6.0.0) , AUAustralianCompanyNumber(6.0.0) , AUAustralianRegisteredBodyNumber(6.0.0) , AUNATAAccreditationNumber(6.0.0) , AUPharmacyApprovalNumber(6.0.0) |
Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||
| identifier:hpio |
C | 0..1 | HCPD_HPIO_Identifier(26.0.0) | HPI-O identifier Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
| ||||||||||||
| identifier:abn |
C | 1..1 | AUAustralianBusinessNumber(6.0.0) |
Identifies this organization across multiple systems
| ||||||||||||
| identifier:hspo |
C | 0..1 | HCPD_HSPO_Identifier(26.0.0) | HSP-O identifier
| ||||||||||||
| identifier:acn |
C | 0..1 | AUAustralianCompanyNumber(6.0.0) |
Identifies this organization across multiple systems
| ||||||||||||
| active |
1..1 | boolean | Whether the organization's record is still in active use
| |||||||||||||
| type |
0..* | CodeableConcept | Kind of organization Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred) | |||||||||||||
| name |
C | 1..1 | string | Name of Directory Entry Organisation
| ||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:dataAbsentReason |
0..1 | code | Use when business name is to be masked URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) Constraints: ext-1 | |||||||||||||
| telecom |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| ||||||||||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||||||
| Slices for address |
C | 1..1 | Address(4.0.1) , AustralianAddress(6.0.0) |
Addresses of Directory Entry Organisation Slice: Unordered, Open by value:type Constraints: org-2
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||
| address:physical |
C | 1..1 | Address(4.0.1) , AustralianAddress(6.0.0) |
Registered Business Address of the organisation, as recorded against the HPI-O record. Constraints: org-2 | ||||||||||||
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||||||
| type |
1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical (extensions allowed) | |||||||||||||
| partOf |
0..1 | Reference(HCPD Organization(26.0.0)) | The organization of which this organization forms a part
| |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.type | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | Not State | Unknown |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| inv-01-identifier-hpi-or-hsp-required | error | Organization | Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() or identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists()
|
| inv-02-identifier-not-both-hpio-hspo | warning | Organization | Warn if both HPI-O and HSP-O identifiers are present on the same Organization; HI Service is expected to assign only one. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists().not() and identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists().not()
|
Differential View
This structure is derived from AUCoreOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization(2.0.0) | Australian Organisation Directory Entry | ||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | Who initiated deactivation URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
| |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation | |||||||||||||
| value[x] |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||||||
| extension:suppressed |
0..1 | (Complex) | Hide Resource in Directory URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
| |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression | |||||||||||||
| value[x] |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||||||
| identifier |
1..* | Identifier(4.0.1), AUHPIO(6.0.0), AUPAIOIdentifier(6.0.0), AUCSPRegistrationNumber(6.0.0), AUAustralianBusinessNumber(6.0.0), AUAustralianCompanyNumber(6.0.0), AUAustralianRegisteredBodyNumber(6.0.0), AUNATAAccreditationNumber(6.0.0), AUPharmacyApprovalNumber(6.0.0) | Identifies this organization across multiple systems | |||||||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||||||
| identifier:hpio |
0..1 | HCPD_HPIO_Identifier(26.0.0) | HPI-O identifier
| |||||||||||||
| identifier:abn |
1..1 | AUAustralianBusinessNumber(6.0.0) | Identifies this organization across multiple systems
| |||||||||||||
| identifier:hspo |
0..1 | HCPD_HSPO_Identifier(26.0.0) | HSP-O identifier
| |||||||||||||
| identifier:acn |
0..1 | AUAustralianCompanyNumber(6.0.0) | Identifies this organization across multiple systems
| |||||||||||||
| active |
1..1 | boolean | Whether the organization's record is still in active use
| |||||||||||||
| name |
1..1 | string | Name of Directory Entry Organisation
| |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:dataAbsentReason |
0..1 | code | Use when business name is to be masked URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||||||||||
| telecom |
0..* | ContactPoint | A contact detail for the organization
| |||||||||||||
| system |
0..1 | code | phone | fax | email | pager | url | sms | other
| |||||||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||||||
| Slices for address |
1..1 | Address(4.0.1), AustralianAddress(6.0.0) | Addresses of Directory Entry Organisation Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| address:physical |
1..1 | Address(4.0.1), AustralianAddress(6.0.0) | Registered Business Address of the organisation, as recorded against the HPI-O record. | |||||||||||||
| type |
1..1 | code | postal | physical | both Required Pattern: physical (extensions allowed) | |||||||||||||
| partOf |
0..1 | Reference(HCPD Organization(26.0.0)) | The organization of which this organization forms a part
| |||||||||||||
| Documentation for this format | ||||||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| inv-01-identifier-hpi-or-hsp-required | error | Organization | Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() or identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists()
|
| inv-02-identifier-not-both-hpio-hspo | warning | Organization | Warn if both HPI-O and HSP-O identifiers are present on the same Organization; HI Service is expected to assign only one. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists().not() and identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists().not()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization(2.0.0) | Australian Organisation Directory Entry Constraints: org-1, inv-01-identifier-hpi-or-hsp-required, inv-02-identifier-not-both-hpio-hspo | ||||||||||||
| id |
0..1 | id | Logical id of this artifact | |||||||||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | Who initiated deactivation URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
| extension:suppressed |
0..1 | (Complex) | Hide Resource in Directory URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
| value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
C | 1..* | Identifier(4.0.1) , AUHPIO(6.0.0) , AUPAIOIdentifier(6.0.0) , AUCSPRegistrationNumber(6.0.0) , AUAustralianBusinessNumber(6.0.0) , AUAustralianCompanyNumber(6.0.0) , AUAustralianRegisteredBodyNumber(6.0.0) , AUNATAAccreditationNumber(6.0.0) , AUPharmacyApprovalNumber(6.0.0) |
Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||
| identifier:hpio |
C | 0..1 | HCPD_HPIO_Identifier(26.0.0) | HPI-O identifier Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
| ||||||||||||
| identifier:abn |
C | 1..1 | AUAustralianBusinessNumber(6.0.0) |
Identifies this organization across multiple systems
| ||||||||||||
| identifier:hspo |
C | 0..1 | HCPD_HSPO_Identifier(26.0.0) | HSP-O identifier
| ||||||||||||
| identifier:acn |
C | 0..1 | AUAustralianCompanyNumber(6.0.0) |
Identifies this organization across multiple systems
| ||||||||||||
| active |
1..1 | boolean | Whether the organization's record is still in active use
| |||||||||||||
| type |
0..* | CodeableConcept | Kind of organization Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred) | |||||||||||||
| name |
C | 1..1 | string | Name of Directory Entry Organisation
| ||||||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:dataAbsentReason |
0..1 | code | Use when business name is to be masked URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) Constraints: ext-1 | |||||||||||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||||||||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||||||||||
| telecom |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||||||
| Slices for address |
C | 1..1 | Address(4.0.1) , AustralianAddress(6.0.0) |
Addresses of Directory Entry Organisation Slice: Unordered, Open by value:type Constraints: org-2
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||||||
| address:physical |
C | 1..1 | Address(4.0.1) , AustralianAddress(6.0.0) |
Registered Business Address of the organisation, as recorded against the HPI-O record. Constraints: org-2 | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||||||
| type |
1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical (extensions allowed) | |||||||||||||
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||||||
| line |
0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||||||||||
| city |
0..1 | string | Name of city, town etc. Example General: Erewhon | |||||||||||||
| district |
0..1 | string | District name (aka county) Example General: Madison | |||||||||||||
| state |
0..1 | string | Sub-unit of country (abbreviations ok) | |||||||||||||
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |||||||||||||
| country |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||||||||||
| period |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||||||
| partOf |
0..1 | Reference(HCPD Organization(26.0.0)) | 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 Constraints: ext-1 | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactPurpose (6.0.0) (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 | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Organization.type | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | Not State | Unknown |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📍6.0.0 | AU Base Implementation Guide v6.0 |
| Id | Grade | Path(s) | Description | Expression |
| inv-01-identifier-hpi-or-hsp-required | error | Organization | Either an HPI-O (hpio) or an HSP-O (hspo) identifier must be present on the Organization. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() or identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists()
|
| inv-02-identifier-not-both-hpio-hspo | warning | Organization | Warn if both HPI-O and HSP-O identifiers are present on the same Organization; HI Service is expected to assign only one. |
identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists().not() and identifier.where(system='http://ns.electronichealth.net.au/id/hi/hspo/1.0').exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0').exists().not()
|
This structure is derived from AUCoreOrganization
Summary
Mandatory: 6 elements
Must-Support: 8 elements
Fixed: 2 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
This IG defines no new SearchParameters for the Organization resource; it expects implementers to support common Organization parameters from both AU Core and R4.
How these identifier searches can be used is described in AU Core documentation. AU Core recommends using the standard FHIR identifier search parameter (token, system|value) for organization identifiers. Examples:
- ABN: `GET /Organization?identifier=http://hl7.org.au/id/abn|12345678912`
- ACN: `GET /Organization?identifier=http://hl7.org.au/id/acn|123456789`
- HPI-O: `GET /Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003626566707032`
- HSP-O: `GET /Organization?identifier=http://ns.electronichealth.net.au/id/hi/hspo/1.0|8003640001234569`
The following parameters are inherited from R4 and are commonly useful; implementers SHOULD support them as indicated.
name
Standard R4 parameter that searches Organization.name and Organization.alias (partial matches supported). String type.
Example: GET /Organization?name=Example%20Aged
type
Standard R4 parameter that searches Organization.type.coding using token semantics (system|code).
Example: Organization?type=http://snomed.info/sct|257652008
active
Standard R4 parameter that filters organizations by their active status (boolean token).
Example: GET /Organization?active=true
**Note:** Adding `?active=false` returns records that are inactive, Implementers should be aware that returned results MAY include records marked for suppression; it is the responsibility of the implementer that suppressed records SHALL be filtered out before display.
The following search parameters are defined by this IG and SHOULD be supported:
suppressed (Organization.extension where url = suppressedBy extension)
GET /Organization?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|organisation-initiatedGET /Organization?suppressed=organisation-initiatedGET /Organization?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| _id | SHOULD | token |
|
| HPI-O | SHOULD | token |
The Health Connect Provider Directory Requester and Provider Directory SHOULD support search using the HPI-O identifier as defined in the profile. |
| HSP-O | SHOULD | token |
The Health Connect Provider Directory Requester and Provider Directory SHOULD support search using the HSP-O identifier as defined in the profile. |
| ABN | SHOULD | token |
The Health Connect Provider Directory Requester and Provider Directory SHOULD support search using the ABN identifier as defined in the profile. |
| ACN | SHOULD | token |
Use the standard `identifier` token form. Example: ?identifier=http://hl7.org.au/id/acn|123456789 |
| name (R4) | SHOULD | string |
|
| type (R4) | SHOULD | token |
|
| active (R4) | SHOULD | token |
|
| suppressed | SHOULD | token |
|
| HPI-O + type | SHOULD | token + token |
This implementation supports the following _include parameters when searching for Organization resources:
_include=Organization:partof - Include parent organizations referenced by the partOf elementThis implementation supports the following _revinclude parameters when searching for Organization resources:
_revinclude=Location:organization - Include Location resources that reference this Organization through their managingOrganization element_revinclude=Provenance:target - Include Provenance resources that track changes to this OrganizationThis query returns a Bundle containing the Organization with id 123, plus any Location and HealthcareService resources that reference it.
GET /Organization?_id=123&_revinclude=Location:organization&_revinclude=HealthcareService:organization
This query returns a Bundle containing the Organization with id 123, plus any PractitionerRole resources where PractitionerRole.organization references that Organization.
GET /Organization?_id=123&_revinclude=PractitionerRole:organization
IG © 2026+ Australian Digital Health Agency. Package au.gov.digitalhealth.fhir.hcpd#26.0.0 based on FHIR 4.0.1. Generated 2026-11-03
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
