Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: 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

AU Base Organization Profile [FMM Level 0]

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:

  • Healthcare Provider Identifier for Organisation - HPI-O [1] [2]
  • My Health Record Assigned Identity for Organisation, (formerly known as PCEHR Assigned Identity - Organisation) - PAI-O [1]
  • Contracted Service Provider Number - CSP [1]
  • ASIC Identifiers - Australian Business Number, Australian Company Number, Australian Registered Body Number [1] [2]
  • NATA Accreditation Number [1]

Examples

Organisation with HPI-O

Albion Hospital with Australian Business Number

Devonport Family Medicine Clinic with Australian Business Number

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 Fri Aug 03 00:00:00 AEST 2018 as a draft by Health Level Seven Australia (Patient Administration WG).

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

This profile contains the following variations from Organization:

  1. zero or more identifier Organisation identifiers sliced
    • at most one identifier HPI-O
    • zero or more identifier Australian Business Number
    • zero or more identifier Australian Company Number
    • zero or more identifier Australian Registered Body Number
    • at most one identifier PAI-O
    • at most one identifier Contracted Service Provider Number
    • zero or more identifier NATA Accreditation Number
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*An organisation in an Australian healthcare context
... identifier IdentifierOrganisation identifiers
Slice: Unordered, Open by value:system
... identifier 0..1IdentifierHPI-O
.... type 1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1CodingHPI-O Identifier Type Code
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: NOI
..... text 1..1stringHPI-O text description
Fixed Value: HPI-O
.... system 1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value I1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
Example HPI-O number': 8003627500000328
Max Length: 16
... identifier I0..*IdentifierAustralian Business Number
inv-asic-abn-length: 'ABN' must be 11 digits
.... type 1..1CodeableConcept
..... text 1..1stringFixed Value: ABN
.... system 1..1uriFixed Value: http://hl7.org.au/id/abn
.... value 1..1stringABN value
... identifier I0..*IdentifierAustralian Company Number
inv-asic-acn-length: 'ACN' must be 9 digits
.... type 1..1CodeableConcept
..... text 1..1stringFixed Value: ACN
.... system 1..1uriFixed Value: http://hl7.org.au/id/acn
.... value 1..1stringACN value
... identifier I0..*IdentifierAustralian Registered Body Number
inv-asic-arbn-length: 'ARBN' must be 9 digits
.... type 1..1CodeableConceptBinding: Identifier Type Codes (extensible)
..... text 1..1stringFixed Value: ARBN
.... system 1..1uriFixed Value: http://hl7.org.au/id/arbn
.... value 1..1stringARBN value
... identifier 0..1IdentifierPAI-O
.... type 1..1CodeableConceptPAI-O Identifier Type
..... text 1..1stringPAI-O Identifier Type Descriptive Text
Fixed Value: PAI-O
.... system 1..1uriNamespace URI for PAI-O values
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0
.... value I1..1stringinv-paio-0: The PAI-O shall be a 16 digit number.
inv-paio-1: The PAI-O prefix is 800364
inv-paio-2: The PAI-O Identifier shall pass the Luhn algorithm check
Example PAI-O number': 8003647500000328
Max Length: 16
... identifier I0..1IdentifierContracted Service Provider Number
inv-csp-0: CSP Number is exactly 16 characters
inv-csp-1: CSP Number prefix is 800363
.... type 1..1CodeableConceptCSP Number Identifier Type
..... text 1..1stringCSP Number Type Descriptive Text
Fixed Value: CSP
.... system 1..1uriNamespace uri for CSP Number values
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
.... value 1..1stringExample CSP number': 8003635500000327
Max Length: 16
... identifier 0..*IdentifierNATA Accreditation Number
.... type 1..1CodeableConcept
..... text 1..1stringFixed Value: NATA Accreditation Number
.... system 1..1uriNamespace for NATA Accreditation Number
Fixed Value: http://hl7.org.au/id/nata-accreditation
.... value 1..1string
... partOf 0..1Reference(AU Base Organisation)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*An organisation in an Australian healthcare context
... 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 ΣIIdentifierOrganisation identifiers
Slice: Unordered, Open by value:system
... identifier ΣI0..1IdentifierHPI-O
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingHPI-O Identifier Type Code
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringHPI-O text description
Fixed Value: HPI-O
.... system Σ1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value ΣI1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
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)
... identifier ΣI0..*IdentifierAustralian Business Number
inv-asic-abn-length: 'ABN' must be 11 digits
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ABN
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/abn
.... value Σ1..1stringABN value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..*IdentifierAustralian Company Number
inv-asic-acn-length: 'ACN' must be 9 digits
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ACN
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/acn
.... value Σ1..1stringACN value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..*IdentifierAustralian Registered Body Number
inv-asic-arbn-length: 'ARBN' must be 9 digits
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ARBN
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
.... value Σ1..1stringARBN value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..1IdentifierPAI-O
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPAI-O Identifier Type
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPAI-O Identifier Type Descriptive Text
Fixed Value: PAI-O
.... system Σ1..1uriNamespace URI for PAI-O values
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0
.... value ΣI1..1stringThe value that is unique
inv-paio-0: The PAI-O shall be a 16 digit number.
inv-paio-1: The PAI-O prefix is 800364
inv-paio-2: The PAI-O Identifier shall pass the Luhn algorithm check
Example General': 123456
Example PAI-O number': 8003647500000328
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)
... identifier ΣI0..1IdentifierContracted Service Provider Number
inv-csp-0: CSP Number is exactly 16 characters
inv-csp-1: CSP Number prefix is 800363
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCSP Number Identifier Type
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringCSP Number Type Descriptive Text
Fixed Value: CSP
.... system Σ1..1uriNamespace uri for CSP Number values
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example CSP number': 8003635500000327
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)
... identifier ΣI0..*IdentifierNATA Accreditation Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: NATA Accreditation Number
.... system Σ1..1uriNamespace for NATA Accreditation Number
Fixed Value: http://hl7.org.au/id/nata-accreditation
.... value Σ1..1stringThe value that is unique
Example General': 123456
.... 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 Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... 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(AU Base Organisation)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

