AU Patient Summary Implementation Guide
0.1.0-preview - Preview Australia flag

This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: AU PS Organization

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization Version: 0.1.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUPSOrganization

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 an Organization resource in the context of a patient summary in an Australian context. It is based on the AU Base Organization profile, and applies the constraints of AU Core Organization and Organization (IPS).

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

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..* AUBaseOrganisation An organisation in an Australian healthcare context
This profile also complies with the profiles Organization (IPS) and AU Core Organization
... 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 S 0..1 AUHPIO Identifies this organization across multiple systems
.... identifier:abn S 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
... type S 0..* CodeableConcept Kind of organization
... name S 1..1 string Name used for the organization
... address S 0..* Address, AustralianAddress An address for the organization

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
: 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'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUBaseOrganisation An organisation in an Australian healthcare context
This profile also complies with the profiles Organization (IPS) and AU Core Organization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier SΣC 0..* Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SΣC 0..1 AUHPIO Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
.... identifier:abn SΣC 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
... telecom SC 0..* ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address, AustralianAddress An address for the organization
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'

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
au-core-org-01errorOrganization.identifierA 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-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUBaseOrganisation An organisation in an Australian healthcare context
This profile also complies with the profiles Organization (IPS) and AU Core Organization
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... 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 SΣC 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 SΣC 0..1 AUHPIO Identifies this organization across multiple systems
.... identifier:abn SΣC 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... 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 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 for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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
au-core-org-01errorOrganization.identifierA 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-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 1 element
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.identifier

Maturity: 0

Differential View

This structure is derived from AUBaseOrganisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* AUBaseOrganisation An organisation in an Australian healthcare context
This profile also complies with the profiles Organization (IPS) and AU Core Organization
... 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 S 0..1 AUHPIO Identifies this organization across multiple systems
.... identifier:abn S 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
... type S 0..* CodeableConcept Kind of organization
... name S 1..1 string Name used for the organization
... address S 0..* Address, AustralianAddress An address for the organization

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
: 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'))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUBaseOrganisation An organisation in an Australian healthcare context
This profile also complies with the profiles Organization (IPS) and AU Core Organization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier SΣC 0..* Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SΣC 0..1 AUHPIO Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
.... identifier:abn SΣC 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
... telecom SC 0..* ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address, AustralianAddress An address for the organization
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'

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
au-core-org-01errorOrganization.identifierA 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-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUBaseOrganisation An organisation in an Australian healthcare context
This profile also complies with the profiles Organization (IPS) and AU Core Organization
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... 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 SΣC 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 SΣC 0..1 AUHPIO Identifies this organization across multiple systems
.... identifier:abn SΣC 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... 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 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 for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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
au-core-org-01errorOrganization.identifierA 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-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 1 element
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.identifier

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron