Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: UK Core Organization

Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization Version: 2.5.0
Active as of 2023-12-12 Computable Name: UKCoreOrganization

Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.

This profile defines the UK constraints and extensions on the International FHIR resource Organization.

This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization Organization
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... mainLocation 0..1 Reference(Location) The main location of the organisation.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
.... organizationPeriod 0..1 (Complex) The date range that this organization SHOULD be considered available.
URL: http://hl7.org/fhir/StructureDefinition/organization-period
..... value[x] 1..1 Period The date range that this organization SHOULD be considered available.
... Slices for identifier S 0..* Identifier Identifies this organization across multiple systems.
Slice: Unordered, Open by value:system
.... identifier:odsOrganisationCode 0..1 Identifier Organisation Data Service code
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value 1..1 string The value that is unique
.... identifier:odsSiteCode 0..1 Identifier ODS Site code to identify the organisation at site level
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value 1..1 string The value that is unique
... active S 0..1 boolean Identifies this organization across multiple systems.
... name S 0..1 string A name associated with the organization.
... telecom S 0..* ContactPoint Contact details for the organization.
... address S 0..* Address An address for the organization.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typeextensibleUKCoreOrganizationType
https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... mainLocation 0..1 Reference(Location) The main location of the organisation.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
.... organizationPeriod 0..1 (Complex) The date range that this organization SHOULD be considered available.
URL: http://hl7.org/fhir/StructureDefinition/organization-period
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-period"
..... value[x] 1..1 Period The date range that this organization SHOULD be considered available.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:odsOrganisationCode ΣC 0..1 Identifier Organisation Data Service code
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:odsSiteCode ΣC 0..1 Identifier ODS Site code to identify the organisation at site level
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean Identifies this organization across multiple systems.
... type Σ 0..* CodeableConcept Kind of organization
Binding: UK Core Organization Type (extensible): A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts


... name SΣC 0..1 string A name associated with the organization.
... telecom SC 0..* ContactPoint Contact details for the organization.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address An address for the organization.
org-2: An address of an organization can never be of use 'home'

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:odsSiteCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typeextensibleUKCoreOrganizationType
https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... mainLocation 0..1 Reference(Location) The main location of the organisation.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
.... organizationPeriod 0..1 (Complex) The date range that this organization SHOULD be considered available.
URL: http://hl7.org/fhir/StructureDefinition/organization-period
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-period"
..... value[x] 1..1 Period The date range that this organization SHOULD be considered available.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems.
Slice: Unordered, Open by value:system
.... identifier:odsOrganisationCode ΣC 0..1 Identifier Organisation Data Service code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣC 0..1 Identifier ODS Site code to identify the organisation at site level
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Identifies this organization across multiple systems.
... type Σ 0..* CodeableConcept Kind of organization
Binding: UK Core Organization Type (extensible): A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts


... name SΣC 0..1 string A name associated with the organization.
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint Contact details for the organization.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address An address for the organization.
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:odsSiteCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeextensibleUKCoreOrganizationType
https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
from this IG
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 5 elements
Fixed: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.identifier

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization Organization
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... mainLocation 0..1 Reference(Location) The main location of the organisation.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
.... organizationPeriod 0..1 (Complex) The date range that this organization SHOULD be considered available.
URL: http://hl7.org/fhir/StructureDefinition/organization-period
..... value[x] 1..1 Period The date range that this organization SHOULD be considered available.
... Slices for identifier S 0..* Identifier Identifies this organization across multiple systems.
Slice: Unordered, Open by value:system
.... identifier:odsOrganisationCode 0..1 Identifier Organisation Data Service code
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value 1..1 string The value that is unique
.... identifier:odsSiteCode 0..1 Identifier ODS Site code to identify the organisation at site level
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value 1..1 string The value that is unique
... active S 0..1 boolean Identifies this organization across multiple systems.
... name S 0..1 string A name associated with the organization.
... telecom S 0..* ContactPoint Contact details for the organization.
... address S 0..* Address An address for the organization.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typeextensibleUKCoreOrganizationType
https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... mainLocation 0..1 Reference(Location) The main location of the organisation.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
.... organizationPeriod 0..1 (Complex) The date range that this organization SHOULD be considered available.
URL: http://hl7.org/fhir/StructureDefinition/organization-period
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-period"
..... value[x] 1..1 Period The date range that this organization SHOULD be considered available.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:odsOrganisationCode ΣC 0..1 Identifier Organisation Data Service code
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:odsSiteCode ΣC 0..1 Identifier ODS Site code to identify the organisation at site level
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean Identifies this organization across multiple systems.
... type Σ 0..* CodeableConcept Kind of organization
Binding: UK Core Organization Type (extensible): A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts


... name SΣC 0..1 string A name associated with the organization.
... telecom SC 0..* ContactPoint Contact details for the organization.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address An address for the organization.
org-2: An address of an organization can never be of use 'home'

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:odsSiteCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typeextensibleUKCoreOrganizationType
https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... mainLocation 0..1 Reference(Location) The main location of the organisation.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
.... organizationPeriod 0..1 (Complex) The date range that this organization SHOULD be considered available.
URL: http://hl7.org/fhir/StructureDefinition/organization-period
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-period"
..... value[x] 1..1 Period The date range that this organization SHOULD be considered available.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems.
Slice: Unordered, Open by value:system
.... identifier:odsOrganisationCode ΣC 0..1 Identifier Organisation Data Service code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣC 0..1 Identifier ODS Site code to identify the organisation at site level
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Identifies this organization across multiple systems.
... type Σ 0..* CodeableConcept Kind of organization
Binding: UK Core Organization Type (extensible): A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts


... name SΣC 0..1 string A name associated with the organization.
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint Contact details for the organization.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* Address An address for the organization.
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:odsSiteCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeextensibleUKCoreOrganizationType
https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
from this IG
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 5 elements
Fixed: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.identifier

 

Other representations of profile: CSV, Excel, Schematron