Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-contact-1 | Version: 0.0.1 | |||
| Draft as of 2024-09-12 | Computable Name: ADHAOrganizationContact | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
The purpose of this profile is to provide an organisation with contact information for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Organization that are supported.
An Organization resource is used within the context of a referencing resource.
This profile is designed to set an Organization standard for:
This profile may be referred to by APIs, which will be listed here when available.
None.
This profile is not referenced by another profile in this implementation guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHAOrganizationCore
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization |
0..* | ADHAOrganizationCore | An organisation in an Australian healthcare context | |
  contact |
S | 1..* | BackboneElement | Contact for the organization for a certain purpose |
  purpose |
S | 0..1 | CodeableConcept | The type of contact |
| name |
S | 0..1 | HumanName | A name associated with the contact |
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
 address |
S | 0..1 | Address | Visiting or postal addresses for the contact |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | ADHAOrganizationCore | 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 inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display | ||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
  Slices for identifier |
SOC | 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 |
SOC | 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 |
SOC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
| ||||||
 identifier:paio |
SOC | 0..1 | AUPAIOIdentifier | 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 |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||||
 type |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type  (preferred)
| ||||||
| name |
SOΣC | 1..1 | string | Name used for the organization
| ||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
| ||||||
| address |
SOC | 0..* | Address, 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'
| ||||||
 partOf |
SΣC | 0..1 | Reference(ADHA Core Organization) | The organization of which this organization forms a part | ||||||
| contact |
S | 1..* | BackboneElement | Contact for the organization for a certain purpose | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| purpose |
S | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | ||||||
| name |
S | 0..1 | HumanName | A name associated with the contact | ||||||
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||||
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact | ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Organization.type | preferred | HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | |
| Organization.contact.purpose | extensible | ContactPurposehttp://terminology.hl7.org.au/ValueSet/contact-purpose |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | ADHAOrganizationCore | 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 inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display | ||||||
| id |
Σ | 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 | |||||||
| 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 |
SOC | 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 |
SOC | 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 |
SOC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
| ||||||
| identifier:paio |
SOC | 0..1 | AUPAIOIdentifier | 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 |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||||
| type |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| ||||||
| name |
SOΣC | 1..1 | string | Name used for the organization
| ||||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
| ||||||
| address |
SOC | 0..* | Address, 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'
| ||||||
| partOf |
SΣC | 0..1 | Reference(ADHA Core Organization) | The organization of which this organization forms a part | ||||||
| contact |
S | 1..* | 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 |
S | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | ||||||
| name |
S | 0..1 | HumanName | A name associated with the contact | ||||||
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||||
| address |
S | 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 | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Organization.type | preferred | HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | ||||
| Organization.contact.purpose | extensible | ContactPurposehttp://terminology.hl7.org.au/ValueSet/contact-purpose |
This structure is derived from ADHAOrganizationCore
Differential View
This structure is derived from ADHAOrganizationCore
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization |
0..* | ADHAOrganizationCore | An organisation in an Australian healthcare context | |
| contact |
S | 1..* | BackboneElement | Contact for the organization for a certain purpose |
| purpose |
S | 0..1 | CodeableConcept | The type of contact |
| name |
S | 0..1 | HumanName | A name associated with the contact |
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | ADHAOrganizationCore | 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 inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| Slices for identifier |
SOC | 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 |
SOC | 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 |
SOC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
| ||||||
| identifier:paio |
SOC | 0..1 | AUPAIOIdentifier | 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 |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||||
| type |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| ||||||
| name |
SOΣC | 1..1 | string | Name used for the organization
| ||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
| ||||||
| address |
SOC | 0..* | Address, 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'
| ||||||
| partOf |
SΣC | 0..1 | Reference(ADHA Core Organization) | The organization of which this organization forms a part | ||||||
| contact |
S | 1..* | BackboneElement | Contact for the organization for a certain purpose | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| purpose |
S | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | ||||||
| name |
S | 0..1 | HumanName | A name associated with the contact | ||||||
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||||
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact | ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Organization.type | preferred | HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | |
| Organization.contact.purpose | extensible | ContactPurposehttp://terminology.hl7.org.au/ValueSet/contact-purpose |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | ADHAOrganizationCore | 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 inv-dh-org-01: If present, the organization of which this organization forms a part shall at least have a reference, an identifier or a display | ||||||
| id |
Σ | 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 | |||||||
| 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 |
SOC | 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 |
SOC | 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 |
SOC | 0..* | AUAustralianBusinessNumber | Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
| ||||||
| identifier:paio |
SOC | 0..1 | AUPAIOIdentifier | 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 |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||||
| type |
SOΣ | 0..* | CodeableConcept | Kind of organization Binding: Healthcare Organisation Role Type (preferred)
| ||||||
| name |
SOΣC | 1..1 | string | Name used for the organization
| ||||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
| ||||||
| address |
SOC | 0..* | Address, 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'
| ||||||
| partOf |
SΣC | 0..1 | Reference(ADHA Core Organization) | The organization of which this organization forms a part | ||||||
| contact |
S | 1..* | 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 |
S | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | ||||||
| name |
S | 0..1 | HumanName | A name associated with the contact | ||||||
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||||
| address |
S | 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 | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Organization.type | preferred | HealthcareOrganisationRoleType https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1 | ||||
| Organization.contact.purpose | extensible | ContactPurposehttp://terminology.hl7.org.au/ValueSet/contact-purpose |
This structure is derived from ADHAOrganizationCore
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Organization Contact profile.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-09-12
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
