AU Provider Directory Implementation Guide
2.1.0-ci-build - Draft

AU Provider Directory Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/au-fhir-pd/ and changes regularly. See the Directory of published versions

## Resource Profile: AU PD Organisation

Official URL: http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-organisation | Version: 2.1.0-ci-build
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPDOrganisation
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a provider directory entry for an organisation.

### Usage Notes

Profile specific implementation guidance:

At least one of the following defined identifier types, known to this profile, SHALL be supplied:

- AU HPI-O
- AU PAI-O Identifier
- AU CSP Registration Number
- AU Australian Business Number
- AU Australian Company Number
- AU Australian Registered Body Number
- AU NATA Accreditation Number
- AU Pharmacy Approval Number

Usages:

- Refer to this Profile: AU PD Healthcare Service and AU PD Practitioner Role
- Examples for this Profile: Downunder Hospital

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 TU | 0..* | AUBaseOrganisation | Australian Organisation Directory Entry Constraints: org-1, au-pd-org-01
meta | Σ | 0..1 | Meta | Metadata on Organisation
source | S Σ | 0..1 | uri | Identifies where the resource comes from
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 | S | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio | S | 0..* | AUHPIO | Identifies this organization across multiple systems
active | ?!S Σ | 1..1 | boolean | Status of Directory Entry Organisation
name | S Σ C | 1..1 | string | Name of Directory Entry Organisation
telecom | S C | 0..* | ContactPoint | Contact Details of Directory Entry Organisation Constraints: org-3
address | S C | 0..* | Address, AustralianAddress | Addresses of Directory Entry Organisation Constraints: org-2
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | required | Australian States and Territories | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-org-01 | error | Organization | At least one defined identifier, known to this AU PD Organisation profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()`
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 AUBaseOrganisation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C TU | 0..* | AUBaseOrganisation | Australian Organisation Directory Entry Constraints: au-pd-org-01
meta |  | 0..1 | Meta | Metadata on Organisation
source | S | 0..1 | uri | Identifies where the resource comes from
Slices for identifier | S | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio | S | 0..* | AUHPIO | Identifies this organization across multiple systems
active | S | 1..1 | boolean | Status of Directory Entry Organisation
name | S | 1..1 | string | Name of Directory Entry Organisation
telecom | S | 0..* | ContactPoint | Contact Details of Directory Entry Organisation
address | S | 0..* | Address, AustralianAddress | Addresses of Directory Entry Organisation
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Organization.address.​state | Base | required | Australian States and Territories | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-org-01 | error | Organization | At least one defined identifier, known to this AU PD Organisation profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C TU | 0..* | AUBaseOrganisation | Australian Organisation Directory Entry Constraints: org-1, au-pd-org-01
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata on Organisation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | S Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio | S | 0..* | AUHPIO | Identifies this organization across multiple systems
active | ?!S Σ | 1..1 | boolean | Status of Directory Entry Organisation
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
name | S Σ C | 1..1 | string | Name of Directory Entry Organisation
alias |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
telecom | S C | 0..* | ContactPoint | Contact Details of Directory Entry Organisation Constraints: org-3
address | S C | 0..* | Address, AustralianAddress | Addresses of Directory Entry Organisation Constraints: org-2
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 | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible)
name |  | 0..1 | HumanName | A name associated with the contact
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Organization.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Organization.type | Base | preferred | Healthcare Organisation Role Type | ⏿1.1.0 | tx.hl7.org.au
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | required | Australian States and Territories | 📦2.1.0-ci-build | This IG
Organization.contact.​purpose | Base | extensible | Contact Purpose | 📦4.1.0 | AU Base Implementation Guide v4.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-org-01 | error | Organization | At least one defined identifier, known to this AU PD Organisation profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()`
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 AUBaseOrganisation

Summary

Mandatory: 3 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

