Usage scenarios

The following are supported usage scenarios for this profile:

• Query for basic information for an organisation by name or identifier
• Recording or updating basic information for an organisation
• Read information about an organisation referenced by another resource

Comparison with other national and international IGs

A resource conforming to this profile is conformant to:

• Organization (IPS)
• and MAY be conformant to US Core Organization if Organization.active is supplied

No equivalent International Patient Access profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

• See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.
• When constructing an address
  • an international address can be represented using the core Address data type
  • an Australian address SHOULD be represented using the Australian Address data type profile

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

This structure is derived from AUBaseOrganisation

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	AUBaseOrganisation	An organisation in an Australian healthcare context
Slices for identifier	SOC	0..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:hpio	SO	0..1	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O) Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:abn	SO	0..*	AUAustralianBusinessNumber	Australian Business Number (ABN) Obligations Actor SHALL:populate-if-known SHALL:no-error
type	SO	0..*	CodeableConcept	Kind of organization Obligations Actor SHALL:populate-if-known SHALL:no-error
name	SO	1..1	string	Name used for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
telecom	SO	0..*	ContactPoint	A contact detail for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
address	SO	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) Obligations Actor SHALL:populate-if-known SHALL:no-error
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-org-01	error	Organization.identifier	A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O : type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	AUBaseOrganisation	An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOC	0..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:hpio	SOC	0..1	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:abn	SOC	0..*	AUAustralianBusinessNumber	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits Obligations Actor SHALL:populate-if-known SHALL:no-error
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SOΣ	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred) Obligations Actor SHALL:populate-if-known SHALL:no-error
name	SOΣC	1..1	string	Name used for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
telecom	SOC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
address	SOC	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) org-2: An address of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.type	preferred	HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-org-01	error	Organization.identifier	A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O : type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
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()
inv-abn-0	error	Organization.identifier:abn	ABN shall be 11 digits : value.matches('^([0-9]{11})$')
inv-hpio-0	error	Organization.identifier:hpio	HPI-O shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpio-1	error	Organization.identifier:hpio	HPI-O prefix shall be 800362 : value.startsWith('800362')
inv-hpio-2	error	Organization.identifier:hpio	HPI-O shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
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()

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	AUBaseOrganisation	An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOC	0..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:hpio	SOC	0..1	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:abn	SOC	0..*	AUAustralianBusinessNumber	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits Obligations Actor SHALL:populate-if-known SHALL:no-error
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SOΣ	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred) Obligations Actor SHALL:populate-if-known SHALL:no-error
name	SOΣC	1..1	string	Name used for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SOC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
address	SOC	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) org-2: An address of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: Contact Purpose (extensible)
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.type	preferred	HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose	extensible	ContactPurpose http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-org-01	error	Organization.identifier	A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O : type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
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()
inv-abn-0	error	Organization.identifier:abn	ABN shall be 11 digits : value.matches('^([0-9]{11})$')
inv-hpio-0	error	Organization.identifier:hpio	HPI-O shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpio-1	error	Organization.identifier:hpio	HPI-O prefix shall be 800362 : value.startsWith('800362')
inv-hpio-2	error	Organization.identifier:hpio	HPI-O shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Differential View

This structure is derived from AUBaseOrganisation

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	AUBaseOrganisation	An organisation in an Australian healthcare context
Slices for identifier	SOC	0..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:hpio	SO	0..1	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O) Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:abn	SO	0..*	AUAustralianBusinessNumber	Australian Business Number (ABN) Obligations Actor SHALL:populate-if-known SHALL:no-error
type	SO	0..*	CodeableConcept	Kind of organization Obligations Actor SHALL:populate-if-known SHALL:no-error
name	SO	1..1	string	Name used for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
telecom	SO	0..*	ContactPoint	A contact detail for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
address	SO	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) Obligations Actor SHALL:populate-if-known SHALL:no-error
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-org-01	error	Organization.identifier	A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O : type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	AUBaseOrganisation	An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOC	0..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:hpio	SOC	0..1	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:abn	SOC	0..*	AUAustralianBusinessNumber	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits Obligations Actor SHALL:populate-if-known SHALL:no-error
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SOΣ	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred) Obligations Actor SHALL:populate-if-known SHALL:no-error
name	SOΣC	1..1	string	Name used for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
telecom	SOC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
address	SOC	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) org-2: An address of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.type	preferred	HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-org-01	error	Organization.identifier	A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O : type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
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()
inv-abn-0	error	Organization.identifier:abn	ABN shall be 11 digits : value.matches('^([0-9]{11})$')
inv-hpio-0	error	Organization.identifier:hpio	HPI-O shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpio-1	error	Organization.identifier:hpio	HPI-O prefix shall be 800362 : value.startsWith('800362')
inv-hpio-2	error	Organization.identifier:hpio	HPI-O shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	AUBaseOrganisation	An organisation in an Australian healthcare context org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOC	0..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:hpio	SOC	0..1	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check Obligations Actor SHALL:populate-if-known SHALL:no-error
identifier:abn	SOC	0..*	AUAustralianBusinessNumber	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits Obligations Actor SHALL:populate-if-known SHALL:no-error
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SOΣ	0..*	CodeableConcept	Kind of organization Binding: Healthcare Organisation Role Type (preferred) Obligations Actor SHALL:populate-if-known SHALL:no-error
name	SOΣC	1..1	string	Name used for the organization Obligations Actor SHALL:populate-if-known SHALL:no-error
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SOC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
address	SOC	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) org-2: An address of an organization can never be of use 'home' Obligations Actor SHALL:populate-if-known SHALL:no-error
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: Contact Purpose (extensible)
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.type	preferred	HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 from https://tx.ontoserver.csiro.au/fhir
Organization.contact.purpose	extensible	ContactPurpose http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-org-01	error	Organization.identifier	A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O : type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
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()
inv-abn-0	error	Organization.identifier:abn	ABN shall be 11 digits : value.matches('^([0-9]{11})$')
inv-hpio-0	error	Organization.identifier:hpio	HPI-O shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpio-1	error	Organization.identifier:hpio	HPI-O prefix shall be 800362 : value.startsWith('800362')
inv-hpio-2	error	Organization.identifier:hpio	HPI-O shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 1 element
Must-Support: 7 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)

Slices

This structure defines the following Slices:

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

Maturity: 1

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Mandatory Search Parameters

The following search parameters SHALL be supported:

1. SHALL support searching an organisation by an identifier using the identifier search parameter:

   GET [base]/Organization?identifier={system|}[code]

   Example:

   1. GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455
   2. GET [base]/Organization?identifier=http://hl7.org.au/id/abn|23964200000

   Implementation Notes: Fetches a bundle containing any Organization resources matching the identifier (how to search by token)

Optional Search Parameters:

The following search parameters SHOULD be supported:

1. SHOULD support searching for an organisation based on text address using the address search parameter:

   GET [base]/Organization?address=[string]

   Example:

   1. GET [base]/Organization?address=QLD

   Implementation Notes: Fetches a bundle of all Organization resources matching the address (how to search by string)

2. SHOULD support searching for an organisation based on text name using the name search parameter:

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

   Example:

   1. GET [base]/Organization?name=Hospital

   Implementation Notes: Fetches a bundle of all Organization resources matching the name (how to search by string)

3. SHOULD support fetching an Organization using the _id search parameter:

   GET [base]/Organization/[id] or GET [base]/Organization?_id=[id]

   Example:

   1. GET [base]/Organization?_id=5678

   Implementation Notes: Fetches a single Organization (how to search by the logical id of the resource)