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
Organization.id	Σ This element is included in summaries.	1..1	id	Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Organization.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about Organisation resource
Organization.meta.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.meta.lastUpdated	Σ This element is included in summaries.	1..1	instant	The time when the resource was last updated
Organization.Slices for identifier	Σ This element is included in summaries. C	0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:abn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianBusinessNumber	Australian Business Number (ABN) Constraints: inv-abn-0
Organization.Slices for identifier.identifier:abn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:abn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ABN Fixed Value: http://hl7.org.au/id/abn (no extensions allowed)
Organization.Slices for identifier.identifier:abn.value	Σ This element is included in summaries.	1..1	string	ABN Example General: 123456
Organization.Slices for identifier.identifier:acn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianCompanyNumber	Australian Company Number (ACN) Constraints: inv-acn-0
Organization.Slices for identifier.identifier:acn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:acn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ACN Fixed Value: http://hl7.org.au/id/acn (no extensions allowed)
Organization.Slices for identifier.identifier:acn.value	Σ This element is included in summaries.	1..1	string	ACN Example General: 123456
Organization.Slices for identifier.identifier:arbn	S This element must be supported. Σ This element is included in summaries. C	0..*	AUAustralianRegisteredBodyNumber	Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
Organization.Slices for identifier.identifier:arbn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:arbn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
Organization.Slices for identifier.identifier:arbn.value	Σ This element is included in summaries.	1..1	string	ARBN Example General: 123456
Organization.Slices for identifier.identifier:rid	S This element must be supported.	0..1	NHSDResourceIdentifier	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	boolean	Reflects the current status of the organization resource
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
Organization.name	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Name of the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(NHSD Organisation)	This is a reference to the parent organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
Organization.contact.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

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
Organization.id		1..1	id	Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Organization.meta		1..1	Meta	Metadata about Organisation resource
Organization.meta.id		0..0		Unique id for inter-element referencing
Organization.meta.extension		0..0		Extension
Organization.meta.versionId		0..0		Version specific identifier
Organization.meta.lastUpdated		1..1	instant	The time when the resource was last updated
Organization.meta.source		0..0		Identifies where the resource comes from
Organization.meta.profile		0..0		Profiles this resource claims to conform to
Organization.meta.security		0..0		Security Labels applied to this resource
Organization.meta.tag		0..0		Tags applied to this resource
Organization.implicitRules		0..0		A set of rules under which this content was created
Organization.language		0..0		Language of the resource content
Organization.text		0..0		Text summary of the resource, for human interpretation
Organization.contained		0..0		Contained, inline Resources
Organization.extension		0..0		Extension
Organization.modifierExtension		0..0		Extension
Organization.Slices for identifier		0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:hpio		0..0		HPI-O for Directory Entry Organisation
Organization.Slices for identifier.identifier:abn	S This element must be supported.	0..1	AUAustralianBusinessNumber	Australian Business Number (ABN)
Organization.Slices for identifier.identifier:acn	S This element must be supported.	0..1	AUAustralianCompanyNumber	Australian Company Number (ACN)
Organization.Slices for identifier.identifier:arbn	S This element must be supported.	0..*	AUAustralianRegisteredBodyNumber	Australian Registered Body Number (ARBN)
Organization.Slices for identifier.identifier:paio		0..0		My Health Record Assigned Identity for Organisations (PAI-O)
Organization.Slices for identifier.identifier:csp		0..0		Contracted Service Provider (CSP) Number
Organization.Slices for identifier.identifier:nataAccreditation		0..0		National Association of Testing Authorities (NATA) Accreditation Number
Organization.Slices for identifier.identifier:rid	S This element must be supported.	0..1	NHSDResourceIdentifier	Identifies this organization across multiple systems
Organization.active		1..1	boolean	Reflects the current status of the organization resource
Organization.type		0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
Organization.name		1..1	string	Name of the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as
Organization.telecom		0..0		Contact Details of Directroy Entry Organisation
Organization.address		0..0		Addresses of Directroy Entry Organisation
Organization.partOf		0..1	Reference(NHSD Organisation)	This is a reference to the parent organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
Organization.contact.telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Organization.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
Organization.id	Σ This element is included in summaries.	1..1	id	Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Organization.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about Organisation resource
Organization.meta.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.meta.lastUpdated	Σ This element is included in summaries.	1..1	instant	The time when the resource was last updated
Organization.Slices for identifier	Σ This element is included in summaries. C	0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:abn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianBusinessNumber	Australian Business Number (ABN) Constraints: inv-abn-0
Organization.Slices for identifier.identifier:abn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:abn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:abn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:abn.type	Σ This element is included in summaries.	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.
Organization.Slices for identifier.identifier:abn.type.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:abn.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:abn.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Organization.Slices for identifier.identifier:abn.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept Fixed Value: ABN (no extensions allowed)
Organization.Slices for identifier.identifier:abn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ABN Fixed Value: http://hl7.org.au/id/abn (no extensions allowed)
Organization.Slices for identifier.identifier:abn.value	Σ This element is included in summaries.	1..1	string	ABN Example General: 123456
Organization.Slices for identifier.identifier:abn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:abn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:acn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianCompanyNumber	Australian Company Number (ACN) Constraints: inv-acn-0
Organization.Slices for identifier.identifier:acn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:acn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:acn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:acn.type	Σ This element is included in summaries.	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.
Organization.Slices for identifier.identifier:acn.type.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:acn.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:acn.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Organization.Slices for identifier.identifier:acn.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept Fixed Value: ACN (no extensions allowed)
Organization.Slices for identifier.identifier:acn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ACN Fixed Value: http://hl7.org.au/id/acn (no extensions allowed)
Organization.Slices for identifier.identifier:acn.value	Σ This element is included in summaries.	1..1	string	ACN Example General: 123456
Organization.Slices for identifier.identifier:acn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:acn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:arbn	S This element must be supported. Σ This element is included in summaries. C	0..*	AUAustralianRegisteredBodyNumber	Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
Organization.Slices for identifier.identifier:arbn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:arbn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:arbn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:arbn.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:arbn.type.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:arbn.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:arbn.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Organization.Slices for identifier.identifier:arbn.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept Fixed Value: ARBN (no extensions allowed)
Organization.Slices for identifier.identifier:arbn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
Organization.Slices for identifier.identifier:arbn.value	Σ This element is included in summaries.	1..1	string	ARBN Example General: 123456
Organization.Slices for identifier.identifier:arbn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:arbn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:rid	S This element must be supported.	0..1	NHSDResourceIdentifier	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	boolean	Reflects the current status of the organization resource
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
Organization.name	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Name of the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(NHSD Organisation)	This is a reference to the parent organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.id		0..1	string	Unique id for inter-element referencing
Organization.contact.extension		0..*	Extension	Additional content defined by implementations
Organization.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
Organization.contact.name		0..1	HumanName	A name associated with the contact
Organization.contact.telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Organization.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

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
Organization.id	Σ This element is included in summaries.	1..1	id	Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Organization.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about Organisation resource
Organization.meta.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.meta.lastUpdated	Σ This element is included in summaries.	1..1	instant	The time when the resource was last updated
Organization.Slices for identifier	Σ This element is included in summaries. C	0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:abn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianBusinessNumber	Australian Business Number (ABN) Constraints: inv-abn-0
Organization.Slices for identifier.identifier:abn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:abn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ABN Fixed Value: http://hl7.org.au/id/abn (no extensions allowed)
Organization.Slices for identifier.identifier:abn.value	Σ This element is included in summaries.	1..1	string	ABN Example General: 123456
Organization.Slices for identifier.identifier:acn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianCompanyNumber	Australian Company Number (ACN) Constraints: inv-acn-0
Organization.Slices for identifier.identifier:acn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:acn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ACN Fixed Value: http://hl7.org.au/id/acn (no extensions allowed)
Organization.Slices for identifier.identifier:acn.value	Σ This element is included in summaries.	1..1	string	ACN Example General: 123456
Organization.Slices for identifier.identifier:arbn	S This element must be supported. Σ This element is included in summaries. C	0..*	AUAustralianRegisteredBodyNumber	Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
Organization.Slices for identifier.identifier:arbn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:arbn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
Organization.Slices for identifier.identifier:arbn.value	Σ This element is included in summaries.	1..1	string	ARBN Example General: 123456
Organization.Slices for identifier.identifier:rid	S This element must be supported.	0..1	NHSDResourceIdentifier	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	boolean	Reflects the current status of the organization resource
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
Organization.name	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Name of the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(NHSD Organisation)	This is a reference to the parent organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
Organization.contact.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

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
Organization.id		1..1	id	Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Organization.meta		1..1	Meta	Metadata about Organisation resource
Organization.meta.id		0..0		Unique id for inter-element referencing
Organization.meta.extension		0..0		Extension
Organization.meta.versionId		0..0		Version specific identifier
Organization.meta.lastUpdated		1..1	instant	The time when the resource was last updated
Organization.meta.source		0..0		Identifies where the resource comes from
Organization.meta.profile		0..0		Profiles this resource claims to conform to
Organization.meta.security		0..0		Security Labels applied to this resource
Organization.meta.tag		0..0		Tags applied to this resource
Organization.implicitRules		0..0		A set of rules under which this content was created
Organization.language		0..0		Language of the resource content
Organization.text		0..0		Text summary of the resource, for human interpretation
Organization.contained		0..0		Contained, inline Resources
Organization.extension		0..0		Extension
Organization.modifierExtension		0..0		Extension
Organization.Slices for identifier		0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:hpio		0..0		HPI-O for Directory Entry Organisation
Organization.Slices for identifier.identifier:abn	S This element must be supported.	0..1	AUAustralianBusinessNumber	Australian Business Number (ABN)
Organization.Slices for identifier.identifier:acn	S This element must be supported.	0..1	AUAustralianCompanyNumber	Australian Company Number (ACN)
Organization.Slices for identifier.identifier:arbn	S This element must be supported.	0..*	AUAustralianRegisteredBodyNumber	Australian Registered Body Number (ARBN)
Organization.Slices for identifier.identifier:paio		0..0		My Health Record Assigned Identity for Organisations (PAI-O)
Organization.Slices for identifier.identifier:csp		0..0		Contracted Service Provider (CSP) Number
Organization.Slices for identifier.identifier:nataAccreditation		0..0		National Association of Testing Authorities (NATA) Accreditation Number
Organization.Slices for identifier.identifier:rid	S This element must be supported.	0..1	NHSDResourceIdentifier	Identifies this organization across multiple systems
Organization.active		1..1	boolean	Reflects the current status of the organization resource
Organization.type		0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
Organization.name		1..1	string	Name of the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as
Organization.telecom		0..0		Contact Details of Directroy Entry Organisation
Organization.address		0..0		Addresses of Directroy Entry Organisation
Organization.partOf		0..1	Reference(NHSD Organisation)	This is a reference to the parent organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
Organization.contact.telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Organization.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
Organization.id	Σ This element is included in summaries.	1..1	id	Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Organization.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about Organisation resource
Organization.meta.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.meta.lastUpdated	Σ This element is included in summaries.	1..1	instant	The time when the resource was last updated
Organization.Slices for identifier	Σ This element is included in summaries. C	0..*	Identifier	NHSD entry Organization identifiers Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:abn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianBusinessNumber	Australian Business Number (ABN) Constraints: inv-abn-0
Organization.Slices for identifier.identifier:abn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:abn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:abn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:abn.type	Σ This element is included in summaries.	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.
Organization.Slices for identifier.identifier:abn.type.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:abn.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:abn.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Organization.Slices for identifier.identifier:abn.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept Fixed Value: ABN (no extensions allowed)
Organization.Slices for identifier.identifier:abn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ABN Fixed Value: http://hl7.org.au/id/abn (no extensions allowed)
Organization.Slices for identifier.identifier:abn.value	Σ This element is included in summaries.	1..1	string	ABN Example General: 123456
Organization.Slices for identifier.identifier:abn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:abn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:acn	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAustralianCompanyNumber	Australian Company Number (ACN) Constraints: inv-acn-0
Organization.Slices for identifier.identifier:acn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:acn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:acn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:acn.type	Σ This element is included in summaries.	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.
Organization.Slices for identifier.identifier:acn.type.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:acn.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:acn.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Organization.Slices for identifier.identifier:acn.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept Fixed Value: ACN (no extensions allowed)
Organization.Slices for identifier.identifier:acn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ACN Fixed Value: http://hl7.org.au/id/acn (no extensions allowed)
Organization.Slices for identifier.identifier:acn.value	Σ This element is included in summaries.	1..1	string	ACN Example General: 123456
Organization.Slices for identifier.identifier:acn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:acn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:arbn	S This element must be supported. Σ This element is included in summaries. C	0..*	AUAustralianRegisteredBodyNumber	Australian Registered Body Number (ARBN) Constraints: inv-arbn-0
Organization.Slices for identifier.identifier:arbn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:arbn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:arbn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:arbn.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:arbn.type.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:arbn.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:arbn.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Organization.Slices for identifier.identifier:arbn.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept Fixed Value: ARBN (no extensions allowed)
Organization.Slices for identifier.identifier:arbn.system	Σ This element is included in summaries.	1..1	uri	Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
Organization.Slices for identifier.identifier:arbn.value	Σ This element is included in summaries.	1..1	string	ARBN Example General: 123456
Organization.Slices for identifier.identifier:arbn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:arbn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:rid	S This element must be supported.	0..1	NHSDResourceIdentifier	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	boolean	Reflects the current status of the organization resource
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Types of Organisation (extensible): Name of program(s) that the Healthcare Service is a part of
Organization.name	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Name of the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(NHSD Organisation)	This is a reference to the parent organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.id		0..1	string	Unique id for inter-element referencing
Organization.contact.extension		0..*	Extension	Additional content defined by implementations
Organization.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
Organization.contact.name		0..1	HumanName	A name associated with the contact
Organization.contact.telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Organization.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

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