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-Snapshot-26.0.0-SPARKED-Testing-20260708/ and changes regularly. See the Directory of published versions

Resource Profile: HCPD Organization

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization Version: 26.0.0
Active as of 2026-07-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

Extensions introduced in this profile:

Suppressed

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, it's 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.

Organisation classification

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]

Usage notes

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.

Identifiers

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.

Name suppression

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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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:suppressed SO 0..1 (Complex) Hide Resource in Directory
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
..... 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 S 1..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "suppressedBy"
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding SΣ 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value: As shown (Organisation initiated)
......... id 0..0 string Unique id for inter-element referencing
......... extension 0..0 Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
......... version 0..0 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: organisation-initiated
......... display 0..0 string Representation defined by the system
......... userSelected 0..0 boolean If this coding was chosen directly by the user
..... url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... identifier:hpio SOΣC 0..1 HCPD_HPIO_Identifier(26.0.0) HPI-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:abn SOΣC 1..1 AUAustralianBusinessNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:hspo SOΣC 0..1 HCPD_HSPO_Identifier(26.0.0) HSP-O identifier
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:acn SOΣC 0..1 AUAustralianCompanyNumber(6.0.0) Identifies this organization across multiple systems
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type SOΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SOΣC 1..1 string Name of Directory Entry Organisation
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... system SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... value SOΣ 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... Slices for address SOC 1..1 Address(4.0.1), AustralianAddress(6.0.0) Addresses of Directory Entry Organisation
Slice: Unordered, Open by value:type
Constraints: org-2
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... address:physical SOC 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
... partOf SOΣ 0..1 Reference(HCPD Organization(26.0.0)) The organization of which this organization forms a part
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Organization.type Base preferred Healthcare Organisation Role Type . ⏿1.1.0 tx.hl7.org.au
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.

Constraints

Id Grade Path(s) Description Expression
au-core-org-01 error Organization.identifier, Organization.identifier:hspo, Organization.identifier:acn A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Organization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Organization.implicitRules, Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.extension:suppressed.extension:suppressedBy.value[x], Organization.extension:suppressed.extension:suppressedBy.value[x].coding, Organization.modifierExtension, Organization.identifier, Organization.identifier:hpio, Organization.identifier:abn, Organization.identifier:hspo, Organization.identifier:acn, Organization.active, Organization.type, Organization.name, Organization.name.extension, Organization.name.extension:dataAbsentReason, Organization.telecom, Organization.telecom.system, Organization.telecom.value, Organization.telecom.use, Organization.address, Organization.address:physical, Organization.address:physical.use, Organization.address:physical.type, Organization.partOf All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.modifierExtension, Organization.name.extension, Organization.name.extension:dataAbsentReason Must have either extensions or value[x], not both extension.exists() != value.exists()
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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address, Organization.address:physical An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* AUCoreOrganization(2.0.0) Australian Organisation Directory Entry
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppressed SO 0..1 (Complex) Hide Resource in Directory
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
..... Slices for extension Content/Rules for all slices
...... extension:suppressedBy 1..1 Extension Extension
....... value[x]
........ coding S 1..1 Coding Code defined by a terminology system
Fixed Value: As shown (Organisation initiated)
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: organisation-initiated
... 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 O 0..1 HCPD_HPIO_Identifier(26.0.0) HPI-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:abn O 1..1 AUAustralianBusinessNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:hspo SO 0..1 HCPD_HSPO_Identifier(26.0.0) HSP-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:acn SO 0..1 AUAustralianCompanyNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 O 0..* ContactPoint A contact detail for the organization
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... system O 0..1 code phone | fax | email | pager | url | sms | other
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... value O 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... Slices for address O 1..1 Address(4.0.1), AustralianAddress(6.0.0) Addresses of Directory Entry Organisation
Slice: Unordered, Open by value:type
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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
... partOf SO 0..1 Reference(HCPD Organization(26.0.0)) The organization of which this organization forms a part
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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:suppressed SO 0..1 (Complex) Hide Resource in Directory
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
..... 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 S 1..1 Extension Extension
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] S 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 SΣ 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value: As shown (Organisation initiated)
......... id 0..0 string Unique id for inter-element referencing
......... extension 0..0 Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
......... version 0..0 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: organisation-initiated
......... display 0..0 string Representation defined by the system
......... userSelected 0..0 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
..... 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 SOΣ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
.... identifier:hpio SOΣC 0..1 HCPD_HPIO_Identifier(26.0.0) HPI-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:abn SOΣC 1..1 AUAustralianBusinessNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:hspo SOΣC 0..1 HCPD_HSPO_Identifier(26.0.0) HSP-O identifier
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:acn SOΣC 0..1 AUAustralianCompanyNumber(6.0.0) Identifies this organization across multiple systems
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type SOΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SOΣC 1..1 string Name of Directory Entry Organisation
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... value SOΣ 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOC 1..1 Address(4.0.1), AustralianAddress(6.0.0) Addresses of Directory Entry Organisation
Slice: Unordered, Open by value:type
Constraints: org-2
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... address:physical SOC 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
..... 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 SOΣ 0..1 Reference(HCPD Organization(26.0.0)) The organization of which this organization forms a part
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Organization.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Organization.type Base preferred Healthcare Organisation Role Type . ⏿1.1.0 tx.hl7.org.au
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

