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-organization | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUAgedCareClinNoteOrganization | ||
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. 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 required. The identifier SHALL meet the requirements of AIHW Aged care provider—identifier, X[X(19)]. The use of HPIO is recommended to meet the requirements of the identifier.Organization.address.city, to meet the requirements AIHW Address components cluster.Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Organization |
C | 0..* | AUCoreOrganization | Australian Aged Care Clinical Note Organization 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 | 1..* | 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, OrgIdentifierLength
| |||||||||
   identifier:hpio |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
 identifier:abn |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
| 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..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
 Slices for extension |
Content/Rules for all slices | ||||||||||||
 extension:identifier |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
  url |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
 value[x] |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
| extension:noFixedAddress |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
| text |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| city |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
 country |
Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |||||||||
| 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 |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| OrgIdentifierLength | error | Organization.identifier | Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. |
value.length() >= 1 and value.length() <= 20
|
| 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 Organization | |
 identifier |
C | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Constraints: OrgIdentifierLength |
| address |
0..* | AustralianAddress | An address for the organization | |
| city |
1..1 | string | Name of city, town or suburb | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| OrgIdentifierLength | error | Organization.identifier | Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. |
value.length() >= 1 and value.length() <= 20
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | Australian Aged Care Clinical Note Organization 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 | 1..* | 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, OrgIdentifierLength
| |||||||||
| identifier:hpio |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
| identifier:abn |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
| 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..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
| extension:identifier |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
| value[x] |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
| extension:noFixedAddress |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
| type |
ΣC | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||||||
| text |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| line |
ΣC | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||||||
| city |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||||||
| state |
Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required) | |||||||||
| postalCode |
ΣC | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132 | |||||||||
| country |
Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |||||||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||
 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 | |||||||||||||
| 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.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.address.state | Base | required |
Australian States and Territories
|
⏿2.0.2 | 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 |
| OrgIdentifierLength | error | Organization.identifier | Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. |
value.length() >= 1 and value.length() <= 20
|
| 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()
|
| inv-add-3 | error | Organization.address.postalCode | Postal code shall be 4 digits |
matches('^[0-9]{4}$')
|
| 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(1 nested mandatory element)
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 Organization 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 | 1..* | 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, OrgIdentifierLength
| |||||||||
| identifier:hpio |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
| identifier:abn |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
| 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..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
| Slices for extension |
Content/Rules for all slices | ||||||||||||
| extension:identifier |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
| url |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
| value[x] |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
| extension:noFixedAddress |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
| text |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| city |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
| country |
Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |||||||||
| 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 |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| OrgIdentifierLength | error | Organization.identifier | Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. |
value.length() >= 1 and value.length() <= 20
|
| 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 Organization | |
| identifier |
C | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Constraints: OrgIdentifierLength |
| address |
0..* | AustralianAddress | An address for the organization | |
| city |
1..1 | string | Name of city, town or suburb | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| OrgIdentifierLength | error | Organization.identifier | Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. |
value.length() >= 1 and value.length() <= 20
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | Australian Aged Care Clinical Note Organization 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 | 1..* | 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, OrgIdentifierLength
| |||||||||
| identifier:hpio |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
| identifier:abn |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
| 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..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
| extension:identifier |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
| value[x] |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
| extension:noFixedAddress |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
| type |
ΣC | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||||||
| text |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| line |
ΣC | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||||||
| city |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||||||
| state |
Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required) | |||||||||
| postalCode |
ΣC | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132 | |||||||||
| country |
Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |||||||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||
| 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 | |||||||||||||
| 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.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.address.state | Base | required |
Australian States and Territories
|
⏿2.0.2 | 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 |
| OrgIdentifierLength | error | Organization.identifier | Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. |
value.length() >= 1 and value.length() <= 20
|
| 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()
|
| inv-add-3 | error | Organization.address.postalCode | Postal code shall be 4 digits |
matches('^[0-9]{4}$')
|
| 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(1 nested mandatory element)
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
