AU Core Implementation Guide
1.0.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions

Resource Profile: AUCoreOrganization - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the au-core-organization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Organization
2. Organization.identifier
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
Obligations
    ObligationsActor
    SHALL:populate-if-knownAU Core Responder
    SHALL:no-errorAU Core Requester
    Invariantsau-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O (type.coding.where(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')))
    SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ system
    • 4. Organization.identifier:hpio
      Slice Namehpio
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      TypeIdentifier(AU HPI-O)
      Must Supporttrue
      Obligations
        ObligationsActor
        SHALL:populate-if-knownAU Core Responder
        SHALL:no-errorAU Core Requester
        6. Organization.identifier:abn
        Slice Nameabn
        NoteThis is a business identifier, not a resource identifier (see discussion)
        TypeIdentifier(AU Australian Business Number)
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:populate-if-knownAU Core Responder
          SHALL:no-errorAU Core Requester
          8. Organization.type
          Must Supporttrue
          Obligations
            ObligationsActor
            SHALL:populate-if-knownAU Core Responder
            SHALL:no-errorAU Core Requester
            10. Organization.name
            Control1..?
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:populate-if-knownAU Core Responder
              SHALL:no-errorAU Core Requester
              12. Organization.telecom
              Must Supporttrue
              Obligations
                ObligationsActor
                SHALL:populate-if-knownAU Core Responder
                SHALL:no-errorAU Core Requester
                14. Organization.address
                Definition

                An address for the organization.

                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHALL:populate-if-knownAU Core Responder
                  SHALL:no-errorAU Core Requester

                  Guidance on how to interpret the contents of this table can be found here

                  0. Organization
                  Definition

                  A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                  ShortAn organisation in an Australian healthcare contextA grouping of people or organizations with a common purpose
                  Control0..*
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                  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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                  dom-6: A resource should have narrative for robust management (text.`div`.exists())
                  org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
                  org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
                  2. Organization.implicitRules
                  Definition

                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                  ShortA set of rules under which this content was created
                  Comments

                  Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                  Control0..1
                  Typeuri
                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  4. Organization.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Summaryfalse
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  6. Organization.identifier
                  Definition

                  Identifier for the organization that is used to identify the organization across multiple disparate systems.

                  ShortIdentifies this organization across multiple systemsIdentifies this organization across multiple systems
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  This element is affected by the following invariants: ele-1, au-core-org-01, org-1
                  TypeIdentifier(Identifier, AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number, AU Pharmacy Approval Number)
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Obligations
                    ObligationsActor
                    SHALL:populate-if-knownAU Core Responder
                    SHALL:no-errorAU Core Requester
                    Requirements

                    Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O (type.coding.where(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')))
                    SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • pattern @ system
                    • 8. Organization.identifier:hpio
                      Slice Namehpio
                      Definition

                      Healthcare Provider Identifier – Organisation (HPI-O) assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.


                      Identifier for the organization that is used to identify the organization across multiple disparate systems.

                      ShortHealthcare Provider Identifier – Organisation (HPI-O)Identifies this organization across multiple systems
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1*
                      This element is affected by the following invariants: ele-1, org-1
                      TypeIdentifier(AU HPI-O)
                      Is Modifierfalse
                      Must Supporttrue
                      Obligations
                        ObligationsActor
                        SHALL:populate-if-knownAU Core Responder
                        SHALL:no-errorAU Core Requester
                        Requirements

                        Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        inv-hpio-0: HPI-O shall be 16 digits (value.matches('^([0-9]{16})$'))
                        inv-hpio-1: HPI-O prefix shall be 800362 (value.startsWith('800362'))
                        inv-hpio-2: 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))
                        10. Organization.identifier:abn
                        Slice Nameabn
                        Definition

                        Australian Business Number (ABN) assigned by the Australian Securities and Investment Commission (ASIC) to an entity registered in the Australian Business Register (ABR).


                        Identifier for the organization that is used to identify the organization across multiple disparate systems.

                        ShortAustralian Business Number (ABN)Identifies this organization across multiple systems
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..*
                        This element is affected by the following invariants: ele-1, org-1
                        TypeIdentifier(AU Australian Business Number)
                        Is Modifierfalse
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:populate-if-knownAU Core Responder
                          SHALL:no-errorAU Core Requester
                          Requirements

                          Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          inv-abn-0: ABN shall be 11 digits (value.matches('^([0-9]{11})$'))
                          12. Organization.active
                          Definition

                          Whether the organization's record is still in active use.

                          ShortWhether the organization's record is still in active use
                          Comments

                          This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

                          This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                          Control0..1
                          Typeboolean
                          Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

                          Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          14. Organization.type
                          Definition

                          The kind(s) of organization that this is.

                          ShortKind of organization
                          Comments

                          When selecting a code for Organization type, if a system is unable to provide a code from the preferred value set Healthcare Organisation Role Type because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select from the wider set available in SNOMED CT. If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used.


                          Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

                          When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

                          We expect that some jurisdictions will profile this optionality to be a single cardinality.

                          Control0..*
                          BindingThe codes SHOULD be taken from For example codes, see Healthcare Organisation Role Type .http://hl7.org/fhir/ValueSet/organization-type
                          (preferred to https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:populate-if-knownAU Core Responder
                            SHALL:no-errorAU Core Requester
                            Summarytrue
                            Requirements

                            Need to be able to track the kind of organization that this is - different organization types have different uses.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            16. Organization.name
                            Definition

                            A name associated with the organization.

                            ShortName used for the organization
                            Comments

                            If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

                            Control10..1
                            This element is affected by the following invariants: org-1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:populate-if-knownAU Core Responder
                              SHALL:no-errorAU Core Requester
                              Summarytrue
                              Requirements

                              Need to use the name as the label of the organization.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              18. Organization.telecom
                              Definition

                              A contact detail for the organization.

                              ShortA contact detail for the organization
                              Comments

                              The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                              Control0..*
                              This element is affected by the following invariants: org-3
                              TypeContactPoint
                              Is Modifierfalse
                              Must Supporttrue
                              Obligations
                                ObligationsActor
                                SHALL:populate-if-knownAU Core Responder
                                SHALL:no-errorAU Core Requester
                                Summaryfalse
                                Requirements

                                Human contact for the organization.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                                org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                                20. Organization.address
                                Definition

                                An address for the organization.

                                ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the organization
                                Comments

                                The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


                                Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

                                Control0..*
                                This element is affected by the following invariants: ele-1, org-2
                                TypeAddress(Address, Australian Address)
                                Is Modifierfalse
                                Must Supporttrue
                                Must Support TypesNo must-support rules about the choice of types/profiles
                                Obligations
                                  ObligationsActor
                                  SHALL:populate-if-knownAU Core Responder
                                  SHALL:no-errorAU Core Requester
                                  Requirements

                                  May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                                  org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())

                                  Guidance on how to interpret the contents of this table can be found here

                                  0. Organization
                                  Definition

                                  A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                                  ShortAn organisation in an Australian healthcare context
                                  Control0..*
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                  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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                  dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                  org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
                                  2. Organization.id
                                  Definition

                                  The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                  ShortLogical id of this artifact
                                  Comments

                                  The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                  Control0..1
                                  Typeid
                                  Is Modifierfalse
                                  Summarytrue
                                  4. Organization.meta
                                  Definition

                                  The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                  ShortMetadata about the resource
                                  Control0..1
                                  TypeMeta
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  6. Organization.implicitRules
                                  Definition

                                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                  ShortA set of rules under which this content was created
                                  Comments

                                  Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                  Control0..1
                                  Typeuri
                                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  8. Organization.language
                                  Definition

                                  The base language in which the resource is written.

                                  ShortLanguage of the resource content
                                  Comments

                                  Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                                  Control0..1
                                  BindingThe codes SHOULD be taken from CommonLanguages
                                  (preferred to http://hl7.org/fhir/ValueSet/languages)

                                  A human language.

                                  Additional BindingsPurpose
                                  AllLanguagesMax Binding
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  10. Organization.text
                                  Definition

                                  A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                  ShortText summary of the resource, for human interpretation
                                  Comments

                                  Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                  Control0..1
                                  TypeNarrative
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesnarrative, html, xhtml, display
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  12. Organization.contained
                                  Definition

                                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                  ShortContained, inline Resources
                                  Comments

                                  This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                  Control0..*
                                  TypeResource
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesinline resources, anonymous resources, contained resources
                                  14. Organization.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  16. Organization.modifierExtension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                  ShortExtensions that cannot be ignored
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                  Summaryfalse
                                  Requirements

                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  18. Organization.identifier
                                  Definition

                                  Identifier for the organization that is used to identify the organization across multiple disparate systems.

                                  ShortIdentifies this organization across multiple systems
                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..*
                                  This element is affected by the following invariants: ele-1, au-core-org-01
                                  TypeIdentifier(Identifier, AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number, AU Pharmacy Approval Number)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                  Obligations
                                    ObligationsActor
                                    SHALL:populate-if-knownAU Core Responder
                                    SHALL:no-errorAU Core Requester
                                    Requirements

                                    Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O (type.coding.where(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')))
                                    SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • pattern @ system
                                    • 20. Organization.identifier:hpio
                                      Slice Namehpio
                                      Definition

                                      Healthcare Provider Identifier – Organisation (HPI-O) assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.

                                      ShortHealthcare Provider Identifier – Organisation (HPI-O)
                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      This element is affected by the following invariants: ele-1
                                      TypeIdentifier(AU HPI-O)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHALL:populate-if-knownAU Core Responder
                                        SHALL:no-errorAU Core Requester
                                        Requirements

                                        Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        inv-hpio-0: HPI-O shall be 16 digits (value.matches('^([0-9]{16})$'))
                                        inv-hpio-1: HPI-O prefix shall be 800362 (value.startsWith('800362'))
                                        inv-hpio-2: 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))
                                        22. Organization.identifier:abn
                                        Slice Nameabn
                                        Definition

                                        Australian Business Number (ABN) assigned by the Australian Securities and Investment Commission (ASIC) to an entity registered in the Australian Business Register (ABR).

                                        ShortAustralian Business Number (ABN)
                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeIdentifier(AU Australian Business Number)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Obligations
                                          ObligationsActor
                                          SHALL:populate-if-knownAU Core Responder
                                          SHALL:no-errorAU Core Requester
                                          Requirements

                                          Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          inv-abn-0: ABN shall be 11 digits (value.matches('^([0-9]{11})$'))
                                          24. Organization.active
                                          Definition

                                          Whether the organization's record is still in active use.

                                          ShortWhether the organization's record is still in active use
                                          Comments

                                          This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

                                          This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                                          Control0..1
                                          Typeboolean
                                          Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

                                          Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          26. Organization.type
                                          Definition

                                          The kind(s) of organization that this is.

                                          ShortKind of organization
                                          Comments

                                          When selecting a code for Organization type, if a system is unable to provide a code from the preferred value set Healthcare Organisation Role Type because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select from the wider set available in SNOMED CT. If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used.

                                          Control0..*
                                          BindingThe codes SHOULD be taken from Healthcare Organisation Role Type .
                                          (preferred to https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1)
                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Obligations
                                            ObligationsActor
                                            SHALL:populate-if-knownAU Core Responder
                                            SHALL:no-errorAU Core Requester
                                            Summarytrue
                                            Requirements

                                            Need to be able to track the kind of organization that this is - different organization types have different uses.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            28. Organization.name
                                            Definition

                                            A name associated with the organization.

                                            ShortName used for the organization
                                            Comments

                                            If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

                                            Control1..1
                                            This element is affected by the following invariants: org-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActor
                                              SHALL:populate-if-knownAU Core Responder
                                              SHALL:no-errorAU Core Requester
                                              Summarytrue
                                              Requirements

                                              Need to use the name as the label of the organization.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              30. Organization.alias
                                              Definition

                                              A list of alternate names that the organization is known as, or was known as in the past.

                                              ShortA list of alternate names that the organization is known as, or was known as in the past
                                              Comments

                                              There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

                                              Control0..*
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summaryfalse
                                              Requirements

                                              Over time locations and organizations go through many changes and can be known by different names.

                                              For searching knowing previous names that the organization was known by can be very useful.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              32. Organization.telecom
                                              Definition

                                              A contact detail for the organization.

                                              ShortA contact detail for the organization
                                              Comments

                                              The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                                              Control0..*
                                              This element is affected by the following invariants: org-3
                                              TypeContactPoint
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActor
                                                SHALL:populate-if-knownAU Core Responder
                                                SHALL:no-errorAU Core Requester
                                                Summaryfalse
                                                Requirements

                                                Human contact for the organization.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                                                34. Organization.address
                                                Definition

                                                An address for the organization.

                                                ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                                                Comments

                                                The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                Control0..*
                                                This element is affected by the following invariants: ele-1
                                                TypeAddress(Address, Australian Address)
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Must Support TypesNo must-support rules about the choice of types/profiles
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:populate-if-knownAU Core Responder
                                                  SHALL:no-errorAU Core Requester
                                                  Requirements

                                                  May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                                                  36. Organization.partOf
                                                  Definition

                                                  The organization of which this organization forms a part.

                                                  ShortThe organization of which this organization forms a part
                                                  Control0..1
                                                  TypeReference(Organization)
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  Need to be able to track the hierarchy of organizations within an organization.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  38. Organization.contact
                                                  Definition

                                                  Contact for the organization for a certain purpose.

                                                  ShortContact for the organization for a certain purpose
                                                  Comments

                                                  Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  Need to keep track of assigned contact points within bigger organization.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  40. Organization.contact.id
                                                  Definition

                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  42. Organization.contact.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  44. Organization.contact.modifierExtension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  46. Organization.contact.purpose
                                                  Definition

                                                  Indicates a purpose for which the contact can be reached.

                                                  ShortThe type of contact
                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from Contact Purpose
                                                  (extensible to http://terminology.hl7.org.au/ValueSet/contact-purpose)
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  Need to distinguish between multiple contact persons.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  48. Organization.contact.name
                                                  Definition

                                                  A name associated with the contact.

                                                  ShortA name associated with the contact
                                                  Control0..1
                                                  TypeHumanName
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  Need to be able to track the person by name.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  50. Organization.contact.telecom
                                                  Definition

                                                  A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

                                                  ShortContact details (telephone, email, etc.) for a contact
                                                  Control0..*
                                                  TypeContactPoint
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  People have (primary) ways to contact them in some way such as phone, email.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  52. Organization.contact.address
                                                  Definition

                                                  Visiting or postal addresses for the contact.

                                                  ShortVisiting or postal addresses for the contact
                                                  Control0..1
                                                  TypeAddress
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  May need to keep track of a contact party's address for contacting, billing or reporting requirements.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  54. Organization.endpoint
                                                  Definition

                                                  Technical endpoints providing access to services operated for the organization.

                                                  ShortTechnical endpoints providing access to services operated for the organization
                                                  Control0..*
                                                  TypeReference(Endpoint)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))