Provider Connect Australia (PCA)
2.4.3 - active Australia flag

Provider Connect Australia (PCA) - Local Development build (v2.4.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PcaOrganization - Detailed Descriptions

Active as of 2024-03-19

Definitions for the pca-organization resource profile.

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

0. Organization
Invariantsinv-pca-1: Organization shall not have both ABN and HPI-O identifiers (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not())
inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization (extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/'))
inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization (partOf.reference.exists() implies partOf.reference.startsWith('Organization/'))
inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist (type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not())
inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist ((type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()))
inv-pca-6: If type is 'HIO', no ABN identifier shall exist (type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not())
inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO' (type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1)
inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO' ((type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()))
2. Organization.id
Must Supporttrue
4. Organization.meta
Must Supporttrue
6. Organization.meta.versionId
Must Supporttrue
8. Organization.meta.lastUpdated
Must Supporttrue
10. Organization.extension:pca-active-in-system-of-record
Slice Namepca-active-in-system-of-record
ShortWhether this organization's record is active in a system of record (ABR, HI Service)
Control0..1
TypeExtension(PCA Active In System Of Record) (Complex Extension)
Must Supporttrue
12. Organization.extension:pca-part-of-legal-entity
Slice Namepca-part-of-legal-entity
Control0..1
TypeExtension(PCA Part Of Legal Entity) (Extension Type: Reference(PCA Organization))
Must Supporttrue
14. Organization.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
SlicingThis element introduces a set of slices on Organization.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 16. Organization.identifier:hpio
    Slice Namehpio
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier(AU HPI-O)
    Must Supporttrue
    18. Organization.identifier:abn
    Slice Nameabn
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier(AU Australian Business Number)
    Must Supporttrue
    20. Organization.identifier:pca-oi
    Slice Namepca-oi
    ShortPCA Organization Identifier (PCA-OI) issued by the PCA service
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier(PCA Organization Identifier (PCA-OI))
    Must Supporttrue
    22. Organization.active
    Control1..?
    Must Supporttrue
    24. Organization.type
    Control1..?
    BindingThe codes SHALL be taken from PCA Organization Type
    (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type)
    Must Supporttrue
    26. Organization.name
    Control1..?
    Must Supporttrue
    28. Organization.alias
    Must Supporttrue
    30. Organization.telecom
    Must Supporttrue
    32. Organization.address
    Definition

    An address for the organization.

    ShortAn address for the organization
    TypeAddress(Australian Address)
    Must Supporttrue
    Invariantsinv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier (extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2)
    inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier (extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2)
    inv-pca-11: address shall contain a maximum of 3 line elements (line.count() < 4)
    34. Organization.partOf
    TypeReference(PCA Organization)
    Must Supporttrue

    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)
    inv-pca-1: Organization shall not have both ABN and HPI-O identifiers (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not())
    inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization (extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/'))
    inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization (partOf.reference.exists() implies partOf.reference.startsWith('Organization/'))
    inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist (type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not())
    inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist ((type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()))
    inv-pca-6: If type is 'HIO', no ABN identifier shall exist (type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not())
    inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO' (type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1)
    inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO' ((type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()))
    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
    Typeidstring
    Is Modifierfalse
    Must Supporttrue
    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
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. Organization.meta.versionId
    Definition

    The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

    ShortVersion specific identifier
    Comments

    The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

    Control0..1
    Typeid
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Organization.meta.lastUpdated
    Definition

    When the resource last changed - e.g. when the version changed.

    ShortWhen the resource version last changed
    Comments

    This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

    Control0..1
    Typeinstant
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. 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()))
    12. Organization.extension:pca-active-in-system-of-record
    Slice Namepca-active-in-system-of-record
    Definition

    Whether the organization or practitioner record is active in a system of record from which an identifier element was obtained.

    ShortWhether this organization's record is active in a system of record (ABR, HI Service)
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(PCA Active In System Of Record) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    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())
    14. Organization.extension:pca-part-of-legal-entity
    Slice Namepca-part-of-legal-entity
    Definition

    The legal entity of which this organisation is part.

    ShortThe legal entity of which this organisation is part
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(PCA Part Of Legal Entity) (Extension Type: Reference(PCA Organization))
    Is Modifierfalse
    Must Supporttrue
    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())
    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 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, 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
    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()))
    SlicingThis element introduces a set of slices on Organization.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ 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.


      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
      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).


      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..1*
      This element is affected by the following invariants: ele-1, org-1
      TypeIdentifier(AU Australian Business Number)
      Is Modifierfalse
      Must Supporttrue
      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.identifier:pca-oi
      Slice Namepca-oi
      Definition

      The PCA Organization Identifier (PCA-OI) issued by the PCA service to each PCA Organization.


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

      ShortPCA Organization Identifier (PCA-OI) issued by the PCA serviceIdentifies 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(PCA Organization Identifier (PCA-OI))
      Is Modifierfalse
      Must Supporttrue
      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()))
      26. 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.

      Control10..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
      Must Supporttrue
      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()))
      28. 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.

      Control10..*
      BindingThe codes SHALL be taken from For example codes, see PCA Organization Typehttp://hl7.org/fhir/ValueSet/organization-type
      (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      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()))
      30. 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
      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()))
      32. 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
      Must Supporttrue
      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()))
      34. 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
      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())
      36. Organization.address
      Definition

      An address for the organization.

      ShortAn address for the organization
      Comments

      Note: 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(Australian Address)
      Is Modifierfalse
      Must Supporttrue
      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()))
      inv-add-0: The address shall at least have text or a line (text.exists() or line.exists())
      inv-add-1: If asserting no fixed address, the type shall be 'physical' (extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical')
      inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' (extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS'))
      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
      inv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier (extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2)
      inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier (extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2)
      inv-pca-11: address shall contain a maximum of 3 line elements (line.count() < 4)
      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
      38. Organization.partOf
      Definition

      The organization of which this organization forms a part.

      ShortThe organization of which this organization forms a part
      Control0..1
      TypeReference(PCA Organization, Organization)
      Is Modifierfalse
      Must Supporttrue
      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()))

      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)
      inv-pca-1: Organization shall not have both ABN and HPI-O identifiers (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies identifier.exists(system = 'http://hl7.org.au/id/abn').not())
      inv-pca-2: If present, pca-part-of-legal-entity.reference shall be a relative reference to an Organization (extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.exists() implies extension('http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-part-of-legal-entity').value.reference.startsWith('Organization/'))
      inv-pca-3: If present, partOf.reference shall be a relative reference to an Organization (partOf.reference.exists() implies partOf.reference.startsWith('Organization/'))
      inv-pca-4: If type is 'LEO', no HPI-O identifier shall exist (type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0').not())
      inv-pca-5: If and only if type is 'HIO', HPI-O identifier shall exist ((type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0')) and (identifier.exists(system = 'http://ns.electronichealth.net.au/id/hi/hpio/1.0') implies type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()))
      inv-pca-6: If type is 'HIO', no ABN identifier shall exist (type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies identifier.exists(system = 'http://hl7.org.au/id/abn').not())
      inv-pca-7: The types shall include one and only one of 'LEO' and 'HIO' (type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() + type.coding.where(code = 'HIO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').count() = 1)
      inv-pca-8: If one type is 'PPO' or 'PSO' another type shall be 'LEO' ((type.coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists() implies type.coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type').exists()) and (type.where(coding.where(code = 'PSO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()) and (type.where(coding.where(code = 'PPO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type') and coding.where(code = 'LEO' and system = 'http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-organization-type')).exists().not()))
      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
      Must Supporttrue
      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
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Organization.meta.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
      8. Organization.meta.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())
      SlicingThis element introduces a set of slices on Organization.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. Organization.meta.versionId
        Definition

        The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

        ShortVersion specific identifier
        Comments

        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

        Control0..1
        Typeid
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. Organization.meta.lastUpdated
        Definition

        When the resource last changed - e.g. when the version changed.

        ShortWhen the resource version last changed
        Comments

        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

        Control0..1
        Typeinstant
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. Organization.meta.source
        Definition

        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

        ShortIdentifies where the resource comes from
        Comments

        In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

        Control0..1
        Typeuri
        Is Modifierfalse
        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()))
        16. Organization.meta.profile
        Definition

        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

        ShortProfiles this resource claims to conform to
        Comments

        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

        Control0..*
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        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()))
        18. Organization.meta.security
        Definition

        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

        ShortSecurity Labels applied to this resource
        Comments

        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
        (extensible to http://hl7.org/fhir/ValueSet/security-labels)

        Security Labels from the Healthcare Privacy and Security Classification System.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Organization.meta.tag
        Definition

        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

        ShortTags applied to this resource
        Comments

        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingFor example codes, see CommonTags
        (example to http://hl7.org/fhir/ValueSet/common-tags)

        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. 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()))
        24. 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()))
        26. 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()))
        28. 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
        30. Organization.extension
        Definition

        An Extension

        ShortExtension
        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        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())
        SlicingThis element introduces a set of slices on Organization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 32. Organization.extension:pca-active-in-system-of-record
          Slice Namepca-active-in-system-of-record
          Definition

          Whether the organization or practitioner record is active in a system of record from which an identifier element was obtained.

          ShortWhether this organization's record is active in a system of record (ABR, HI Service)
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(PCA Active In System Of Record) (Complex Extension)
          Is Modifierfalse
          Must Supporttrue
          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())
          34. Organization.extension:pca-part-of-legal-entity
          Slice Namepca-part-of-legal-entity
          Definition

          The legal entity of which this organisation is part.

          ShortThe legal entity of which this organisation is part
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(PCA Part Of Legal Entity) (Extension Type: Reference(PCA Organization))
          Is Modifierfalse
          Must Supporttrue
          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())
          36. 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())
          38. 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
          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
          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()))
          SlicingThis element introduces a set of slices on Organization.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 40. 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
            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))
            42. 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..1
            This element is affected by the following invariants: ele-1
            TypeIdentifier(AU Australian Business Number)
            Is Modifierfalse
            Must Supporttrue
            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})$'))
            44. Organization.identifier:pca-oi
            Slice Namepca-oi
            Definition

            The PCA Organization Identifier (PCA-OI) issued by the PCA service to each PCA Organization.

            ShortPCA Organization Identifier (PCA-OI) issued by the PCA service
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeIdentifier(PCA Organization Identifier (PCA-OI))
            Is Modifierfalse
            Must Supporttrue
            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()))
            46. 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.

            Control1..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
            Must Supporttrue
            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()))
            48. 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.

            Control1..*
            BindingThe codes SHALL be taken from PCA Organization Type
            (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-organization-type)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            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()))
            50. 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
            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()))
            52. 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
            Must Supporttrue
            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()))
            54. 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
            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())
            56. Organization.address
            Definition

            An address for the organization.

            ShortAn address for the organization
            Comments

            Note: 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(Australian Address)
            Is Modifierfalse
            Must Supporttrue
            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()))
            inv-add-0: The address shall at least have text or a line (text.exists() or line.exists())
            inv-add-1: If asserting no fixed address, the type shall be 'physical' (extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical')
            inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' (extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS'))
            org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
            inv-pca-9: If present, at most one instance of the address element shall contain a DPID address identifier (extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2)
            inv-pca-10: If present, at most one instance of the address element shall contain a G-NAF address identifier (extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2)
            inv-pca-11: address shall contain a maximum of 3 line elements (line.count() < 4)
            58. Organization.partOf
            Definition

            The organization of which this organization forms a part.

            ShortThe organization of which this organization forms a part
            Control0..1
            TypeReference(PCA Organization)
            Is Modifierfalse
            Must Supporttrue
            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()))
            60. 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()))
            62. 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
            64. 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())
            66. 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())
            68. 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()))
            70. 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()))
            72. 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()))
            74. 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()))
            76. 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()))