Constraints

Id Grade Path(s) Description Expression
au-core-org-01 error Organization.identifier, Organization.identifier:hspo, Organization.identifier:acn A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Organization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Organization.meta, Organization.implicitRules, Organization.language, Organization.text, Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.extension:suppressed.extension:suppressedBy.value[x], Organization.extension:suppressed.extension:suppressedBy.value[x].extension, Organization.extension:suppressed.extension:suppressedBy.value[x].coding, Organization.extension:suppressed.extension:suppressedBy.value[x].text, Organization.modifierExtension, Organization.identifier, Organization.identifier:hpio, Organization.identifier:abn, Organization.identifier:hspo, Organization.identifier:acn, Organization.active, Organization.type, Organization.name, Organization.name.extension, Organization.name.extension:dataAbsentReason, Organization.alias, Organization.telecom, Organization.telecom.extension, Organization.telecom.system, Organization.telecom.value, Organization.telecom.use, Organization.telecom.rank, Organization.telecom.period, Organization.address, Organization.address:physical, Organization.address:physical.extension, Organization.address:physical.use, Organization.address:physical.type, Organization.address:physical.text, Organization.address:physical.line, Organization.address:physical.city, Organization.address:physical.district, Organization.address:physical.state, Organization.address:physical.postalCode, Organization.address:physical.country, Organization.address:physical.period, Organization.partOf, Organization.contact, Organization.contact.extension, Organization.contact.modifierExtension, Organization.contact.purpose, Organization.contact.name, Organization.contact.telecom, Organization.contact.address, Organization.endpoint All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.extension:suppressed.extension:suppressedBy.value[x].extension, Organization.modifierExtension, Organization.name.extension, Organization.name.extension:dataAbsentReason, Organization.telecom.extension, Organization.address:physical.extension, Organization.contact.extension, Organization.contact.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address, Organization.address:physical An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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:suppressed SO 0..1 (Complex) Hide Resource in Directory
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
..... 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 S 1..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "suppressedBy"
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding SΣ 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value: As shown (Organisation initiated)
......... id 0..0 string Unique id for inter-element referencing
......... extension 0..0 Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
......... version 0..0 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: organisation-initiated
......... display 0..0 string Representation defined by the system
......... userSelected 0..0 boolean If this coding was chosen directly by the user
..... url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... identifier:hpio SOΣC 0..1 HCPD_HPIO_Identifier(26.0.0) HPI-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:abn SOΣC 1..1 AUAustralianBusinessNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:hspo SOΣC 0..1 HCPD_HSPO_Identifier(26.0.0) HSP-O identifier
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:acn SOΣC 0..1 AUAustralianCompanyNumber(6.0.0) Identifies this organization across multiple systems
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type SOΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SOΣC 1..1 string Name of Directory Entry Organisation
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... system SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... value SOΣ 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... Slices for address SOC 1..1 Address(4.0.1), AustralianAddress(6.0.0) Addresses of Directory Entry Organisation
Slice: Unordered, Open by value:type
Constraints: org-2
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... address:physical SOC 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
... partOf SOΣ 0..1 Reference(HCPD Organization(26.0.0)) The organization of which this organization forms a part
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Organization.type Base preferred Healthcare Organisation Role Type . ⏿1.1.0 tx.hl7.org.au
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.

Constraints

Id Grade Path(s) Description Expression
au-core-org-01 error Organization.identifier, Organization.identifier:hspo, Organization.identifier:acn A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Organization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Organization.implicitRules, Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.extension:suppressed.extension:suppressedBy.value[x], Organization.extension:suppressed.extension:suppressedBy.value[x].coding, Organization.modifierExtension, Organization.identifier, Organization.identifier:hpio, Organization.identifier:abn, Organization.identifier:hspo, Organization.identifier:acn, Organization.active, Organization.type, Organization.name, Organization.name.extension, Organization.name.extension:dataAbsentReason, Organization.telecom, Organization.telecom.system, Organization.telecom.value, Organization.telecom.use, Organization.address, Organization.address:physical, Organization.address:physical.use, Organization.address:physical.type, Organization.partOf All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.modifierExtension, Organization.name.extension, Organization.name.extension:dataAbsentReason Must have either extensions or value[x], not both extension.exists() != value.exists()
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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address, Organization.address:physical An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

