Interweave Implementation Guide
0.1.0 - ci-build

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

Resource Profile: InterweaveOrganizationalTeam

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-OrganizationalTeam Version: 0.1.0
Active as of 2024-07-17 Computable Name: InterweaveOrganizationalTeam

Interweave Organizational Team resource profile (modelled using FHIR Organization)

  Status: Active: Approved (STU)

Definition A sub-unit of workers which act as a team within an Organisation.

Introduction

This profile sets minimum expectations for the Organizational team, represented by an Organization FHIR resource. An Organizational Team is a sub-unit of workers which act as a team within an organisation. However, we do not need to model the individual team members here. It is simply enough to provide the name of the team, their contact details and which organisation they belong to (e.g. a local authority, NHS trust, private care provider etc). The resource is intended to be used for the practical purpose of getting in touch about a person’s healthcare/support. In Social Care, organisational teams will typically be the owners of assessments and services.

Organizational Team coverage and references

  • A Data Provider MUST offer Organizational Team FHIR resources to represent its own Organizational Teams.

  • When referencing an Organizational Team then the “reference” (URL of FHIR Resource) and “display” (organizational team name) MUST be populated.

Organizational Team hierarchy

We do not intend to model the full organizational structure here. This is a very simple two-tier hierarchy showing the very top (local authority, NHS trust etc) and very bottom (Organizational Team) of the tree. This two-tier structure should be created by providing a reference to the Organization resource, to which the team belongs, within the “partOf” field.

The diagram below depicts this hierarchy:

Organisational Team Hierarchy Diagram

Mandatory fields

The following fields are mandatory:

  • name - The descriptive name of the organizational team.

  • active - A mandatory flag to indicate whether Organizational Team is active.

  • type - Default to #team - Organizational team

  • partOf - This is a mandatory field and is used to provide a reference to the organization to which the team belongs e.g. A local authority. (See notes above for further information)

Must Support fields

In addition, the following fields are “Must Support” - i.e. they must be populated if relevant and known:

  • telecom - The contact details for the team. This is important information that must be provided.

Optional fields

These fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them:

  • identifier:localIdentifier - As with most other resources, there is the option to include a local identifier which may help to identify the Organizational Team at a local level.

  • alias - Option to provide a list of alternate names that the organizational team is known as, or was known as in the past

  • address - Can be populated if known - although is not deemed to be that important.

Discouraged or Removed fields

  • extensions - Removed. Two extensions are defined by Care Connect, but do not appear to be vital for our usage here.
  • contact - Removed. Not required, removed to avoid any confusion with the Telecom field.
  • endpoint - Removed. Technical endpoints are captured elsewhere (i.e. via the Participant Registry).

Usage:

Formal Views of Profile Content

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

This structure is derived from CareConnect-Organization-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:mainLocation 0..0
... extension:organization-period 0..0
... identifier:odsOrganisationCode 0..0
... identifier:localIdentifier 0..1IdentifierIdentifies this organization across multiple systems
.... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
.... value S1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
.... period 0..0
... active S1..1booleanWhether this organizational team is active
... type S1..1CodeableConceptDefault to Organizational team.
.... coding
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/organization-type
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: team
..... display 1..1stringRepresentation defined by the system
Fixed Value: Organizational team
... name S1..1stringName used for the organizational team.
... alias 0..*stringA list of alternate names that the organizational team is known as, or was known as in the past
... telecom S0..*ContactPointContact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
... address 0..*AddressAn address for the organizational team
... partOf S1..1Reference(CareConnect-Organization-1)The organization of which this organizational team forms a part
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... contact 0..0
... endpoint 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... active ?!SΣ1..1booleanWhether this organizational team is active
... type SΣ1..1CodeableConceptDefault to Organizational team.
Binding: OrganizationType (example): Used to categorize the organization


... name SΣC1..1stringName used for the organizational team.
... alias 0..*stringA list of alternate names that the organizational team is known as, or was known as in the past
... telecom SC0..*ContactPointContact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
... address C0..*AddressAn address for the organizational team
... partOf SΣ1..1Reference(CareConnect-Organization-1)The organization of which this organizational team forms a part
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:localIdentifier.userequiredIdentifierUse
Organization.typeexampleOrganizationType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
org-1errorOrganizationThe organization SHALL at least have a name or an id, 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 C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this organizational team is active
... type SΣ1..1CodeableConceptDefault to Organizational team.
Binding: OrganizationType (example): Used to categorize the organization


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/organization-type
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: team
..... display Σ1..1stringRepresentation defined by the system
Fixed Value: Organizational team
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name SΣC1..1stringName used for the organizational team.
... alias 0..*stringA list of alternate names that the organizational team is known as, or was known as in the past
... telecom SC0..*ContactPointContact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
... address C0..*AddressAn address for the organizational team
... partOf SΣ1..1Reference(CareConnect-Organization-1)The organization of which this organizational team forms a part
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Organization.identifier:localIdentifier.userequiredIdentifierUse
Organization.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse

Constraints

IdGradePath(s)DetailsRequirements
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 CareConnect-Organization-1

Summary

Mandatory: 6 elements (11 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 6 elements
Prohibited: 6 elements

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from CareConnect-Organization-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:mainLocation 0..0
... extension:organization-period 0..0
... identifier:odsOrganisationCode 0..0
... identifier:localIdentifier 0..1IdentifierIdentifies this organization across multiple systems
.... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
.... value S1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
.... period 0..0
... active S1..1booleanWhether this organizational team is active
... type S1..1CodeableConceptDefault to Organizational team.
.... coding
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/organization-type
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: team
..... display 1..1stringRepresentation defined by the system
Fixed Value: Organizational team
... name S1..1stringName used for the organizational team.
... alias 0..*stringA list of alternate names that the organizational team is known as, or was known as in the past
... telecom S0..*ContactPointContact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
... address 0..*AddressAn address for the organizational team
... partOf S1..1Reference(CareConnect-Organization-1)The organization of which this organizational team forms a part
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... contact 0..0
... endpoint 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... active ?!SΣ1..1booleanWhether this organizational team is active
... type SΣ1..1CodeableConceptDefault to Organizational team.
Binding: OrganizationType (example): Used to categorize the organization


... name SΣC1..1stringName used for the organizational team.
... alias 0..*stringA list of alternate names that the organizational team is known as, or was known as in the past
... telecom SC0..*ContactPointContact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
... address C0..*AddressAn address for the organizational team
... partOf SΣ1..1Reference(CareConnect-Organization-1)The organization of which this organizational team forms a part
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:localIdentifier.userequiredIdentifierUse
Organization.typeexampleOrganizationType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
org-1errorOrganizationThe organization SHALL at least have a name or an id, 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 C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this organizational team is active
... type SΣ1..1CodeableConceptDefault to Organizational team.
Binding: OrganizationType (example): Used to categorize the organization


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/organization-type
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: team
..... display Σ1..1stringRepresentation defined by the system
Fixed Value: Organizational team
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name SΣC1..1stringName used for the organizational team.
... alias 0..*stringA list of alternate names that the organizational team is known as, or was known as in the past
... telecom SC0..*ContactPointContact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
... address C0..*AddressAn address for the organizational team
... partOf SΣ1..1Reference(CareConnect-Organization-1)The organization of which this organizational team forms a part
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Organization.identifier:localIdentifier.userequiredIdentifierUse
Organization.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse

Constraints

IdGradePath(s)DetailsRequirements
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 CareConnect-Organization-1

Summary

Mandatory: 6 elements (11 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 6 elements
Prohibited: 6 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron