Magentus Practice Management FHIR Implementation Guide
1.2.35 - ci-build

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.35) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Genie Organization

Official URL: http://fhir.geniesolutions.io/StructureDefinition/gs-organization Version: 1.2.35
Draft as of 2025-03-02 Computable Name: GSOrganization

Genie Organization core profile

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id SΣ 0..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SC 0..1 AUHPIO Healthcare Provider Identifier – Organisation (HPI-O)
ele-1: All FHIR elements must have a @value or children
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
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
ele-1: All FHIR elements must have a @value or children
inv-abn-0: ABN shall be 11 digits
.... identifier:nataAccreditation SC 0..1 AUNATAAccreditationNumber Laboratory or Imaging NATA accreditation number
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NATAA
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://hl7.org.au/id/nata-accreditation
..... value Σ 1..1 string NATA accreditation number
ele-1: All FHIR elements must have a @value or children
Example General: 123456
Example NATA accreditation number: 244842
.... identifier:acn SC 0..1 AUAustralianCompanyNumber Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:localOrganizationIdentifier SC 0..1 GSOrganizationLocalIdentifier Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Clinic name
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
ele-1: All FHIR elements must have a @value or children
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system, value:use
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..2 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
.... telecom:fax SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: fax
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: email
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
.... telecom:website SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: url
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
... Slices for address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use, value:type
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
.... address:physical SC 0..1 AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
..... Slices for extension Content/Rules for all slices
...... extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
....... value[x] 1..1 Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
...... extension:noFixedAddress C 0..1 boolean No fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
..... type ΣC 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Required Pattern: physical
..... text ΣC 0..1 string Text representation of the address
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
..... line ΣC 0..2 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... country Σ 0..1 string Australia as a 2 digit ISO 3166 code
ele-1: All FHIR elements must have a @value or children
Fixed Value: AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier:nataAccreditation.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nataAccreditation.typeextensiblePattern: NATAA
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:fax.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:website.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address:physical.userequiredPattern: work
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifierA 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')
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-abn-0errorOrganization.identifier:abnABN shall be 11 digits
: value.matches('^([0-9]{11})$')
inv-hpio-0errorOrganization.identifier:hpioHPI-O shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-hpio-1errorOrganization.identifier:hpioHPI-O prefix shall be 800362
: value.startsWith('800362')
inv-hpio-2errorOrganization.identifier:hpioHPI-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-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:physicalAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:websiteThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization AUCoreOrganization
... id S 0..1 id Logical id of this artifact
... Slices for identifier Content/Rules for all slices
.... identifier:nataAccreditation S 0..1 AUNATAAccreditationNumber Laboratory or Imaging NATA accreditation number
..... type
...... coding 1..1 Coding Code defined by a terminology system
.... identifier:acn 0..1 AUAustralianCompanyNumber Identifies this organization across multiple systems
.... identifier:localOrganizationIdentifier 0..1 GSOrganizationLocalIdentifier Identifies this organization across multiple systems
... active S 1..1 boolean Whether the organization's record is still in active use
... name 1..1 string Clinic name
... Slices for telecom 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system, value:use
.... telecom:phone S 0..2 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:fax S 0..1 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:email S 0..1 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:website S 0..1 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: url
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
... Slices for address 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use, value:type
.... address:physical S 0..1 AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Required Pattern: work
..... type 1..1 code postal | physical | both
Required Pattern: physical
..... line 0..2 string Street name, number, direction & P.O. Box etc.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization 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 SΣ 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 BindingsPurpose
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 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 SC 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
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
.... identifier:nataAccreditation SC 0..1 AUNATAAccreditationNumber Laboratory or Imaging NATA accreditation number
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
..... 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 usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NATAA
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/nata-accreditation
..... value Σ 1..1 string NATA accreditation number
Example General: 123456
Example NATA accreditation number: 244842
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:acn SC 0..1 AUAustralianCompanyNumber Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:localOrganizationIdentifier SC 0..1 GSOrganizationLocalIdentifier Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SΣC 1..1 string Clinic name
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system, value:use
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..2 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:fax SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:website SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... Slices for address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use, value:type
org-2: An address of an organization can never be of use 'home'
.... address:physical SC 0..1 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'
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
....... value[x] 1..1 Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier An identifier intended for computation
...... extension:noFixedAddress C 0..1 boolean No fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: work
..... type ΣC 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
..... text ΣC 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line ΣC 0..2 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 or suburb
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state Σ 0..1 string Australian state or territory
Binding: Australian States and Territories . (required)
..... postalCode ΣC 0..1 string Postal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
..... country Σ 0..1 string Australia as a 2 digit ISO 3166 code
Fixed Value: AU
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:nataAccreditation.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nataAccreditation.typeextensiblePattern: NATAA
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:fax.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:website.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address:physical.userequiredPattern: work
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:physical.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Organization.contact.purposeextensibleContactPurpose
http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifierA 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')
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-abn-0errorOrganization.identifier:abnABN shall be 11 digits
: value.matches('^([0-9]{11})$')
inv-add-3errorOrganization.address:physical.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')
inv-hpio-0errorOrganization.identifier:hpioHPI-O shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-hpio-1errorOrganization.identifier:hpioHPI-O prefix shall be 800362
: value.startsWith('800362')
inv-hpio-2errorOrganization.identifier:hpioHPI-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-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:physicalAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:websiteThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from AUCoreOrganization