This profile contains the following variations from Organization:

  1. zero or more identifier Organisation identifiers sliced
    • at most one identifier HPI-O
    • zero or more identifier Australian Business Number
    • zero or more identifier Australian Company Number
    • zero or more identifier Australian Registered Body Number
    • at most one identifier PAI-O
    • at most one identifier Contracted Service Provider Number
    • zero or more identifier NATA Accreditation Number

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*An organisation in an Australian healthcare context
... identifier IdentifierOrganisation identifiers
Slice: Unordered, Open by value:system
... identifier 0..1IdentifierHPI-O
.... type 1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 0..1CodingHPI-O Identifier Type Code
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: NOI
..... text 1..1stringHPI-O text description
Fixed Value: HPI-O
.... system 1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value I1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
Example HPI-O number': 8003627500000328
Max Length: 16
... identifier I0..*IdentifierAustralian Business Number
inv-asic-abn-length: 'ABN' must be 11 digits
.... type 1..1CodeableConcept
..... text 1..1stringFixed Value: ABN
.... system 1..1uriFixed Value: http://hl7.org.au/id/abn
.... value 1..1stringABN value
... identifier I0..*IdentifierAustralian Company Number
inv-asic-acn-length: 'ACN' must be 9 digits
.... type 1..1CodeableConcept
..... text 1..1stringFixed Value: ACN
.... system 1..1uriFixed Value: http://hl7.org.au/id/acn
.... value 1..1stringACN value
... identifier I0..*IdentifierAustralian Registered Body Number
inv-asic-arbn-length: 'ARBN' must be 9 digits
.... type 1..1CodeableConceptBinding: Identifier Type Codes (extensible)
..... text 1..1stringFixed Value: ARBN
.... system 1..1uriFixed Value: http://hl7.org.au/id/arbn
.... value 1..1stringARBN value
... identifier 0..1IdentifierPAI-O
.... type 1..1CodeableConceptPAI-O Identifier Type
..... text 1..1stringPAI-O Identifier Type Descriptive Text
Fixed Value: PAI-O
.... system 1..1uriNamespace URI for PAI-O values
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0
.... value I1..1stringinv-paio-0: The PAI-O shall be a 16 digit number.
inv-paio-1: The PAI-O prefix is 800364
inv-paio-2: The PAI-O Identifier shall pass the Luhn algorithm check
Example PAI-O number': 8003647500000328
Max Length: 16
... identifier I0..1IdentifierContracted Service Provider Number
inv-csp-0: CSP Number is exactly 16 characters
inv-csp-1: CSP Number prefix is 800363
.... type 1..1CodeableConceptCSP Number Identifier Type
..... text 1..1stringCSP Number Type Descriptive Text
Fixed Value: CSP
.... system 1..1uriNamespace uri for CSP Number values
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
.... value 1..1stringExample CSP number': 8003635500000327
Max Length: 16
... identifier 0..*IdentifierNATA Accreditation Number
.... type 1..1CodeableConcept
..... text 1..1stringFixed Value: NATA Accreditation Number
.... system 1..1uriNamespace for NATA Accreditation Number
Fixed Value: http://hl7.org.au/id/nata-accreditation
.... value 1..1string
... partOf 0..1Reference(AU Base Organisation)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*An organisation in an Australian healthcare context
... 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 ΣIIdentifierOrganisation identifiers
Slice: Unordered, Open by value:system
... identifier ΣI0..1IdentifierHPI-O
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingHPI-O Identifier Type Code
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringHPI-O text description
Fixed Value: HPI-O
.... system Σ1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value ΣI1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
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)
... identifier ΣI0..*IdentifierAustralian Business Number
inv-asic-abn-length: 'ABN' must be 11 digits
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ABN
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/abn
.... value Σ1..1stringABN value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..*IdentifierAustralian Company Number
inv-asic-acn-length: 'ACN' must be 9 digits
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ACN
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/acn
.... value Σ1..1stringACN value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..*IdentifierAustralian Registered Body Number
inv-asic-arbn-length: 'ARBN' must be 9 digits
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ARBN
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
.... value Σ1..1stringARBN value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier ΣI0..1IdentifierPAI-O
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPAI-O Identifier Type
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPAI-O Identifier Type Descriptive Text
Fixed Value: PAI-O
.... system Σ1..1uriNamespace URI for PAI-O values
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0
.... value ΣI1..1stringThe value that is unique
inv-paio-0: The PAI-O shall be a 16 digit number.
inv-paio-1: The PAI-O prefix is 800364
inv-paio-2: The PAI-O Identifier shall pass the Luhn algorithm check
Example General': 123456
Example PAI-O number': 8003647500000328
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)
... identifier ΣI0..1IdentifierContracted Service Provider Number
inv-csp-0: CSP Number is exactly 16 characters
inv-csp-1: CSP Number prefix is 800363
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptCSP Number Identifier Type
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringCSP Number Type Descriptive Text
Fixed Value: CSP
.... system Σ1..1uriNamespace uri for CSP Number values
Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example CSP number': 8003635500000327
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)
... identifier ΣI0..*IdentifierNATA Accreditation Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: NATA Accreditation Number
.... system Σ1..1uriNamespace for NATA Accreditation Number
Fixed Value: http://hl7.org.au/id/nata-accreditation
.... value Σ1..1stringThe value that is unique
Example General': 123456
.... 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 Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... 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(AU Base Organisation)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