Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build
Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build
Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-diagnostic-parent | Version: 1.2.60 | |||
| Active as of 2026-04-05 | Computable Name: EOrdersOrganizationDiagnosticParent | |||
An extension of the Genie Organization resource to represent a diagnostic parent organisation. These are defining the hierarchy of Organizations where a parent organisation may cover a number of brand Organizations. Fillers can choose to discover new orders based on individual Task.owner brands or instead discover orders based on the Task.owner part-of relationship.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Organization |
C | 0..* | GSOrganization | An organisation in an Australian healthcare context Constraints: org-1 |
  id |
SΣ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:testList |
S | 0..1 | Reference(ValueSet) | Organization Test List Extension URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-testlist-ext |
 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 Constraints: au-core-org-01 |
 identifier:hpio |
SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2 |
| identifier:abn |
SC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0 |
| identifier:nataAccreditation |
SC | 0..1 | AUNATAAccreditationNumber | Laboratory or Imaging NATA accreditation number Constraints: au-core-org-01 |
  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 | |
| text |
0..1 | string | Plain text representation of the concept | |
 coding |
Σ | 1..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 | |
| 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 |
| identifier:acn |
SC | 0..1 | AUAustralianCompanyNumber | Identifies this organization across multiple systems Constraints: au-core-org-01 |
| identifier:localOrganizationIdentifier |
SC | 0..1 | GSOrganizationLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 |
| identifier:localPracticeIdentifier |
SC | 0..1 | GSPracticeLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 |
| 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)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://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 722171005 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Diagnostic institution | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| name |
SΣC | 1..1 | string | Practice 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 Constraints: org-3 |
| telecom:phone |
SC | 0..2 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| telecom:fax |
SC | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| telecom:email |
SC | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| telecom:website |
SC | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| 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 Constraints: org-2 |
| address:physical |
SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) Constraints: org-2 |
| 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 |
Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical |
| line |
Σ | 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 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:nataAccreditation.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:nataAccreditation.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.1.0 | tx.hl7.org.au |
| Organization.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifier, Organization.identifier:localPracticeIdentifier | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
where(type.coding.code = 'NOI').exists() implies (system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0')
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 |
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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-abn-0 | error | Organization.identifier:abn | ABN shall be 11 digits |
value.matches('^([0-9]{11})$')
|
| inv-hpio-0 | error | Organization.identifier:hpio | HPI-O shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpio-1 | error | Organization.identifier:hpio | HPI-O prefix shall be 800362 |
value.startsWith('800362')
|
| inv-hpio-2 | error | Organization.identifier:hpio | HPI-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-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address, Organization.address:physical | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:website | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from GSOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | GSOrganization | An organisation in an Australian healthcare context | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:testList |
S | 0..1 | Reference(ValueSet) | Organization Test List Extension URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-testlist-ext |
 type |
0..* | CodeableConcept | Kind of organization 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://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 722171005 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Diagnostic institution | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | GSOrganization | An organisation in an Australian healthcare context Constraints: org-1 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:testList |
S | 0..1 | Reference(ValueSet) | Organization Test List Extension URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-testlist-ext | ||||
| 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 Constraints: au-core-org-01 | ||||
| identifier:hpio |
SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2 | ||||
| identifier:abn |
SC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0 | ||||
| identifier:nataAccreditation |
SC | 0..1 | AUNATAAccreditationNumber | Laboratory or Imaging NATA accreditation number Constraints: au-core-org-01 | ||||
| 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 Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..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 | ||||
| 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 Constraints: au-core-org-01 | ||||
| identifier:localOrganizationIdentifier |
SC | 0..1 | GSOrganizationLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 | ||||
| identifier:localPracticeIdentifier |
SC | 0..1 | GSPracticeLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 | ||||
| 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)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://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 722171005 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Diagnostic institution | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| name |
SΣC | 1..1 | string | Practice 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 Constraints: org-3 | ||||
| telecom:phone |
SC | 0..2 | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
| 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 Constraints: org-3 | ||||
| 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 Constraints: org-3 | ||||
| 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 Constraints: org-3 | ||||
| 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 Constraints: org-2 | ||||
| address:physical |
SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) Constraints: org-2 | ||||
| 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 |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: work | ||||
| type |
Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
Σ | 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 etc. Example General: Erewhon | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| partOf |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
| name |
0..1 | HumanName | A name associated with the contact | |||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Organization.identifier:nataAccreditation.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:nataAccreditation.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.1.0 | tx.hl7.org.au |
| Organization.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifier, Organization.identifier:localPracticeIdentifier | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
where(type.coding.code = 'NOI').exists() implies (system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0')
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 |
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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-abn-0 | error | Organization.identifier:abn | ABN shall be 11 digits |
value.matches('^([0-9]{11})$')
|
| inv-hpio-0 | error | Organization.identifier:hpio | HPI-O shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpio-1 | error | Organization.identifier:hpio | HPI-O prefix shall be 800362 |
value.startsWith('800362')
|
| inv-hpio-2 | error | Organization.identifier:hpio | HPI-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-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address, Organization.address:physical | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:website | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from GSOrganization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | GSOrganization | An organisation in an Australian healthcare context Constraints: org-1 |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:testList |
S | 0..1 | Reference(ValueSet) | Organization Test List Extension URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-testlist-ext |
| 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 Constraints: au-core-org-01 |
| identifier:hpio |
SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2 |
| identifier:abn |
SC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0 |
| identifier:nataAccreditation |
SC | 0..1 | AUNATAAccreditationNumber | Laboratory or Imaging NATA accreditation number Constraints: au-core-org-01 |
| 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 | |
| text |
0..1 | string | Plain text representation of the concept | |
| coding |
Σ | 1..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 | |
| 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 |
| identifier:acn |
SC | 0..1 | AUAustralianCompanyNumber | Identifies this organization across multiple systems Constraints: au-core-org-01 |
| identifier:localOrganizationIdentifier |
SC | 0..1 | GSOrganizationLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 |
| identifier:localPracticeIdentifier |
SC | 0..1 | GSPracticeLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 |
| 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)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://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 722171005 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Diagnostic institution | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| name |
SΣC | 1..1 | string | Practice 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 Constraints: org-3 |
| telecom:phone |
SC | 0..2 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| telecom:fax |
SC | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| telecom:email |
SC | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| telecom:website |
SC | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3 |
| 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 |
| 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 Constraints: org-2 |
| address:physical |
SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) Constraints: org-2 |
| 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 |
Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical |
| line |
Σ | 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 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:nataAccreditation.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:nataAccreditation.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.1.0 | tx.hl7.org.au |
| Organization.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifier, Organization.identifier:localPracticeIdentifier | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
where(type.coding.code = 'NOI').exists() implies (system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0')
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 |
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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-abn-0 | error | Organization.identifier:abn | ABN shall be 11 digits |
value.matches('^([0-9]{11})$')
|
| inv-hpio-0 | error | Organization.identifier:hpio | HPI-O shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpio-1 | error | Organization.identifier:hpio | HPI-O prefix shall be 800362 |
value.startsWith('800362')
|
| inv-hpio-2 | error | Organization.identifier:hpio | HPI-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-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address, Organization.address:physical | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:website | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
Differential View
This structure is derived from GSOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | GSOrganization | An organisation in an Australian healthcare context | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:testList |
S | 0..1 | Reference(ValueSet) | Organization Test List Extension URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-testlist-ext |
| type |
0..* | CodeableConcept | Kind of organization 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://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 722171005 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Diagnostic institution | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | GSOrganization | An organisation in an Australian healthcare context Constraints: org-1 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:testList |
S | 0..1 | Reference(ValueSet) | Organization Test List Extension URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-testlist-ext | ||||
| 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 Constraints: au-core-org-01 | ||||
| identifier:hpio |
SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2 | ||||
| identifier:abn |
SC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) Constraints: inv-abn-0 | ||||
| identifier:nataAccreditation |
SC | 0..1 | AUNATAAccreditationNumber | Laboratory or Imaging NATA accreditation number Constraints: au-core-org-01 | ||||
| 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 Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..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 | ||||
| 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 Constraints: au-core-org-01 | ||||
| identifier:localOrganizationIdentifier |
SC | 0..1 | GSOrganizationLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 | ||||
| identifier:localPracticeIdentifier |
SC | 0..1 | GSPracticeLocalIdentifier | Identifies this organization across multiple systems Constraints: au-core-org-01 | ||||
| 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)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://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 722171005 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Diagnostic institution | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| name |
SΣC | 1..1 | string | Practice 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 Constraints: org-3 | ||||
| telecom:phone |
SC | 0..2 | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
| 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 Constraints: org-3 | ||||
| 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 Constraints: org-3 | ||||
| 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 Constraints: org-3 | ||||
| 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 Constraints: org-2 | ||||
| address:physical |
SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) Constraints: org-2 | ||||
| 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 |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: work | ||||
| type |
Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
Σ | 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 etc. Example General: Erewhon | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| partOf |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
| name |
0..1 | HumanName | A name associated with the contact | |||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Organization.identifier:nataAccreditation.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:nataAccreditation.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Organization.type | Base | preferred |
Healthcare Organisation Role Type
|
⏿1.1.0 | tx.hl7.org.au |
| Organization.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:fax.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:website.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address:physical.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact Purpose | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Id | Grade | Path(s) | Description | Expression |
| au-core-org-01 | error | Organization.identifier, Organization.identifier:nataAccreditation, Organization.identifier:acn, Organization.identifier:localOrganizationIdentifier, Organization.identifier:localPracticeIdentifier | A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O |
where(type.coding.code = 'NOI').exists() implies (system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0')
|
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 |
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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-abn-0 | error | Organization.identifier:abn | ABN shall be 11 digits |
value.matches('^([0-9]{11})$')
|
| inv-hpio-0 | error | Organization.identifier:hpio | HPI-O shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpio-1 | error | Organization.identifier:hpio | HPI-O prefix shall be 800362 |
value.startsWith('800362')
|
| inv-hpio-2 | error | Organization.identifier:hpio | HPI-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-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address, Organization.address:physical | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:fax, Organization.telecom:email, Organization.telecom:website | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from GSOrganization
Other representations of profile: CSV, Excel, Schematron