NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHSD Organisation

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation | Version: 4.0.1
Draft as of 2023-09-14 | Computable Name: NHSDOrganisation
Copyright/Legal: Copyright © 2022 Healthdirect Australia - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

A National Health Services Directory (NHSD) Organisation

An extended resource providing additional information on the Organisation not offered by the AU-BASE.

Australian Organisation Directory Entry Profile

NHSD entry for an organisation.

#### NHSD Organisation Resource

1. contact information available only as Organization.contact
2. Extension for contact purpose support - Organization.contact -> purpose
3. Not supported: telecom (Refer to Organization.contact)
4. Not supported: address (Refer to Organization.contact)
5. Not supported: endpoint

#### Examples

Organisation Directory Entry Example

Usages:

- Refer to this Profile: NHSD Secure Messaging Endpoint, NHSD HealthcareService, NHSD Location, NHSD Organisation and NHSD Practitioner Role

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | AUPDOrganisation | An organisation in an Australian healthcare context Constraints: org-1
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata about Organisation resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The time when the resource was last updated
Slices for identifier | Σ C | 0..* | Identifier | NHSD entry Organization identifiers Slice: Unordered, Open by value:system
identifier:abn | S Σ C | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace for ABN Fixed Value: http://hl7.org.au/id/abn
value | Σ | 1..1 | string | ABN Example General: 123456
identifier:acn | S Σ C | 0..1 | AUAustralianCompanyNumber | Australian Company Number (ACN) Constraints: inv-acn-0
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace for ACN Fixed Value: http://hl7.org.au/id/acn
value | Σ | 1..1 | string | ACN Example General: 123456
identifier:arbn | S Σ C | 0..* | AUAustralianRegisteredBodyNumber | Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn
value | Σ | 1..1 | string | ARBN Example General: 123456
identifier:rid | S Σ C | 0..1 | NHSDResourceIdentifier | Organisation Directory Entry Identifiers
active | ?!S Σ | 1..1 | boolean | Reflects the current status of the organization resource
name | S Σ C | 1..1 | string | Name of the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as
partOf | Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to the parent organization
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible)
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Organization.identifier:hpio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:hpio.type | required | Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
Organization.identifier:abn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:acn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:arbn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:paio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:csp.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:nataAccreditation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.0` From the FHIR Standard
Organization.contact.purpose | extensible | ContactEntityType `http://hl7.org/fhir/ValueSet/contactentity-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
inv-abn-0 | error | Organization.identifier:abn | ABN shall be exactly 11 digits : value.length()=11 |
inv-acn-0 | error | Organization.identifier:acn | ACN shall be exactly 9 digits : value.length()=9 |
inv-arbn-0 | error | Organization.identifier:arbn | ARBN shall be exactly 9 digits : value.length()=9 |
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 |