- AU HPI-O (http://hl7.org.au/fhir/StructureDefinition/au-hpio)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Organization.identifier

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C TU | 0..* | AUBaseOrganisation | Australian Organisation Directory Entry Constraints: org-1, au-pd-org-01
meta | Σ | 0..1 | Meta | Metadata on Organisation
source | S Σ | 0..1 | uri | Identifies where the resource comes from
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 | S | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio | S | 0..* | AUHPIO | Identifies this organization across multiple systems
active | ?!S Σ | 1..1 | boolean | Status of Directory Entry Organisation
name | S Σ C | 1..1 | string | Name of Directory Entry Organisation
telecom | S C | 0..* | ContactPoint | Contact Details of Directory Entry Organisation Constraints: org-3
address | S C | 0..* | Address, AustralianAddress | Addresses of Directory Entry Organisation Constraints: org-2
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | required | Australian States and Territories | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-org-01 | error | Organization | At least one defined identifier, known to this AU PD Organisation profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()`
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 AUBaseOrganisation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C TU | 0..* | AUBaseOrganisation | Australian Organisation Directory Entry Constraints: au-pd-org-01
meta |  | 0..1 | Meta | Metadata on Organisation
source | S | 0..1 | uri | Identifies where the resource comes from
Slices for identifier | S | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio | S | 0..* | AUHPIO | Identifies this organization across multiple systems
active | S | 1..1 | boolean | Status of Directory Entry Organisation
name | S | 1..1 | string | Name of Directory Entry Organisation
telecom | S | 0..* | ContactPoint | Contact Details of Directory Entry Organisation
address | S | 0..* | Address, AustralianAddress | Addresses of Directory Entry Organisation
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Organization.address.​state | Base | required | Australian States and Territories | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-org-01 | error | Organization | At least one defined identifier, known to this AU PD Organisation profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C TU | 0..* | AUBaseOrganisation | Australian Organisation Directory Entry Constraints: org-1, au-pd-org-01
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata on Organisation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | S Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S | 1..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio | S | 0..* | AUHPIO | Identifies this organization across multiple systems
active | ?!S Σ | 1..1 | boolean | Status of Directory Entry Organisation
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
name | S Σ C | 1..1 | string | Name of Directory Entry Organisation
alias |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
telecom | S C | 0..* | ContactPoint | Contact Details of Directory Entry Organisation Constraints: org-3
address | S C | 0..* | Address, AustralianAddress | Addresses of Directory Entry Organisation Constraints: org-2
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 | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible)
name |  | 0..1 | HumanName | A name associated with the contact
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Organization.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Organization.type | Base | preferred | Healthcare Organisation Role Type | ⏿1.1.0 | tx.hl7.org.au
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | required | Australian States and Territories | 📦2.1.0-ci-build | This IG
Organization.contact.​purpose | Base | extensible | Contact Purpose | 📦4.1.0 | AU Base Implementation Guide v4.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-org-01 | error | Organization | At least one defined identifier, known to this AU PD Organisation profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()`
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 AUBaseOrganisation

Summary

Mandatory: 3 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

- AU HPI-O (http://hl7.org.au/fhir/StructureDefinition/au-hpio)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Organization.identifier

Maturity: 0

Other representations of profile: CSV, Excel, Schematron

### Notes:

Read: Organisation

Read identified organisation resource content.

`GET [base]/Organization/[id]`

Example: `GET [base]/Organization/1234`

Support: MUST support read Organisation

Implementation Notes: (how to read resource)

Search: Active Status

Search based on active status of the organisation record.

`GET [base]/Organization?active=[status]`

Example: `GET [base]/Organization?active=true`

Support: MUST support search Organization by active status (true | false).

Implementation Notes: (how to search by token)

Search: HPI-O

Search based on identifier token.

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

Example: `GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328`

Support: SHOULD support search by HPI-O.

Implementation Notes: (how to search by token)

Search: Name

Search for a organisation by name.

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

Example: `GET [base]/Organization?name=southern%20clinic`

Support:

- MUST support search by Organisation name.

Implementation Notes: (how to search by string)

Search: Combination

- Searches MUST be able to be perfomed in a single request using logical AND for criteria. e.g name and status