AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreOrganization | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Organization resource to record, search, and fetch information about an organisation. It is based on the AU Base Organization profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Organization when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | SC | 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 |
   identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
 identifier:abn | S | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) |
  type | S | 0..* | CodeableConcept | Kind of organization |
| name | S | 1..1 | string | Name used for the organization |
| alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
| telecom | S | 0..* | ContactPoint | A contact detail for the organization |
 address | S | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| Documentation for this format | ||||
| 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 : where(type.coding.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') |
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described 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.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| address | SHALL | string |
|
| identifier | SHALL | token |
The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both. The client SHOULD support search using HPI-O and ABN identifiers as defined in the profile. The server SHOULD support search using the using HPI-O and ABN identifiers as defined in the profile. |
| name | SHALL | string |
|
| _id | SHOULD | token |
Specific feedback is sought on supporting search on Organization.address vs Organization.contact.address. The core FHIR search parameter `address` searches in Organization.contact.address. There is no core FHIR search parameter that searches Organization.adress.
The following search parameters SHALL be supported:
address search parameter:
_revinclude parameters: Provenance:targetGET [base]/Organization?address=[string]
Example:
Implementation Notes: Fetches a bundle of all Organization resources matching the address (how to search by string)
identifier search parameter:
_revinclude parameters: Provenance:targetGET [base]/Organization?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Organization resources matching the identifier (how to search by token)
name search parameter:
_revinclude parameters: Provenance:targetGET [base]/Organization?name=[string]
Example:
Implementation Notes: Fetches a bundle of all Organization resources matching the name (how to search by string)
The following search parameters SHOULD be supported:
_id search parameter:
_revinclude parameters: Provenance:targetGET [base]/Organization/[id] or GET [base]/Organization?_id=[id]
Example:
Implementation Notes: Fetches a single Organization (how to search by the logical id of the resource)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change