Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core Organization

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1 Version: 1.0.2
Active as of 2024-04-18 Computable Name: ADHAOrganizationCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a core representation of an organisation for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Organization that are supported.

An Organization resource is used within the context of a referencing resource.

This profile is designed to set a core Organization standard for:

  • Recording or updating an organisation referenced by another resource
  • Reading organisations referenced by another resource

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

None.

Boundaries and relationships

These profiles build on this profile (ADHA Core Organization) to define specific roles:

Usage:

Formal Views of Profile Content

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

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
... identifier:paio S 0..1 AUPAIOIdentifier Identifies this organization across multiple systems
... active 0..1 boolean Whether the organization's record is still in active use
Fixed Value: true
... partOf SC 0..1 Reference(ADHA Core Organization) The organization of which this organization forms a part

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-org-01errorOrganizationIf present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
: partOf.exists() implies (partOf.reference.exists() or partOf.identifier.exists() or partOf.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SC 0..* Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies 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 SC 0..1 AUHPIO Healthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be 16 digits
inv-hpio-1: HPI-O prefix shall be 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
.... identifier:paio SC 0..1 AUPAIOIdentifier Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
... partOf SΣC 0..1 Reference(ADHA Core Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-org-01errorOrganizationIf present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
: partOf.exists() implies (partOf.reference.exists() or partOf.identifier.exists() or partOf.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SC 0..* Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies 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 SC 0..1 AUHPIO Healthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be 16 digits
inv-hpio-1: HPI-O prefix shall be 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
.... identifier:paio SC 0..1 AUPAIOIdentifier Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
Fixed Value: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
... partOf SΣC 0..1 Reference(ADHA Core Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: Contact Purpose (extensible)
.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.contact.purposeextensibleContactPurpose
http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-org-01errorOrganizationIf present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
: partOf.exists() implies (partOf.reference.exists() or partOf.identifier.exists() or partOf.display.exists())

This structure is derived from AUCoreOrganization

Differential View

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
... identifier:paio S 0..1 AUPAIOIdentifier Identifies this organization across multiple systems
... active 0..1 boolean Whether the organization's record is still in active use
Fixed Value: true
... partOf SC 0..1 Reference(ADHA Core Organization) The organization of which this organization forms a part

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-org-01errorOrganizationIf present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
: partOf.exists() implies (partOf.reference.exists() or partOf.identifier.exists() or partOf.display.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SC 0..* Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies 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 SC 0..1 AUHPIO Healthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be 16 digits
inv-hpio-1: HPI-O prefix shall be 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
.... identifier:paio SC 0..1 AUPAIOIdentifier Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
... partOf SΣC 0..1 Reference(ADHA Core Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-org-01errorOrganizationIf present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
: partOf.exists() implies (partOf.reference.exists() or partOf.identifier.exists() or partOf.display.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SC 0..* Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies 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 SC 0..1 AUHPIO Healthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be 16 digits
inv-hpio-1: HPI-O prefix shall be 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
.... identifier:paio SC 0..1 AUPAIOIdentifier Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
Fixed Value: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
... partOf SΣC 0..1 Reference(ADHA Core Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: Contact Purpose (extensible)
.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.contact.purposeextensibleContactPurpose
http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-org-01errorOrganizationIf present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display
: partOf.exists() implies (partOf.reference.exists() or partOf.identifier.exists() or partOf.display.exists())

This structure is derived from AUCoreOrganization

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No mandatory or optional search parameters for ADHA Core Organization profile.