Clinical Note Document - Local Development build (v26.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://digitalhealth.gov.au/fhir/cnd/StructureDefinition/cnd-organization | Version: 26.0.0 | |||
| Active as of 2026-06-19 | Computable Name: CND_Organization | |||
Copyright/Legal: 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.
This profile defines healthcare organisation representation for a Clinical Note Document in Australia, ensuring consistent capture of organisational identifiers and address information for clinical note authoring, routing, and attribution.
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 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: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | Clinical Note Document Organization Constraints: org-1 | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
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, inv-01-org-identifier-length
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| |||||||||
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization
| |||||||||
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
![]() ![]() ![]() |
Σ | 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.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| 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()
|
| inv-01-org-identifier-length | 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
|
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreOrganization | Clinical Note Document Organization | |
![]() ![]() |
C | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Constraints: inv-01-org-identifier-length |
![]() ![]() |
0..* | AustralianAddress | An address for the organization | |
![]() ![]() ![]() |
1..1 | string | Name of city, town or suburb | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| inv-01-org-identifier-length | 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: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | Clinical Note Document Organization Constraints: org-1 | |||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||
![]() ![]() |
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 | ||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
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, inv-01-org-identifier-length
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| |||||||||
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization
| |||||||||
![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||||||||
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | |||||||||
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
![]() ![]() ![]() |
Σ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 | |||||||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required) | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132 | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | |||||||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | ||||||||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | ||||||||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||||||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | ||||||||||
![]() ![]() |
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.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| 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 | 📦6.0.0 | AU Base Implementation Guide v6.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()
|
| inv-01-org-identifier-length | 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
|
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | Clinical Note Document Organization Constraints: org-1 | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
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, inv-01-org-identifier-length
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| |||||||||
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization
| |||||||||
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
![]() ![]() ![]() |
Σ | 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.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| 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()
|
| inv-01-org-identifier-length | 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
|
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreOrganization | Clinical Note Document Organization | |
![]() ![]() |
C | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems Constraints: inv-01-org-identifier-length |
![]() ![]() |
0..* | AustralianAddress | An address for the organization | |
![]() ![]() ![]() |
1..1 | string | Name of city, town or suburb | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| inv-01-org-identifier-length | 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: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreOrganization | Clinical Note Document Organization Constraints: org-1 | |||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||
![]() ![]() |
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 | ||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
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, inv-01-org-identifier-length
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | AUHPIO | Identifies this organization across multiple systems
| |||||||||
![]() ![]() ![]() |
SOΣC | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| |||||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| |||||||||
![]() ![]() |
SOΣC | 1..1 | string | Name used for the organization
| |||||||||
![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||||||||
![]() ![]() |
SOC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
| |||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | The actual contact point details
| |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | |||||||||
![]() ![]() |
SOC | 0..* | AustralianAddress | An address for the organization Constraints: org-2
| |||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/address-identifier" | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier | Address identifier | ||||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
![]() ![]() ![]() |
Σ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 | |||||||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of city, town or suburb Example General: Erewhon | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required) | |||||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Postal code for area Constraints: inv-add-3 Example General: 9132 | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |||||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | |||||||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | ||||||||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | ||||||||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||||||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | ||||||||||
![]() ![]() |
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.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| 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 | 📦6.0.0 | AU Base Implementation Guide v6.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()
|
| inv-01-org-identifier-length | 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
|
| 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
Other representations of profile: CSV, Excel, Schematron