NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHSDOrganisation - Detailed Descriptions

Draft as of 2023-09-14

Definitions for the nhsd-organisation resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Organization
Definition | Directory entry Australian realm Organisation profile often healthcare or related service provision. 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.
Short | An organisation in an Australian healthcare contextA grouping of people or organizations with a common purpose
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (`text.div.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one (`(identifier.count() + name.count()) > 0`) 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-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.
Short | Logical FHIR id for unique identification of the organisation resource within the FHIR bundleLogical 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.
Control | 10..1
Type | id string
Is Modifier | false
Summary | true
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.
Short | Metadata about Organisation resourceMetadata about the resource
Control | 10..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Unique id for inter-element referencing
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. Organization.meta.extension
Definition | An Extension 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.
Short | ExtensionAdditional 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.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This element introduces a set of slices on `Organization.meta.extension`. The slices areUnordered 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.
Short | Version 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.
Control | 0..01
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | The time when the resource was last updatedWhen 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. 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.
Control | 10..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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. 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.
Short | Identifies 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.
Control | 0..01
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-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. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles 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.
Control | 0..0*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Security 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.
Control | 0..0*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels http://hl7.org/fhir/ValueSet/security-labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | Tags 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.
Control | 0..0*
Binding | For example codes, see CommonTags http://hl7.org/fhir/ValueSet/common-tags (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".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | A 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.
Control | 0..01
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Language 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).
Control | 0..01
Binding | The codes SHOULD be taken from CommonLanguages http://hl7.org/fhir/ValueSet/languages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-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.
Short | Text 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.
Control | 0..01
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-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.
Short | Contained, 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.
Control | 0..0*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
30. Organization.extension
Definition | An Extension 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.
Short | ExtensionAdditional 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.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
32. Organization.modifierExtension
Definition | An Extension 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).
Short | ExtensionExtensions 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.
Control | 0..0*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-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.identifier
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | NHSD entry Organization identifiersIdentifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Organization.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
36. Organization.identifier:hpio
Slice Name | hpio
Definition | National identifier Health Provider Identifier for Organisations (HPI-O). Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | HPI-O for Directory Entry OrganisationIdentifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0* This element is affected by the following invariants: org-1
Type | Identifier(AU HPI-O)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-hpio-0: HPI-O shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-hpio-1: HPI-O prefix is 800362 (`value.startsWith('800362')`) inv-hpio-2: The identifier 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)`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
43. Organization.identifier:abn
Slice Name | abn
Definition | Australian Securities and Investment Commission (ASIC) assigned identifier for business/entity. ABN (Australian Business Number). Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Australian Business Number (ABN)Identifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: org-1
Type | Identifier(AU Australian Business Number)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-abn-0: ABN shall be exactly 11 digits (`value.length()=11`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
45. Organization.identifier:abn.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
47. Organization.identifier:abn.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for ABNThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://hl7.org.au/id/abn`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
49. Organization.identifier:abn.value
Definition | Australian Business Number (ABN) identifier . The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | ABNThe value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
51. Organization.identifier:acn
Slice Name | acn
Definition | Australian Securities and Investment Commission (ASIC) assigned identifier for business/entity. ACN (Australian Company Number). Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Australian Company Number (ACN)Identifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: org-1
Type | Identifier(AU Australian Company Number)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-acn-0: ACN shall be exactly 9 digits (`value.length()=9`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
53. Organization.identifier:acn.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
55. Organization.identifier:acn.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for ACNThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://hl7.org.au/id/acn`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
57. Organization.identifier:acn.value
Definition | Australian Company Number (ACN) identifier The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | ACNThe value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
59. Organization.identifier:arbn
Slice Name | arbn
Definition | Australian Securities and Investment Commission (ASIC) assigned identifier for business/entity. ARBN (Australian Registered Body Number). Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Australian Registered Body Number (ARBN)Identifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: org-1
Type | Identifier(AUAustralianRegisteredBodyNumber)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-arbn-0: ARBN shall be exactly 9 digits (`value.length()=9`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
61. Organization.identifier:arbn.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
63. Organization.identifier:arbn.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for ARBNThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://hl7.org.au/id/arbn`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
65. Organization.identifier:arbn.value
Definition | Australian Registered Body Number (ARBN) identifier. The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | ARBNThe value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
67. Organization.identifier:paio
Slice Name | paio
Definition | My Health Record Assigned Identity for Organisations (PAI-O). Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | My Health Record Assigned Identity for Organisations (PAI-O)Identifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0* This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Invariants | inv-paio-0: PAI-O shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-paio-1: PAI-O prefix is 800364 (`value.startsWith('800364')`) inv-paio-2: The identifier 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)`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Organization.identifier:csp
Slice Name | csp
Definition | Contracted Service Provider (CSP) number identifier for organisations Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Contracted Service Provider (CSP) NumberIdentifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0* This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Invariants | inv-csp-0: CSP number is exactly 16 characters (`value.length() = 16`) inv-csp-1: CSP number prefix is 800363 (`value.startsWith('800363')`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
77. Organization.identifier:nataAccreditation
Slice Name | nataAccreditation
Definition | Identifier of an organization accredited by the National Association of Testing Authorities (NATA) Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | National Association of Testing Authorities (NATA) Accreditation NumberIdentifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0* This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Organization.identifier:rid
Slice Name | rid
Definition | NHSD Organization Resource Identifier Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Organisation Directory Entry IdentifiersIdentifies this organization across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: org-1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Organization.active
Definition | Whether the organization's record is still in active use.
Short | Reflects the current status of the organization resourceWhether 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.
Control | 10..1
Type | boolean
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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 Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Organization.type
Definition | The kind(s) of organization that this is.
Short | Kind of organization
Comments | 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.
Control | 0..0*
Binding | For example codes, see OrganizationType http://hl7.org/fhir/ValueSet/organization-type (example to `http://hl7.org/fhir/ValueSet/organization-type` ) Used to categorize the organization.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Organization.name
Definition | A name associated with the organization.
Short | Name of the organizationName 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.
Control | 10..1 This element is affected by the following invariants: org-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to use the name as the label of the organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Organization.alias
Definition | A list of alternate names that the organization is known as, or was known as in the past.
Short | A list of alternate names that the organization is known asA 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.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Organization.telecom
Definition | A contact detail for the organization.
Short | Contact Details of Directroy Entry OrganisationA 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.
Control | 0..0* This element is affected by the following invariants: org-3
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Requirements | Human contact for the organization.
Invariants | org-3: The telecom of an organization can never be of use 'home' (`where(use = 'home').empty()`) ele-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())
94. Organization.address
Definition | An address for the organization.
Short | Addresses of Directroy Entry OrganisationAn address for the organization
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
Control | 0..0* This element is affected by the following invariants: org-2
Type | Address
Is Modifier | false
Must Support | true
Summary | false
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
Invariants | org-2: An address of an organization can never be of use 'home' (`where(use = 'home').empty()`) ele-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())
97. Organization.partOf
Definition | This is a reference to the parent organization. The organization of which this organization forms a part.
Short | This is a reference to the parent organizationThe organization of which this organization forms a part
Control | 0..1
Type | Reference(NHSD Organisation, Organization)
Is Modifier | false
Summary | true
Requirements | Need to be able to track the hierarchy of organizations within an organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
99. Organization.contact
Definition | Contact for the organization for a certain purpose.
Short | Contact 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.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Need to keep track of assigned contact points within bigger organization.
Label | Organisation Contacts
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
101. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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())
103. Organization.contact.purpose
Definition | Indicates a purpose for which the contact can be reached.
Short | The type of contact
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type (extensible to `http://hl7.org/fhir/ValueSet/contactentity-type` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Need to distinguish between multiple contact persons.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
105. Organization.contact.telecom
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Short | Contact details (telephone, email, etc.) for a contact
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | false
Requirements | People have (primary) ways to contact them in some way such as phone, email.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
107. Organization.endpoint
Definition | Technical endpoints providing access to services operated for the organization.
Short | Technical endpoints providing access to services operated for the organization
Control | 0..0*
Type | Reference(Endpoint)
Is Modifier | false
Summary | false
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.
Invariants | ele-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 foundhere

0. Organization
Short | An organisation in an Australian healthcare context
2. Organization.id
Short | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
Control | 1..?
4. Organization.meta
Short | Metadata about Organisation resource
Control | 1..?
6. Organization.meta.id
Control | 0..0
8. Organization.meta.extension
Control | 0..0
10. Organization.meta.versionId
Control | 0..0
12. Organization.meta.lastUpdated
Short | The time when the resource was last updated
Control | 1..?
14. Organization.meta.source
Control | 0..0
16. Organization.meta.profile
Control | 0..0
18. Organization.meta.security
Control | 0..0
20. Organization.meta.tag
Control | 0..0
22. Organization.implicitRules
Control | 0..0
24. Organization.language
Control | 0..0
26. Organization.text
Control | 0..0
28. Organization.contained
Control | 0..0
30. Organization.extension
Control | 0..0
32. Organization.modifierExtension
Control | 0..0
34. Organization.identifier
Short | NHSD entry Organization identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Slicing | This element introduces a set of slices on `Organization.identifier`. The slices areUnordered and Open, and defines no disciminators to differentiate the slices
36. Organization.identifier:hpio
Slice Name | hpio
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
Type | Identifier(AU HPI-O)
38. Organization.identifier:abn
Slice Name | abn
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(AU Australian Business Number)
Is Modifier | false
Must Support | true
40. Organization.identifier:acn
Slice Name | acn
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(AU Australian Company Number)
Is Modifier | false
Must Support | true
42. Organization.identifier:arbn
Slice Name | arbn
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier(AUAustralianRegisteredBodyNumber)
Is Modifier | false
Must Support | true
44. Organization.identifier:paio
Slice Name | paio
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
46. Organization.identifier:csp
Slice Name | csp
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
48. Organization.identifier:nataAccreditation
Slice Name | nataAccreditation
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
50. Organization.identifier:rid
Slice Name | rid
Definition | NHSD Organization Resource Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
52. Organization.active
Short | Reflects the current status of the organization resource
Control | 1..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
54. Organization.type
Control | 0..0
56. Organization.name
Short | Name of the organization
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
58. Organization.alias
Short | A list of alternate names that the organization is known as
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
60. Organization.telecom
Control | 0..0
62. Organization.address
Control | 0..0
64. Organization.partOf
Definition | This is a reference to the parent organization.
Short | This is a reference to the parent organization
Type | Reference(NHSD Organisation)
66. Organization.contact
Label | Organisation Contacts
68. Organization.contact.purpose
70. Organization.contact.telecom
Type | ContactPoint
72. Organization.endpoint
Control | 0..0

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

0. Organization
Definition | Directory entry Australian realm Organisation profile often healthcare or related service provision.
Short | An organisation in an Australian healthcare context
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.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-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-6: A resource should have narrative for robust management (`text.div.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) 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.
Short | Logical FHIR id for unique identification of the organisation resource within the FHIR bundle
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.
Control | 1..1
Type | id
Is Modifier | false
Summary | true
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.
Short | Metadata about Organisation resource
Control | 1..1
Type | Meta
Is Modifier | false
Summary | true
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.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. Organization.meta.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `Organization.meta.extension`. The slices areUnordered 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.
Short | Version 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.
Control | 0..0
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
12. Organization.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | The time when the resource was last updated
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.
Control | 1..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Short | Identifies 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.
Control | 0..0
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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.
Short | Profiles 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.
Control | 0..0
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
18. Organization.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security 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.
Control | 0..0
Binding | Unless 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.
Type | Coding
Is Modifier | false
Summary | true
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.
Short | Tags 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.
Control | 0..0
Binding | For 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".
Type | Coding
Is Modifier | false
Summary | true
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.
Short | A 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.
Control | 0..0
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
24. Organization.language
Definition | The base language in which the resource is written.
Short | Language 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).
Control | 0..0
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
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.
Short | Text 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.
Control | 0..0
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
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.
Short | Contained, 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.
Control | 0..0
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
30. Organization.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
32. Organization.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
34. Organization.identifier
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | NHSD entry Organization identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Slicing | This element introduces a set of slices on `Organization.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
36. Organization.identifier:hpio
Slice Name | hpio
Definition | National identifier Health Provider Identifier for Organisations (HPI-O).
Short | HPI-O for Directory Entry Organisation
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0 This element is affected by the following invariants: org-1
Type | Identifier(AU HPI-O)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-hpio-0: HPI-O shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-hpio-1: HPI-O prefix is 800362 (`value.startsWith('800362')`) inv-hpio-2: The identifier 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)`)
50. Organization.identifier:abn
Slice Name | abn
Definition | Australian Securities and Investment Commission (ASIC) assigned identifier for business/entity. ABN (Australian Business Number).
Short | Australian Business Number (ABN)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: org-1
Type | Identifier(AU Australian Business Number)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-abn-0: ABN shall be exactly 11 digits (`value.length()=11`)
52. Organization.identifier:abn.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
54. Organization.identifier:abn.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Organization.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. Organization.identifier:abn.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
58. Organization.identifier:abn.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Coded identifier type for ABN
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
60. Organization.identifier:abn.type.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
62. Organization.identifier:abn.type.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Organization.identifier.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
64. Organization.identifier:abn.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
66. Organization.identifier:abn.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Fixed Value | `ABN`
68. Organization.identifier:abn.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for ABN
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://hl7.org.au/id/abn`
Example | General: http://www.acme.com/identifiers/patient
70. Organization.identifier:abn.value
Definition | Australian Business Number (ABN) identifier .
Short | ABN
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
72. Organization.identifier:abn.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
74. Organization.identifier:abn.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
76. Organization.identifier:acn
Slice Name | acn
Definition | Australian Securities and Investment Commission (ASIC) assigned identifier for business/entity. ACN (Australian Company Number).
Short | Australian Company Number (ACN)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: org-1
Type | Identifier(AU Australian Company Number)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-acn-0: ACN shall be exactly 9 digits (`value.length()=9`)
78. Organization.identifier:acn.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. Organization.identifier:acn.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Organization.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
82. Organization.identifier:acn.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
84. Organization.identifier:acn.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Coded identifier type for ACN
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
86. Organization.identifier:acn.type.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
88. Organization.identifier:acn.type.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Organization.identifier.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
90. Organization.identifier:acn.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
92. Organization.identifier:acn.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Fixed Value | `ACN`
94. Organization.identifier:acn.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for ACN
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://hl7.org.au/id/acn`
Example | General: http://www.acme.com/identifiers/patient
96. Organization.identifier:acn.value
Definition | Australian Company Number (ACN) identifier
Short | ACN
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
98. Organization.identifier:acn.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
100. Organization.identifier:acn.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
102. Organization.identifier:arbn
Slice Name | arbn
Definition | Australian Securities and Investment Commission (ASIC) assigned identifier for business/entity. ARBN (Australian Registered Body Number).
Short | Australian Registered Body Number (ARBN)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: org-1
Type | Identifier(AUAustralianRegisteredBodyNumber)
Is Modifier | false
Must Support | true
Summary | true
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.
Invariants | inv-arbn-0: ARBN shall be exactly 9 digits (`value.length()=9`)
104. Organization.identifier:arbn.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
106. Organization.identifier:arbn.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Organization.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
108. Organization.identifier:arbn.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
110. Organization.identifier:arbn.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
112. Organization.identifier:arbn.type.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
114. Organization.identifier:arbn.type.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Organization.identifier.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
116. Organization.identifier:arbn.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
118. Organization.identifier:arbn.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Fixed Value | `ARBN`
120. Organization.identifier:arbn.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for ARBN
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://hl7.org.au/id/arbn`
Example | General: http://www.acme.com/identifiers/patient
122. Organization.identifier:arbn.value
Definition | Australian Registered Body Number (ARBN) identifier.
Short | ARBN
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
124. Organization.identifier:arbn.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
126. Organization.identifier:arbn.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
128. Organization.identifier:paio
Slice Name | paio
Definition | My Health Record Assigned Identity for Organisations (PAI-O).
Short | My Health Record Assigned Identity for Organisations (PAI-O)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0 This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Invariants | inv-paio-0: PAI-O shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-paio-1: PAI-O prefix is 800364 (`value.startsWith('800364')`) inv-paio-2: The identifier 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)`)
142. Organization.identifier:csp
Slice Name | csp
Definition | Contracted Service Provider (CSP) number identifier for organisations
Short | Contracted Service Provider (CSP) Number
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0 This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
Invariants | inv-csp-0: CSP number is exactly 16 characters (`value.length() = 16`) inv-csp-1: CSP number prefix is 800363 (`value.startsWith('800363')`)
156. Organization.identifier:nataAccreditation
Slice Name | nataAccreditation
Definition | Identifier of an organization accredited by the National Association of Testing Authorities (NATA)
Short | National Association of Testing Authorities (NATA) Accreditation Number
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0 This element is affected by the following invariants: org-1
Type | Identifier
Is Modifier | false
Summary | true
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.
170. Organization.identifier:rid
Slice Name | rid
Definition | NHSD Organization Resource Identifier
Short | Organisation Directory Entry Identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: org-1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
Summary | true
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.
172. Organization.active
Definition | Whether the organization's record is still in active use.
Short | Reflects the current status of the organization resource
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.
Control | 1..1
Type | boolean
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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 Missing | This resource is generally assumed to be active if no value is provided for the active element
174. Organization.type
Definition | The kind(s) of organization that this is.
Short | Kind of organization
Comments | 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.
Control | 0..0
Binding | For example codes, see OrganizationType (example to `http://hl7.org/fhir/ValueSet/organization-type` ) Used to categorize the organization.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses.
176. Organization.name
Definition | A name associated with the organization.
Short | Name of 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.
Control | 1..1 This element is affected by the following invariants: org-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to use the name as the label of the organization.
178. Organization.alias
Definition | A list of alternate names that the organization is known as, or was known as in the past.
Short | A list of alternate names that the organization is known as
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.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
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.
180. Organization.telecom
Definition | A contact detail for the organization.
Short | Contact Details of Directroy Entry Organisation
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.
Control | 0..0 This element is affected by the following invariants: org-3
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Requirements | Human contact for the organization.
Invariants | org-3: The telecom of an organization can never be of use 'home' (`where(use = 'home').empty()`)
182. Organization.address
Definition | An address for the organization.
Short | Addresses of Directroy Entry Organisation
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
Control | 0..0 This element is affected by the following invariants: org-2
Type | Address
Is Modifier | false
Must Support | true
Summary | false
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
Invariants | org-2: An address of an organization can never be of use 'home' (`where(use = 'home').empty()`)
196. Organization.partOf
Definition | This is a reference to the parent organization.
Short | This is a reference to the parent organization
Control | 0..1
Type | Reference(NHSD Organisation)
Is Modifier | false
Summary | true
Requirements | Need to be able to track the hierarchy of organizations within an organization.
198. Organization.contact
Definition | Contact for the organization for a certain purpose.
Short | Contact 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.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | Need to keep track of assigned contact points within bigger organization.
Label | Organisation Contacts
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
202. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
204. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
206. Organization.contact.purpose
Definition | Indicates a purpose for which the contact can be reached.
Short | The type of contact
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ContactEntityType (extensible to `http://hl7.org/fhir/ValueSet/contactentity-type` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Need to distinguish between multiple contact persons.
208. Organization.contact.name
Definition | A name associated with the contact.
Short | A name associated with the contact
Control | 0..1
Type | HumanName
Is Modifier | false
Summary | false
Requirements | Need to be able to track the person by name.
210. Organization.contact.telecom
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Short | Contact details (telephone, email, etc.) for a contact
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | false
Requirements | People have (primary) ways to contact them in some way such as phone, email.
212. Organization.contact.address
Definition | Visiting or postal addresses for the contact.
Short | Visiting or postal addresses for the contact
Control | 0..1
Type | Address
Is Modifier | false
Summary | false
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements.
214. Organization.endpoint
Definition | Technical endpoints providing access to services operated for the organization.
Short | Technical endpoints providing access to services operated for the organization
Control | 0..0
Type | Reference(Endpoint)
Is Modifier | false
Summary | false
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.