AU Base Implementation Guide
5.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU Base Organisation

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-organization | Version: 5.1.0-preview
Standards status: Trial-use | Maturity Level: 3 | Computable Name: AUBaseOrganisation
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an organisation structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

### Usage Notes

Profile specific implementation guidance:

- When selecting a code for `Organization.type`:
  - Where possible a code from the preferred Healthcare Organisation Role Type value set should be selected.
  - If a system is unable to provide a code from the preferred value set because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select a suitable code from SNOMED CT.
  - If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used.
- See each Identifier profile page for guidance related to that identifier type.
- Additional considerations for systems aligning to HL7 AU Base:
  - Contact details and associated contact purpose are encouraged to be sent in `Organization.contact` over making use of the Contact Purpose extension.

Usage:

- Examples for this Resource Profile: Test Org -DigitalHealth 5, Downunder Hospital, Albion Hospital, Holistic Medical Pty Ltd as trustee for Smith Family Trust... Show 3 more, Devonport Family Medicine Clinic, Downunder Hospital and ACME Pathology

Changes since version 5.0.0:

- No changes

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | An organisation in an Australian healthcare context 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
identifier | Σ C | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems ele-1: All FHIR elements must have a @value or children
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred) ele-1: All FHIR elements must have a @value or children
address | C | 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'
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.type | preferred | HealthcareOrganisationRoleType `https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1` from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose | extensible | ContactPurpose `http://terminology.hl7.org.au/ValueSet/contact-purpose` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | An address of an organization can never be of use 'home' : where(use = 'home').empty() |

This structure is derived from Organization

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization |  | 0..* | Organization | An organisation in an Australian healthcare context
identifier |  | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems
type |  | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
address |  | 0..* | Address, AustralianAddress | An address for the organization
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Organization.type | preferred | HealthcareOrganisationRoleType `https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1` from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose | extensible | ContactPurpose `http://terminology.hl7.org.au/ValueSet/contact-purpose` from this IG

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | 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
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
identifier | Σ C | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
name | Σ C | 0..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 | C | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
address | C | 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Organization.type | preferred | HealthcareOrganisationRoleType `https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1` from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose | extensible | ContactPurpose `http://terminology.hl7.org.au/ValueSet/contact-purpose` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | 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 Organization

Summary

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | An organisation in an Australian healthcare context 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
identifier | Σ C | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems ele-1: All FHIR elements must have a @value or children
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred) ele-1: All FHIR elements must have a @value or children
address | C | 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'
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.type | preferred | HealthcareOrganisationRoleType `https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1` from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose | extensible | ContactPurpose `http://terminology.hl7.org.au/ValueSet/contact-purpose` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | An address of an organization can never be of use 'home' : where(use = 'home').empty() |

Differential View

This structure is derived from Organization

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization |  | 0..* | Organization | An organisation in an Australian healthcare context
identifier |  | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems
type |  | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
address |  | 0..* | Address, AustralianAddress | An address for the organization
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Organization.type | preferred | HealthcareOrganisationRoleType `https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1` from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose | extensible | ContactPurpose `http://terminology.hl7.org.au/ValueSet/contact-purpose` from this IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | 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
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
identifier | Σ C | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
name | Σ C | 0..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 | C | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
address | C | 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Organization.type | preferred | HealthcareOrganisationRoleType `https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1` from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose | extensible | ContactPurpose `http://terminology.hl7.org.au/ValueSet/contact-purpose` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | 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 Organization

Summary

Maturity: 3

Other representations of profile: CSV, Excel, Schematron