This structure is derived from AUPDOrganisation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization |  | 0..* | AUPDOrganisation | An organisation in an Australian healthcare context
id |  | 1..1 | id | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
meta |  | 1..1 | Meta | Metadata about Organisation resource
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 1..1 | instant | The time when the resource was last updated
source |  | 0..0 |  |
profile |  | 0..0 |  |
security |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
Slices for identifier |  | 0..* | Identifier | NHSD entry Organization identifiers Slice: Unordered, Open by
identifier:hpio |  | 0..0 |  |
identifier:abn | S | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN)
identifier:acn | S | 0..1 | AUAustralianCompanyNumber | Australian Company Number (ACN)
identifier:arbn | S | 0..* | AUAustralianRegisteredBodyNumber | Australian Registered Body Number (ARBN)
identifier:paio |  | 0..0 |  |
identifier:csp |  | 0..0 |  |
identifier:nataAccreditation |  | 0..0 |  |
identifier:rid | S | 0..1 | NHSDResourceIdentifier | Organisation Directory Entry Identifiers
active |  | 1..1 | boolean | Reflects the current status of the organization resource
type |  | 0..0 |  |
name |  | 1..1 | string | Name of the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as
telecom |  | 0..0 |  |
address |  | 0..0 |  |
partOf |  | 0..1 | Reference(NHSD Organisation) | This is a reference to the parent organization
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible)
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
endpoint |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Organization.contact.purpose | extensible | ContactEntityType

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | AUPDOrganisation | An organisation in an Australian healthcare context Constraints: org-1
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata about Organisation resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The time when the resource was last updated
Slices for identifier | Σ C | 0..* | Identifier | NHSD entry Organization identifiers Slice: Unordered, Open by value:system
identifier:abn | S Σ C | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Coded identifier type for ABN Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ABN
system | Σ | 1..1 | uri | Namespace for ABN Fixed Value: http://hl7.org.au/id/abn
value | Σ | 1..1 | string | ABN Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:acn | S Σ C | 0..1 | AUAustralianCompanyNumber | Australian Company Number (ACN) Constraints: inv-acn-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Coded identifier type for ACN Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ACN
system | Σ | 1..1 | uri | Namespace for ACN Fixed Value: http://hl7.org.au/id/acn
value | Σ | 1..1 | string | ACN Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:arbn | S Σ C | 0..* | AUAustralianRegisteredBodyNumber | Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ARBN
system | Σ | 1..1 | uri | Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn
value | Σ | 1..1 | string | ARBN Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:rid | S Σ C | 0..1 | NHSDResourceIdentifier | Organisation Directory Entry Identifiers
active | ?!S Σ | 1..1 | boolean | Reflects the current status of the organization resource
name | S Σ C | 1..1 | string | Name of the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as
partOf | Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to the parent organization
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: ContactEntityType (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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Organization.identifier:hpio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:hpio.type | required | Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
Organization.identifier:abn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:abn.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:acn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:acn.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:arbn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:arbn.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:paio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:paio.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:csp.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:csp.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:nataAccreditation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:nataAccreditation.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.0` From the FHIR Standard
Organization.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.0` From the FHIR Standard
Organization.address.state | required | AustralianStatesandTerritories `http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories`
Organization.contact.purpose | extensible | ContactEntityType `http://hl7.org/fhir/ValueSet/contactentity-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
inv-abn-0 | error | Organization.identifier:abn | ABN shall be exactly 11 digits : value.length()=11 |
inv-acn-0 | error | Organization.identifier:acn | ACN shall be exactly 9 digits : value.length()=9 |
inv-arbn-0 | error | Organization.identifier:arbn | ARBN shall be exactly 9 digits : value.length()=9 |
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 |

This structure is derived from AUPDOrganisation

Summary

Mandatory: 5 elements
Must-Support: 4 elements
Prohibited: 21 elements

Structures

This structure refers to these other structures:

- AU HPI-O (http://hl7.org.au/fhir/StructureDefinition/au-hpio)
- AU Australian Business Number (http://hl7.org.au/fhir/StructureDefinition/au-australianbusinessnumber)
- AU Australian Company Number (http://hl7.org.au/fhir/StructureDefinition/au-australiancompanynumber)
- AUAustralianRegisteredBodyNumber (http://hl7.org.au/fhir/StructureDefinition/au-australianregistredbodynumber)
- nhsd-resource-identifier (http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier)
- NHSD Organisation (http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation)

Slices

This structure defines the following Slices:

- There is a slice with no discriminator at Organization.identifier

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | AUPDOrganisation | An organisation in an Australian healthcare context Constraints: org-1
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata about Organisation resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The time when the resource was last updated
Slices for identifier | Σ C | 0..* | Identifier | NHSD entry Organization identifiers Slice: Unordered, Open by value:system
identifier:abn | S Σ C | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace for ABN Fixed Value: http://hl7.org.au/id/abn
value | Σ | 1..1 | string | ABN Example General: 123456
identifier:acn | S Σ C | 0..1 | AUAustralianCompanyNumber | Australian Company Number (ACN) Constraints: inv-acn-0
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace for ACN Fixed Value: http://hl7.org.au/id/acn
value | Σ | 1..1 | string | ACN Example General: 123456
identifier:arbn | S Σ C | 0..* | AUAustralianRegisteredBodyNumber | Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn
value | Σ | 1..1 | string | ARBN Example General: 123456
identifier:rid | S Σ C | 0..1 | NHSDResourceIdentifier | Organisation Directory Entry Identifiers
active | ?!S Σ | 1..1 | boolean | Reflects the current status of the organization resource
name | S Σ C | 1..1 | string | Name of the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as
partOf | Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to the parent organization
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible)
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Organization.identifier:hpio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:hpio.type | required | Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
Organization.identifier:abn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:acn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:arbn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:paio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:csp.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:nataAccreditation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.0` From the FHIR Standard
Organization.contact.purpose | extensible | ContactEntityType `http://hl7.org/fhir/ValueSet/contactentity-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
inv-abn-0 | error | Organization.identifier:abn | ABN shall be exactly 11 digits : value.length()=11 |
inv-acn-0 | error | Organization.identifier:acn | ACN shall be exactly 9 digits : value.length()=9 |
inv-arbn-0 | error | Organization.identifier:arbn | ARBN shall be exactly 9 digits : value.length()=9 |
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 |

Differential View

This structure is derived from AUPDOrganisation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization |  | 0..* | AUPDOrganisation | An organisation in an Australian healthcare context
id |  | 1..1 | id | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
meta |  | 1..1 | Meta | Metadata about Organisation resource
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 1..1 | instant | The time when the resource was last updated
source |  | 0..0 |  |
profile |  | 0..0 |  |
security |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
Slices for identifier |  | 0..* | Identifier | NHSD entry Organization identifiers Slice: Unordered, Open by
identifier:hpio |  | 0..0 |  |
identifier:abn | S | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN)
identifier:acn | S | 0..1 | AUAustralianCompanyNumber | Australian Company Number (ACN)
identifier:arbn | S | 0..* | AUAustralianRegisteredBodyNumber | Australian Registered Body Number (ARBN)
identifier:paio |  | 0..0 |  |
identifier:csp |  | 0..0 |  |
identifier:nataAccreditation |  | 0..0 |  |
identifier:rid | S | 0..1 | NHSDResourceIdentifier | Organisation Directory Entry Identifiers
active |  | 1..1 | boolean | Reflects the current status of the organization resource
type |  | 0..0 |  |
name |  | 1..1 | string | Name of the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as
telecom |  | 0..0 |  |
address |  | 0..0 |  |
partOf |  | 0..1 | Reference(NHSD Organisation) | This is a reference to the parent organization
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible)
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
endpoint |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Organization.contact.purpose | extensible | ContactEntityType

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | AUPDOrganisation | An organisation in an Australian healthcare context Constraints: org-1
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata about Organisation resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The time when the resource was last updated
Slices for identifier | Σ C | 0..* | Identifier | NHSD entry Organization identifiers Slice: Unordered, Open by value:system
identifier:abn | S Σ C | 0..1 | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Coded identifier type for ABN Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ABN
system | Σ | 1..1 | uri | Namespace for ABN Fixed Value: http://hl7.org.au/id/abn
value | Σ | 1..1 | string | ABN Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:acn | S Σ C | 0..1 | AUAustralianCompanyNumber | Australian Company Number (ACN) Constraints: inv-acn-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Coded identifier type for ACN Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ACN
system | Σ | 1..1 | uri | Namespace for ACN Fixed Value: http://hl7.org.au/id/acn
value | Σ | 1..1 | string | ACN Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:arbn | S Σ C | 0..* | AUAustralianRegisteredBodyNumber | Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ARBN
system | Σ | 1..1 | uri | Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn
value | Σ | 1..1 | string | ARBN Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:rid | S Σ C | 0..1 | NHSDResourceIdentifier | Organisation Directory Entry Identifiers
active | ?!S Σ | 1..1 | boolean | Reflects the current status of the organization resource
name | S Σ C | 1..1 | string | Name of the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as
partOf | Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to the parent organization
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: ContactEntityType (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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Organization.identifier:hpio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:hpio.type | required | Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
Organization.identifier:abn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:abn.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:acn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:acn.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:arbn.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:arbn.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:paio.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:paio.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:csp.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:csp.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.identifier:nataAccreditation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
Organization.identifier:nataAccreditation.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.0` From the FHIR Standard
Organization.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.0` From the FHIR Standard
Organization.address.state | required | AustralianStatesandTerritories `http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories`
Organization.contact.purpose | extensible | ContactEntityType `http://hl7.org/fhir/ValueSet/contactentity-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
inv-abn-0 | error | Organization.identifier:abn | ABN shall be exactly 11 digits : value.length()=11 |
inv-acn-0 | error | Organization.identifier:acn | ACN shall be exactly 9 digits : value.length()=9 |
inv-arbn-0 | error | Organization.identifier:arbn | ARBN shall be exactly 9 digits : value.length()=9 |
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 |

This structure is derived from AUPDOrganisation

Summary

Mandatory: 5 elements
Must-Support: 4 elements
Prohibited: 21 elements

Structures

This structure refers to these other structures:

- AU HPI-O (http://hl7.org.au/fhir/StructureDefinition/au-hpio)
- AU Australian Business Number (http://hl7.org.au/fhir/StructureDefinition/au-australianbusinessnumber)
- AU Australian Company Number (http://hl7.org.au/fhir/StructureDefinition/au-australiancompanynumber)
- AUAustralianRegisteredBodyNumber (http://hl7.org.au/fhir/StructureDefinition/au-australianregistredbodynumber)
- nhsd-resource-identifier (http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier)
- NHSD Organisation (http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation)

Slices

This structure defines the following Slices:

- There is a slice with no discriminator at Organization.identifier

Other representations of profile: CSV, Excel, Schematron

### Notes:

Operation | Format | Example
--- | --- | ---
Read | GET [base]/PractitionerRole/[id] | GET [base]/PractitionerRole/36259758-30f5-83f2-53a8-45891c0ddab0
search | POST [base]/PractitionerRole/_search |

IMPORTANT NOTES ON SEARCH BEHAVIOUR

    NHSD recommends search using POST with for complex search scenarios.

For further information and examples, refer to the capability statement

Read: Organisation

Read identified organisation resource content.

    GET [base]/Organization/[id]

    Example:
    GET [base]/Organization/36259758-30f5-83f2-53a8-45891c0ddab0

Implementation Notes:

Search by identifiers Search based on identifier token.

    GET [base]/Organization?identifier=[system]|[value]

Example:

- ABN Search

       GET [base]/Organization/?identifier=http://hl7.org.au/id/abn|67164776714

- NHSD SITE-ID

       GET [base]/Organization?identifier=http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#siteId|202029

Implementation Notes:

Search by Name Search based on Organisation Name.

    GET [base]/Organization?name=[name]

    Example:
    GET [base]/Organization?name=Inverloch Chiro

Pagination

- NHSD supports paging using page and _count param to fetch Organization resources. By default the count is 10.

    GET [base]/Organization?_format=json&page=1&_count=10

Refer to the capability statement for further details on paging support through Bundle.Links