Differential View

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* AUCoreOrganization(2.0.0) Australian Organisation Directory Entry
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppressed SO 0..1 (Complex) Hide Resource in Directory
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
..... Slices for extension Content/Rules for all slices
...... extension:suppressedBy 1..1 Extension Extension
....... value[x]
........ coding S 1..1 Coding Code defined by a terminology system
Fixed Value: As shown (Organisation initiated)
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: organisation-initiated
... 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 O 0..1 HCPD_HPIO_Identifier(26.0.0) HPI-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:abn O 1..1 AUAustralianBusinessNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:hspo SO 0..1 HCPD_HSPO_Identifier(26.0.0) HSP-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:acn SO 0..1 AUAustralianCompanyNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 O 0..* ContactPoint A contact detail for the organization
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... system O 0..1 code phone | fax | email | pager | url | sms | other
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... value O 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... Slices for address O 1..1 Address(4.0.1), AustralianAddress(6.0.0) Addresses of Directory Entry Organisation
Slice: Unordered, Open by value:type
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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
... partOf SO 0..1 Reference(HCPD Organization(26.0.0)) The organization of which this organization forms a part
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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:suppressed SO 0..1 (Complex) Hide Resource in Directory
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
..... 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 S 1..1 Extension Extension
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] S 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 SΣ 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value: As shown (Organisation initiated)
......... id 0..0 string Unique id for inter-element referencing
......... extension 0..0 Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
......... version 0..0 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: organisation-initiated
......... display 0..0 string Representation defined by the system
......... userSelected 0..0 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
..... 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 SOΣ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
.... identifier:hpio SOΣC 0..1 HCPD_HPIO_Identifier(26.0.0) HPI-O identifier
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:abn SOΣC 1..1 AUAustralianBusinessNumber(6.0.0) Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:hspo SOΣC 0..1 HCPD_HSPO_Identifier(26.0.0) HSP-O identifier
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... identifier:acn SOΣC 0..1 AUAustralianCompanyNumber(6.0.0) Identifies this organization across multiple systems
Constraints: au-core-org-01
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type SOΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SOΣC 1..1 string Name of Directory Entry Organisation
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... value SOΣ 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... 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 SOC 1..1 Address(4.0.1), AustralianAddress(6.0.0) Addresses of Directory Entry Organisation
Slice: Unordered, Open by value:type
Constraints: org-2
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
.... address:physical SOC 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
..... 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 SOΣ 0..1 Reference(HCPD Organization(26.0.0)) The organization of which this organization forms a part
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Organization.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Organization.type Base preferred Healthcare Organisation Role Type . ⏿1.1.0 tx.hl7.org.au
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

Constraints

Id Grade Path(s) Description Expression
au-core-org-01 error Organization.identifier, Organization.identifier:hspo, Organization.identifier:acn A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Organization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Organization.meta, Organization.implicitRules, Organization.language, Organization.text, Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.extension:suppressed.extension:suppressedBy.value[x], Organization.extension:suppressed.extension:suppressedBy.value[x].extension, Organization.extension:suppressed.extension:suppressedBy.value[x].coding, Organization.extension:suppressed.extension:suppressedBy.value[x].text, Organization.modifierExtension, Organization.identifier, Organization.identifier:hpio, Organization.identifier:abn, Organization.identifier:hspo, Organization.identifier:acn, Organization.active, Organization.type, Organization.name, Organization.name.extension, Organization.name.extension:dataAbsentReason, Organization.alias, Organization.telecom, Organization.telecom.extension, Organization.telecom.system, Organization.telecom.value, Organization.telecom.use, Organization.telecom.rank, Organization.telecom.period, Organization.address, Organization.address:physical, Organization.address:physical.extension, Organization.address:physical.use, Organization.address:physical.type, Organization.address:physical.text, Organization.address:physical.line, Organization.address:physical.city, Organization.address:physical.district, Organization.address:physical.state, Organization.address:physical.postalCode, Organization.address:physical.country, Organization.address:physical.period, Organization.partOf, Organization.contact, Organization.contact.extension, Organization.contact.modifierExtension, Organization.contact.purpose, Organization.contact.name, Organization.contact.telecom, Organization.contact.address, Organization.endpoint All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.extension, Organization.extension:suppressed, Organization.extension:suppressed.extension, Organization.extension:suppressed.extension:suppressedBy, Organization.extension:suppressed.extension:suppressedBy.value[x].extension, Organization.modifierExtension, Organization.name.extension, Organization.name.extension:dataAbsentReason, Organization.telecom.extension, Organization.address:physical.extension, Organization.contact.extension, Organization.contact.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address, Organization.address:physical An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search parameters for HCPD Organization

This IG defines no new SearchParameters for the Organization resource; it expects implementers to support common Organization parameters from both AU Core and R4.

Search parameters defined within AU Core

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`

Search parameters defined within FHIR R4

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.

Search parameters defined in this IG

The following search parameters are defined by this IG and SHOULD be supported:

  • suppressed (Organization.extension where url = suppressedBy extension)
    • Search for organizations by their suppression status. Use token semantics with a code from the Responsible Party Type CodeSystem.
    • Example (system|code): GET /Organization?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|organisation-initiated
    • Example (code only): GET /Organization?suppressed=organisation-initiated
    • Example (system only): GET /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

Search include parameters

This implementation supports the following _include parameters when searching for Organization resources:

  • _include=Organization:partOf - Include parent organizations referenced by the partOf element

Search reverse include parameters

This 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 Organization

Example usage

GET /Organization/123?_revinclude=Location:organization&_revinclude=HealthcareService:organization

This query returns the Organization resource along with all associated Locations and HealthcareServices.