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

• 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		Extension Slice: Unordered, Open by value:url
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
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
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	Status	Usage	ValueSet	Version	Source
Organization.identifier:hpio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:hpio.​type	Base	required	v2 Identifier Type - AU Extended	⏿1.0.2	tx.hl7.org.au
Organization.identifier:abn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:acn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:arbn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:paio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:csp.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:nataAccreditation.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.type	Base	extensible	Types of Organisation	📦4.0.1	This IG
Organization.address.​use	Base	required	AddressUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.contact.​purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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		Unique id for inter-element referencing
extension		0..0		Extension
versionId		0..0		Version specific identifier
lastUpdated		1..1	instant	The time when the resource was last updated
source		0..0		Identifies where the resource comes from
profile		0..0		Profiles this resource claims to conform to
security		0..0		Security Labels applied to this resource
tag		0..0		Tags applied to this resource
implicitRules		0..0		A set of rules under which this content was created
language		0..0		Language of the resource content
text		0..0		Text summary of the resource, for human interpretation
contained		0..0		Contained, inline Resources
extension		0..0		Extension
modifierExtension		0..0		Extension
Slices for identifier		0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by
identifier:hpio		0..0		HPI-O for Directory Entry Organisation
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		My Health Record Assigned Identity for Organisations (PAI-O)
identifier:csp		0..0		Contracted Service Provider (CSP) Number
identifier:nataAccreditation		0..0		National Association of Testing Authorities (NATA) Accreditation Number
identifier:rid	S	0..1	NHSDResourceIdentifier	Organisation Directory Entry Identifiers
active		1..1	boolean	Reflects the current status of the organization resource
type		0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
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		Contact Details of Directroy Entry Organisation
address		0..0		Addresses of Directroy Entry Organisation
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		Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	extensible	Types of Organisation	📦4.0.1	This IG
Organization.contact.​purpose	Base	extensible		Not State	Unknown

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		Extension Slice: Unordered, Open by value:url
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
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
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	Status	Usage	ValueSet	Version	Source
Organization.identifier:hpio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:hpio.​type	Base	required	v2 Identifier Type - AU Extended	⏿1.0.2	tx.hl7.org.au
Organization.identifier:abn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:abn.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:acn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:acn.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:arbn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:arbn.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:paio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:paio.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:csp.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:csp.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:nataAccreditation.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:nataAccreditation.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.type	Base	extensible	Types of Organisation	📦4.0.1	This IG
Organization.address.​use	Base	required	AddressUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.address.​type	Base	required	AddressType	📍4.0.1 → 4.0.0	FHIR Std.
Organization.address.​state	Base	required	Australian States and Territories	📦2.0.1	hl7.fhir.au.pd v2.0
Organization.contact.​purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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

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		Extension Slice: Unordered, Open by value:url
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
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
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	Status	Usage	ValueSet	Version	Source
Organization.identifier:hpio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:hpio.​type	Base	required	v2 Identifier Type - AU Extended	⏿1.0.2	tx.hl7.org.au
Organization.identifier:abn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:acn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:arbn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:paio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:csp.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:nataAccreditation.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.type	Base	extensible	Types of Organisation	📦4.0.1	This IG
Organization.address.​use	Base	required	AddressUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.contact.​purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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		Unique id for inter-element referencing
extension		0..0		Extension
versionId		0..0		Version specific identifier
lastUpdated		1..1	instant	The time when the resource was last updated
source		0..0		Identifies where the resource comes from
profile		0..0		Profiles this resource claims to conform to
security		0..0		Security Labels applied to this resource
tag		0..0		Tags applied to this resource
implicitRules		0..0		A set of rules under which this content was created
language		0..0		Language of the resource content
text		0..0		Text summary of the resource, for human interpretation
contained		0..0		Contained, inline Resources
extension		0..0		Extension
modifierExtension		0..0		Extension
Slices for identifier		0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by
identifier:hpio		0..0		HPI-O for Directory Entry Organisation
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		My Health Record Assigned Identity for Organisations (PAI-O)
identifier:csp		0..0		Contracted Service Provider (CSP) Number
identifier:nataAccreditation		0..0		National Association of Testing Authorities (NATA) Accreditation Number
identifier:rid	S	0..1	NHSDResourceIdentifier	Organisation Directory Entry Identifiers
active		1..1	boolean	Reflects the current status of the organization resource
type		0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
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		Contact Details of Directroy Entry Organisation
address		0..0		Addresses of Directroy Entry Organisation
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		Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	extensible	Types of Organisation	📦4.0.1	This IG
Organization.contact.​purpose	Base	extensible		Not State	Unknown

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		Extension Slice: Unordered, Open by value:url
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
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
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	Status	Usage	ValueSet	Version	Source
Organization.identifier:hpio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:hpio.​type	Base	required	v2 Identifier Type - AU Extended	⏿1.0.2	tx.hl7.org.au
Organization.identifier:abn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:abn.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:acn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:acn.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:arbn.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:arbn.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:paio.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:paio.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:csp.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:csp.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:nataAccreditation.​use	Base	required	IdentifierUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.identifier:nataAccreditation.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.type	Base	extensible	Types of Organisation	📦4.0.1	This IG
Organization.address.​use	Base	required	AddressUse	📍4.0.1 → 4.0.0	FHIR Std.
Organization.address.​type	Base	required	AddressType	📍4.0.1 → 4.0.0	FHIR Std.
Organization.address.​state	Base	required	Australian States and Territories	📦2.0.1	hl7.fhir.au.pd v2.0
Organization.contact.​purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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: 20 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

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