Usage Notes

Profile specific implementation guidance:

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

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

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

This structure is derived from AUBaseOrganisation

Name	Flags	Card.	Type	Description & Constraints
Organization	CTU	0..*	AUBaseOrganisation	Australian Organisation Directory Entry au-pd-org-01: At least one defined identifier, known to this AU PD Organisation profile, must be present
meta		0..1	Meta	Metadata on Organisation
source	S	0..1	uri	Identifies where the resource comes from
Slices for identifier	S	1..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio	S	0..*	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O)
active	S	1..1	boolean	Status of Directory Entry Organisation
name	S	1..1	string	Name of Directory Entry Organisation
telecom	S	0..*	ContactPoint	Contact Details of Directory Entry Organisation
address	S	0..*	Address, AustralianAddress	Addresses of Directory Entry Organisation
state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	AUBaseOrganisation	Australian Organisation Directory Entry org-1: The organization SHALL at least have a name or an identifier, and possibly more than one au-pd-org-01: At least one defined identifier, known to this AU PD Organisation profile, must be present
meta	Σ	0..1	Meta	Metadata on Organisation
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio	SC	0..*	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
active	?!SΣ	1..1	boolean	Status of Directory Entry Organisation
name	SΣC	1..1	string	Name of Directory Entry Organisation
telecom	SC	0..*	ContactPoint	Contact Details of Directory Entry Organisation org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address, AustralianAddress	Addresses of Directory Entry Organisation org-2: An address of an organization can never be of use 'home'
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

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

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

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Organization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
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.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Organization.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG
Organization.contact.purpose	extensible	ContactPurpose http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

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

Differential View

This structure is derived from AUBaseOrganisation

Name	Flags	Card.	Type	Description & Constraints
Organization	CTU	0..*	AUBaseOrganisation	Australian Organisation Directory Entry au-pd-org-01: At least one defined identifier, known to this AU PD Organisation profile, must be present
meta		0..1	Meta	Metadata on Organisation
source	S	0..1	uri	Identifies where the resource comes from
Slices for identifier	S	1..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio	S	0..*	AUHPIO	Healthcare Provider Identifier – Organisation (HPI-O)
active	S	1..1	boolean	Status of Directory Entry Organisation
name	S	1..1	string	Name of Directory Entry Organisation
telecom	S	0..*	ContactPoint	Contact Details of Directory Entry Organisation
address	S	0..*	Address, AustralianAddress	Addresses of Directory Entry Organisation
state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	AUBaseOrganisation	Australian Organisation Directory Entry org-1: The organization SHALL at least have a name or an identifier, and possibly more than one au-pd-org-01: At least one defined identifier, known to this AU PD Organisation profile, must be present
meta	Σ	0..1	Meta	Metadata on Organisation
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber	Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system
identifier:hpio	SC	0..*	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
active	?!SΣ	1..1	boolean	Status of Directory Entry Organisation
name	SΣC	1..1	string	Name of Directory Entry Organisation
telecom	SC	0..*	ContactPoint	Contact Details of Directory Entry Organisation org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address, AustralianAddress	Addresses of Directory Entry Organisation org-2: An address of an organization can never be of use 'home'
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

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

Snapshot View

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

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Organization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
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.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Organization.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG
Organization.contact.purpose	extensible	ContactPurpose http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

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

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 3 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

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

Slices

This structure defines the following Slices:

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

Maturity: 0

Read: Organisation

Read identified organisation resource content.

GET [base]/Organization/[id]

Example: GET [base]/Organization/1234

Support: MUST support read Organisation

Implementation Notes: (how to read resource)

Search: Active Status

Search based on active status of the organisation record.

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

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

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

Implementation Notes: (how to search by token)

Search: HPI-O

Search based on identifier token.

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

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

Support: SHOULD support search by HPI-O.

Implementation Notes: (how to search by token)

Search: Name

Search for a organisation by name.

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

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

Support:

• MUST support search by Organisation name.

Implementation Notes: (how to search by string)

Search: Combination

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