AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Organization

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization Version: 0.2.1-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreOrganization

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Organization resource to record, search, and fetch information about an organisation. It is based on the AU Base Organization profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Organization when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for basic information for an organisation by name or identifier
  • Recording or updating basic information for an organisation
  • Read information about an organisation referenced by another resource

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

No equivalent International Patient Access profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.
  • When constructing an address
    • an international address can be represented using the core Address data type
    • an Australian address SHOULD be represented using the Australian Address data type profile

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseOrganisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... Slices for identifier SC0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio S0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn S0..*AUAustralianBusinessNumberAustralian Business Number (ABN)
... active 0..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type S0..*CodeableConceptKind of organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom S0..*ContactPointA contact detail for the organization
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifierA National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
: where(type.coding.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')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SC0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn SC0..*AUAustralianBusinessNumberAustralian Business Number (ABN)
... type SΣ0..*CodeableConceptKind of organization
Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
... address SC0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifierA National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
: where(type.coding.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')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SC0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn SC0..*AUAustralianBusinessNumberAustralian Business Number (ABN)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type SΣ0..*CodeableConceptKind of organization
Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
... address SC0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: Contact Purpose (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.contact.purposeextensibleContactPurpose

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifierA National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
: where(type.coding.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')

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 1 element
Must-Support: 8 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of pattern:system

Maturity: 0

Differential View

This structure is derived from AUBaseOrganisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... Slices for identifier SC0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio S0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn S0..*AUAustralianBusinessNumberAustralian Business Number (ABN)
... active 0..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type S0..*CodeableConceptKind of organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom S0..*ContactPointA contact detail for the organization
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifierA National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
: where(type.coding.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')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SC0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn SC0..*AUAustralianBusinessNumberAustralian Business Number (ABN)
... type SΣ0..*CodeableConceptKind of organization
Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
... address SC0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifierA National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
: where(type.coding.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')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SC0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
.... identifier:abn SC0..*AUAustralianBusinessNumberAustralian Business Number (ABN)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type SΣ0..*CodeableConceptKind of organization
Binding: https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 (preferred)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
... address SC0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: Contact Purpose (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.contact.purposeextensibleContactPurpose

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifierA National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
: where(type.coding.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')

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 1 element
Must-Support: 8 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of pattern:system

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
address SHALL string
identifier SHALL token The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both.

The client SHOULD support search using HPI-O and ABN identifiers as defined in the profile. The server SHOULD support search using the using HPI-O and ABN identifiers as defined in the profile.
name SHALL string
_id SHOULD token

Specific feedback is sought on supporting search on Organization.address vs Organization.contact.address. The core FHIR search parameter `address` searches in Organization.contact.address. There is no core FHIR search parameter that searches Organization.adress.

Mandatory Search Parameters

The following search parameters SHALL be supported:

  1. SHALL support searching for an organisation based on text address using the address search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Organization?address=[string]

    Example:

    1. GET [base]/Organization?address=QLD

    Implementation Notes: Fetches a bundle of all Organization resources matching the name (how to search by string)

  2. SHALL support searching an organisation by an identifier using the identifier search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Organization?identifier={system|}[code]

    Example:

    1. GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455
    2. GET [base]/Organization?identifier=http://hl7.org.au/id/abn|23964200000

    Implementation Notes: Fetches a bundle containing any Organization resources matching the identifier (how to search by token)

  3. SHALL support searching for an organisation based on text name using the name search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Organization?name=[string]

    Example:

    1. GET [base]/Organization?name=Hospital
    2. GET [base]/Organization?name=Hospital&_revinclude=Provenance:target

    Implementation Notes: Fetches a bundle of all Organization resources matching the name (how to search by string)

Optional Search Parameters:

The following search parameters SHOULD be supported:

  1. SHOULD support fetching a Organization using the _id search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Organization/[id] or GET [base]/Organization?_id=[id]

    Example:

    1. GET [base]/Organization/5678
    2. GET [base]/Organization?_id=5678

    Implementation Notes: (how to search by the logical id of the resource)