Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.1.0: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-organisation

Australian Organization Profile

This profile defines an organisation administration details structure that includes core localisation concepts.

Identifiers

These definitions represent common data held in the Organization.identifier element.

The Healthcare provider identifier—organisation (HPI-O) is the numerical identifier that uniquely identifies organisations in Australia where healthcare is provided.

Examples

Organisation with HPI-O and ANZSIC coded class/activity types

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-organisation

Australian realm Organisation profile

This profile builds on Organization.

This profile was published on Sat Mar 11 17:30:54 AEDT 2017 as a draft by Health Level Seven Australia (Patient Administration).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Organization Resource

  1. Optional HPI-O
  2. Optional organization type
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier I0..1IdentifierNational organisation identifier
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... type 1..1CodeableConceptHPI-O Identifier Type
..... coding 0..1CodingHPI-O Identifier Type Code
Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text 1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value 1..1stringExample HPI-O number': 8003627500000328
Max Length: 16
... type CodeableConceptSlice: Unordered, Open At End by value:Coding.system
... type Σ0..1CodeableConceptOrganisation Class Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type Σ0..1CodeableConceptOrganisation Activity Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIIdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system, value:type
... identifier ΣI0..1IdentifierNational organisation identifier
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-O Identifier Type
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-O Identifier Type Code

Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text Σ1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example HPI-O number': 8003627500000328
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type ΣCodeableConceptKind of organization
Slice: Unordered, Open At End by value:Coding.system
Binding: OrganizationType (example)
... type Σ0..1CodeableConceptOrganisation Class Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type Σ0..1CodeableConceptOrganisation Activity Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Organization Resource

  1. Optional HPI-O
  2. Optional organization type

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier I0..1IdentifierNational organisation identifier
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... type 1..1CodeableConceptHPI-O Identifier Type
..... coding 0..1CodingHPI-O Identifier Type Code
Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text 1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value 1..1stringExample HPI-O number': 8003627500000328
Max Length: 16
... type CodeableConceptSlice: Unordered, Open At End by value:Coding.system
... type Σ0..1CodeableConceptOrganisation Class Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type Σ0..1CodeableConceptOrganisation Activity Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIIdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system, value:type
... identifier ΣI0..1IdentifierNational organisation identifier
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-O Identifier Type
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-O Identifier Type Code

Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text Σ1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example HPI-O number': 8003627500000328
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type ΣCodeableConceptKind of organization
Slice: Unordered, Open At End by value:Coding.system
Binding: OrganizationType (example)
... type Σ0..1CodeableConceptOrganisation Class Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type Σ0..1CodeableConceptOrganisation Activity Type
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-organisation

none defined