Summary

Mandatory: 1 element(15 nested mandatory elements)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organization.telecom
  • The element 2 is sliced based on the values of Organization.address

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id SΣ 0..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:hpio SC 0..1 AUHPIO Healthcare Provider Identifier – Organisation (HPI-O)
ele-1: All FHIR elements must have a @value or children
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
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
ele-1: All FHIR elements must have a @value or children
inv-abn-0: ABN shall be 11 digits
.... identifier:nataAccreditation SC 0..1 AUNATAAccreditationNumber Laboratory or Imaging NATA accreditation number
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NATAA
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://hl7.org.au/id/nata-accreditation
..... value Σ 1..1 string NATA accreditation number
ele-1: All FHIR elements must have a @value or children
Example General: 123456
Example NATA accreditation number: 244842
.... identifier:acn SC 0..1 AUAustralianCompanyNumber Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:localOrganizationIdentifier SC 0..1 GSOrganizationLocalIdentifier Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Clinic name
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
ele-1: All FHIR elements must have a @value or children
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system, value:use
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..2 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
.... telecom:fax SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: fax
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: email
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
.... telecom:website SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: url
..... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
... Slices for address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use, value:type
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
.... address:physical SC 0..1 AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
..... Slices for extension Content/Rules for all slices
...... extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
....... value[x] 1..1 Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
...... extension:noFixedAddress C 0..1 boolean No fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Required Pattern: work
..... type ΣC 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Required Pattern: physical
..... text ΣC 0..1 string Text representation of the address
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
..... line ΣC 0..2 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... country Σ 0..1 string Australia as a 2 digit ISO 3166 code
ele-1: All FHIR elements must have a @value or children
Fixed Value: AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier:nataAccreditation.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nataAccreditation.typeextensiblePattern: NATAA
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:fax.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:website.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address:physical.userequiredPattern: work
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifierA 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')
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-abn-0errorOrganization.identifier:abnABN shall be 11 digits
: value.matches('^([0-9]{11})$')
inv-hpio-0errorOrganization.identifier:hpioHPI-O shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-hpio-1errorOrganization.identifier:hpioHPI-O prefix shall be 800362
: value.startsWith('800362')
inv-hpio-2errorOrganization.identifier:hpioHPI-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-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:physicalAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:websiteThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Differential View

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization AUCoreOrganization
... id S 0..1 id Logical id of this artifact
... Slices for identifier Content/Rules for all slices
.... identifier:nataAccreditation S 0..1 AUNATAAccreditationNumber Laboratory or Imaging NATA accreditation number
..... type
...... coding 1..1 Coding Code defined by a terminology system
.... identifier:acn 0..1 AUAustralianCompanyNumber Identifies this organization across multiple systems
.... identifier:localOrganizationIdentifier 0..1 GSOrganizationLocalIdentifier Identifies this organization across multiple systems
... active S 1..1 boolean Whether the organization's record is still in active use
... name 1..1 string Clinic name
... Slices for telecom 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system, value:use
.... telecom:phone S 0..2 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:fax S 0..1 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:email S 0..1 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:website S 0..1 ContactPoint A contact detail for the organization
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: url
..... value 1..1 string The actual contact point details
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
... Slices for address 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use, value:type
.... address:physical S 0..1 AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Required Pattern: work
..... type 1..1 code postal | physical | both
Required Pattern: physical
..... line 0..2 string Street name, number, direction & P.O. Box etc.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* AUCoreOrganization 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 SΣ 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 BindingsPurpose
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 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 SC 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
.... identifier:abn SC 0..* AUAustralianBusinessNumber Australian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
.... identifier:nataAccreditation SC 0..1 AUNATAAccreditationNumber Laboratory or Imaging NATA accreditation number
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
..... 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 usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NATAA
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/nata-accreditation
..... value Σ 1..1 string NATA accreditation number
Example General: 123456
Example NATA accreditation number: 244842
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:acn SC 0..1 AUAustralianCompanyNumber Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
.... identifier:localOrganizationIdentifier SC 0..1 GSOrganizationLocalIdentifier Identifies this organization across multiple systems
au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 0..* CodeableConcept Kind of organization
Binding: Healthcare Organisation Role Type . (preferred)
... name SΣC 1..1 string Clinic name
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system, value:use
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..2 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:fax SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:website SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom 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
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value Σ 1..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... Slices for address SC 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slice: Unordered, Open by value:use, value:type
org-2: An address of an organization can never be of use 'home'
.... address:physical SC 0..1 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'
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:identifier 0..* (Complex) Identifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/address-identifier"
....... value[x] 1..1 Identifier, AUDeliveryPointIdentifier, AUGNAFIdentifier An identifier intended for computation
...... extension:noFixedAddress C 0..1 boolean No fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
..... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: work
..... type ΣC 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
..... text ΣC 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line ΣC 0..2 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 or suburb
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state Σ 0..1 string Australian state or territory
Binding: Australian States and Territories . (required)
..... postalCode ΣC 0..1 string Postal code for area
inv-add-3: Postal code shall be 4 digits
Example General: 9132
..... country Σ 0..1 string Australia as a 2 digit ISO 3166 code
Fixed Value: AU
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:nataAccreditation.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nataAccreditation.typeextensiblePattern: NATAA
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typepreferredHealthcareOrganisationRoleType .
https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1
Organization.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:fax.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:website.userequiredPattern: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address:physical.userequiredPattern: work
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:physical.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Organization.contact.purposeextensibleContactPurpose
http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

IdGradePath(s)DetailsRequirements
au-core-org-01errorOrganization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifierA 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')
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-abn-0errorOrganization.identifier:abnABN shall be 11 digits
: value.matches('^([0-9]{11})$')
inv-add-3errorOrganization.address:physical.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')
inv-hpio-0errorOrganization.identifier:hpioHPI-O shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-hpio-1errorOrganization.identifier:hpioHPI-O prefix shall be 800362
: value.startsWith('800362')
inv-hpio-2errorOrganization.identifier:hpioHPI-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-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:physicalAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:websiteThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from AUCoreOrganization

Summary

Mandatory: 1 element(15 nested mandatory elements)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organization.telecom
  • The element 2 is sliced based on the values of Organization.address

 

Other representations of profile: CSV, Excel, Schematron