HL7 FHIR® UK Core
4.0.0 - CI Build

HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions

StructureDefinition: UKCoreOrganization

Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information.

The official URL for this profile is:

https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Organization

Formal Views of Profile Content

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

This structure is derived from Organization

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:odsOrganisationCode ΣI0..1IdentifierOrganisation Data Service code
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣI0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name ΣI0..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf ΣI0..1Reference(UK Core Organization)The organization of which this organization forms a part
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... display ΣI0..1stringText alternative for the resource
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... display ΣI0..1stringText alternative for the resource

doco Documentation for this format

This structure is derived from Organization

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Organization

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:odsOrganisationCode ΣI0..1IdentifierOrganisation Data Service code
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣI0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name ΣI0..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf ΣI0..1Reference(UK Core Organization)The organization of which this organization forms a part
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... display ΣI0..1stringText alternative for the resource
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... display ΣI0..1stringText alternative for the resource

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.partOf.typeextensibleResourceType
Organization.partOf.identifier.userequiredIdentifierUse
Organization.partOf.identifier.typeextensibleIdentifier Type Codes
Organization.contact.purposeextensibleContactEntityType
Organization.endpoint.typeextensibleResourceType
Organization.endpoint.identifier.userequiredIdentifierUse
Organization.endpoint.identifier.typeextensibleIdentifier Type Codes

Constraints

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3OrganizationIf 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-4OrganizationIf 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-5OrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6OrganizationA resource should have narrative for robust management
: text.`div`.exists()
org-1OrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
ele-1Organization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.identifier:odsOrganisationCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.identifier:odsOrganisationCode.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCode.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCode.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCode.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCode.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsOrganisationCode.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.identifier:odsSiteCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.identifier:odsSiteCode.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCode.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCode.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCode.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCode.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:odsSiteCode.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.partOf.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.partOf.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.partOf.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.partOf.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOf.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.endpoint.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.endpoint.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.endpoint.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.endpoint.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpoint.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())