Aged Care Clinical Note
0.1.0-preview - Preview
Aged Care Clinical Note - Local Development build (v0.1.0-preview) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/cn/StructureDefinition/au-aged-care-clin-note-department | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUAgedCareClinNoteDepartment | ||
Usage:Jurisdiction: Australia |
||||
Copyright/Legal: Copyright © 2025 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/. |
||||
This profile constrains AU Core Organization to meet the requirements of this Implementation Guide for a healthcare organisation department or unit. Implementers are highly encouraged to review AU Core Organization profile before using this profile.
The following are the indented usage scenarios for this profile:
The following are the key changes made to the parent AU Core Organization to meet the requirements of this Implementation Guide:
Organization.identifier is still optional and can only be of type Identifier. Slices for HPIO, ABN, and other identifier types not applicable to departments or units are not allowed.Organization.partOf was made mandatory and SHALL reference an AU Aged Care Clinical Note - OrganizationUsages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.0.1 | tx.ontoserver.csiro.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier | 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 | **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 AUCoreOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Organization |
0..* | AUCoreOrganization | Australian Aged Care Clinical Note department or unit | |
  Slices for identifier |
Content/Rules for all slices | |||
   identifier:hpio |
0..0 | Identifies this organization across multiple systems | ||
 identifier:abn |
0..0 | Identifies this organization across multiple systems | ||
  partOf |
1..1 | Reference(AU Aged Care Clinical Note - Organization) | The organization of which this organization forms a part | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | Australian Aged Care Clinical Note department or unit Constraints: org-1 | |||||||||
  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.
| ||||||||||
| 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 | ||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | ||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| Slices for identifier |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01
| |||||||||
| 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 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 |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
| address |
SOC | 0..* | Address, AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
| partOf |
Σ | 1..1 | Reference(AU Aged Care Clinical Note - 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 | |||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.0.1 | tx.ontoserver.csiro.au |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦5.0.0 | AU Base Implementation Guide v5.0 |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier | 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 | **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 AUCoreOrganization
Summary
Mandatory: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | Australian Aged Care Clinical Note department or unit Constraints: org-1 | |||||||||
| 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 |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01
| |||||||||
| 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 used for the organization
| |||||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
| address |
SOC | 0..* | Address, AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
| partOf |
Σ | 1..1 | Reference(AU Aged Care Clinical Note - Organization) | The organization of which this organization forms a part | |||||||||
| Documentation for this format | |||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.0.1 | tx.ontoserver.csiro.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier | 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 | **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()
|
Differential View
This structure is derived from AUCoreOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | AUCoreOrganization | Australian Aged Care Clinical Note department or unit | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:hpio |
0..0 | Identifies this organization across multiple systems | ||
| identifier:abn |
0..0 | Identifies this organization across multiple systems | ||
| partOf |
1..1 | Reference(AU Aged Care Clinical Note - Organization) | The organization of which this organization forms a part | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | Australian Aged Care Clinical Note department or unit Constraints: org-1 | |||||||||
| 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.
| ||||||||||
| 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 | ||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| Slices for identifier |
SOΣC | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system Constraints: au-core-org-01
| |||||||||
| 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 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 |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
| address |
SOC | 0..* | Address, AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
| partOf |
Σ | 1..1 | Reference(AU Aged Care Clinical Note - 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 | |||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.0.1 | tx.ontoserver.csiro.au |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦5.0.0 | AU Base Implementation Guide v5.0 |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier | 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 | **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 AUCoreOrganization
Summary
Mandatory: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ Australian Digital Health Agency. Package au.digitalhealth.r4.agedcareclinicalnote#0.1.0-preview based on FHIR 4.0.1. Generated 2025-12-05
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
