Usage Notes

Profile specific implementation guidance:

• See each Identifier profile page for guidance related to that identifier type.
• When selecting a code for Organization.type:
  • Where possible a code from the preferred Healthcare Organisation Role Type value set should be selected.
  • If a system is unable to provide a code from the preferred value set because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select a suitable code from SNOMED CT.
  • If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used.
• When constructing an address:
  • an international address can be represented using the core Address data type
  • an Australian address can be represented using the Australian Address data type profile
• Additional considerations for systems aligning to HL7 AU Base:
  • Contact details and associated contact purpose are encouraged to be sent in Organization.contact over making use of the Contact Purpose extension.

Changes since version 6.0.0:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	An organisation in an Australian healthcare context Constraints: org-1
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.identifier	Σ This element is included in summaries. C	0..*	Identifier , AUHPIO , AUHAE , AUHSPO , AUPAIOIdentifier , AUCSPRegistrationNumber , AUAustralianBusinessNumber , AUAustralianCompanyNumber , AUAustralianRegisteredBodyNumber , AUNATAAccreditationNumber , AUPharmacyApprovalNumber	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred)
Organization.address	C	0..*	Address , AustralianAddress	An address for the organization Constraints: org-2
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: Contact Purpose (extensible)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	preferred	Healthcare Organisation Role Type	⏿1.1.0	tx.hl7.org.au
Organization.contact.​purpose	Base	extensible	Contact Purpose	📦7.0.0-ci-build	This IG

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())
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()

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization		0..*	Organization	An organisation in an Australian healthcare context
Organization.identifier		0..*	Identifier, AUHPIO, AUHAE, AUHSPO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems
Organization.type		0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred)
Organization.address		0..*	Address, AustralianAddress	An address for the organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: Contact Purpose (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	preferred	Healthcare Organisation Role Type	⏿1.1.0	tx.hl7.org.au
Organization.contact.​purpose	Base	extensible	Contact Purpose	📦7.0.0-ci-build	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	An organisation in an Australian healthcare context Constraints: org-1
Organization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Organization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Organization.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
Organization.contained		0..*	Resource	Contained, inline Resources
Organization.extension		0..*	Extension	Additional content defined by implementations
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.identifier	Σ This element is included in summaries. C	0..*	Identifier , AUHPIO , AUHAE , AUHSPO , AUPAIOIdentifier , AUCSPRegistrationNumber , AUAustralianBusinessNumber , AUAustralianCompanyNumber , AUAustralianRegisteredBodyNumber , AUNATAAccreditationNumber , AUPharmacyApprovalNumber	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred)
Organization.name	Σ This element is included in summaries. C	0..1	string	Name used for the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.address	C	0..*	Address , AustralianAddress	An address for the organization Constraints: org-2
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(Organization)	The organization of which this organization forms a part
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: Contact Purpose (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
Organization.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.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.contact.​purpose	Base	extensible	Contact Purpose	📦7.0.0-ci-build	This IG

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())
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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	An organisation in an Australian healthcare context Constraints: org-1
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.identifier	Σ This element is included in summaries. C	0..*	Identifier , AUHPIO , AUHAE , AUHSPO , AUPAIOIdentifier , AUCSPRegistrationNumber , AUAustralianBusinessNumber , AUAustralianCompanyNumber , AUAustralianRegisteredBodyNumber , AUNATAAccreditationNumber , AUPharmacyApprovalNumber	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred)
Organization.address	C	0..*	Address , AustralianAddress	An address for the organization Constraints: org-2
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: Contact Purpose (extensible)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	preferred	Healthcare Organisation Role Type	⏿1.1.0	tx.hl7.org.au
Organization.contact.​purpose	Base	extensible	Contact Purpose	📦7.0.0-ci-build	This IG

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())
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()

Differential View

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization		0..*	Organization	An organisation in an Australian healthcare context
Organization.identifier		0..*	Identifier, AUHPIO, AUHAE, AUHSPO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems
Organization.type		0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred)
Organization.address		0..*	Address, AustralianAddress	An address for the organization
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: Contact Purpose (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	preferred	Healthcare Organisation Role Type	⏿1.1.0	tx.hl7.org.au
Organization.contact.​purpose	Base	extensible	Contact Purpose	📦7.0.0-ci-build	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	An organisation in an Australian healthcare context Constraints: org-1
Organization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Organization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Organization.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
Organization.contained		0..*	Resource	Contained, inline Resources
Organization.extension		0..*	Extension	Additional content defined by implementations
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.identifier	Σ This element is included in summaries. C	0..*	Identifier , AUHPIO , AUHAE , AUHSPO , AUPAIOIdentifier , AUCSPRegistrationNumber , AUAustralianBusinessNumber , AUAustralianCompanyNumber , AUAustralianRegisteredBodyNumber , AUNATAAccreditationNumber , AUPharmacyApprovalNumber	Identifies this organization across multiple systems
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred)
Organization.name	Σ This element is included in summaries. C	0..1	string	Name used for the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.address	C	0..*	Address , AustralianAddress	An address for the organization Constraints: org-2
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(Organization)	The organization of which this organization forms a part
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: Contact Purpose (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
Organization.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.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.contact.​purpose	Base	extensible	Contact Purpose	📦7.0.0-ci-build	This IG

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())
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 Organization

Summary

Maturity: 3