AU eRequesting Implementation Guide
1.0.0-ci-build - CI Build
AU eRequesting Implementation Guide
1.0.0-ci-build - CI Build
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-organization | Version: 1.0.0-ci-build | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingOrganization | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an Organization resource that is used to record, search, and fetch information about an organisation. It is based on the AU Core Organization profile and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the Organization resource when conforming to this profile.
Obligations for AU Core actors (AU Core Requester and AU Core Responder) inherited from AU Core Organization currently render in the profile view. This is a tooling limitation, and only the AU eRequesting actor obligations should be applied. See Zulip discussion for more information.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.0.0-ballot:
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 |
| Organization.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍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()
|
| 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 | An organisation in an Australian healthcare context | |||||||||||||||||||
  identifier |
O | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems
| ||||||||||||||||||
  Slices for identifier |
Content/Rules for all slices | |||||||||||||||||||||
   identifier:hpio |
O | 0..1 | AUHPIO | Identifies this organization across multiple systems
| ||||||||||||||||||
 identifier:abn |
O | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| ||||||||||||||||||
| type |
O | 0..* | CodeableConcept | Kind of organization
| ||||||||||||||||||
| name |
O | 1..1 | string | Name used for the organization
| ||||||||||||||||||
| telecom |
O | 0..* | ContactPoint | A contact detail for the organization
| ||||||||||||||||||
| system |
O | 0..1 | code | phone | fax | email | pager | url | sms | other
| ||||||||||||||||||
 value |
O | 0..1 | string | The actual contact point details
| ||||||||||||||||||
| address |
O | 0..* | Address, AustralianAddress | An address for the organization
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context 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
| ||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| system |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||||||||||||||
| value |
SOΣ | 0..1 | string | The actual contact point details
| ||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||||||||||||||||||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||||||||||||||||||||
| address |
SOC | 0..* | Address, AustralianAddress | An address for the organization Constraints: org-2
| ||||||||||||||||||||||||
 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.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦6.0.0-ci-build | AU Base Implementation Guide vnull |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context 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
| ||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||
| system |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||||||||||||||
| value |
SOΣ | 0..1 | string | The actual contact point details
| ||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||||||||||||||||||||
| address |
SOC | 0..* | Address, AustralianAddress | An address for the organization Constraints: org-2
| ||||||||||||||||||||||||
| 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. |
| 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 | An organisation in an Australian healthcare context | |||||||||||||||||||
| identifier |
O | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems
| ||||||||||||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||||||||||||
| identifier:hpio |
O | 0..1 | AUHPIO | Identifies this organization across multiple systems
| ||||||||||||||||||
| identifier:abn |
O | 0..* | AUAustralianBusinessNumber | Identifies this organization across multiple systems
| ||||||||||||||||||
| type |
O | 0..* | CodeableConcept | Kind of organization
| ||||||||||||||||||
| name |
O | 1..1 | string | Name used for the organization
| ||||||||||||||||||
| telecom |
O | 0..* | ContactPoint | A contact detail for the organization
| ||||||||||||||||||
| system |
O | 0..1 | code | phone | fax | email | pager | url | sms | other
| ||||||||||||||||||
| value |
O | 0..1 | string | The actual contact point details
| ||||||||||||||||||
| address |
O | 0..* | Address, AustralianAddress | An address for the organization
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | AUCoreOrganization | An organisation in an Australian healthcare context 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
| ||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| system |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||||||||||||||
| value |
SOΣ | 0..1 | string | The actual contact point details
| ||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||||||||||||||||||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||||||||||||||||||||
| address |
SOC | 0..* | Address, AustralianAddress | An address for the organization Constraints: org-2
| ||||||||||||||||||||||||
| 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.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦6.0.0-ci-build | AU Base Implementation Guide vnull |
| 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
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.
Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT".
| Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|---|---|---|
| _id | SHALL | MAY | MAY | MAY | token |
|
| identifier | SHALL | - | MAY | MAY | token |
The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.
_id search parameter
GET [base]/Organization?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested Organization, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
identifier search parameter
GET [base]/Organization?identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing all Organization resources matching the identifier (how to search by token)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#1.0.0-ci-build based on FHIR 4.0.1. Generated 2025-11-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change