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:

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CareConnect-Organization-1

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	CareConnect-Organization-1	A grouping of people or organizations with a common purpose
id	S	0..1	id	Logical id of this artifact
meta
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - 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..1	Identifier	Identifies this organization across multiple systems
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
value	S	1..1	string	The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
active	S	1..1	boolean	Whether this organizational team is active
type	S	1..1	CodeableConcept	Default to Organizational team.
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/organization-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: team
display		1..1	string	Representation defined by the system Fixed Value: Organizational team
name	S	1..1	string	Name used for the organizational team.
alias		0..*	string	A list of alternate names that the organizational team is known as, or was known as in the past
telecom	S	0..*	ContactPoint	Contact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
address		0..*	Address	An address for the organizational team
partOf	S	1..1	Reference(CareConnect-Organization-1)	The organization of which this organizational team forms a part
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
contact		0..0
endpoint		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	CareConnect-Organization-1	A grouping of people or organizations with a common purpose
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags 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..1	Coding	MANDATORY 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..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY 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..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
use	?!Σ	0..1	code	usual | official | temp | secondary (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
identifier:localIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
value	SΣ	1..1	string	The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
active	?!SΣ	1..1	boolean	Whether this organizational team is active
type	SΣ	1..1	CodeableConcept	Default to Organizational team. Binding: OrganizationType (example): Used to categorize the organization
name	SΣC	1..1	string	Name used for the organizational team.
alias		0..*	string	A list of alternate names that the organizational team is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
address	C	0..*	Address	An address for the organizational team
partOf	SΣ	1..1	Reference(CareConnect-Organization-1)	The organization of which this organizational team forms a part
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Organization.meta.security	extensible	All Security Labels
Organization.meta.tag	example	Common Tags
Organization.meta.tag:Source	example	Common Tags
Organization.meta.tag:Provenance	example	Common Tags
Organization.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse
Organization.identifier:odsSiteCode.use	required	IdentifierUse
Organization.identifier:localIdentifier.use	required	IdentifierUse
Organization.type	example	OrganizationType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Organization	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	If 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-4	error	Organization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
org-1	error	Organization	The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	CareConnect-Organization-1	A grouping of people or organizations with a common purpose
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags 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..1	Coding	MANDATORY 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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(CareConnect-Organization-1)	Organization that issued id (may be just text)
identifier:localIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
value	SΣ	1..1	string	The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this organizational team is active
type	SΣ	1..1	CodeableConcept	Default to Organizational team. Binding: OrganizationType (example): Used to categorize the organization
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/organization-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: team
display	Σ	1..1	string	Representation defined by the system Fixed Value: Organizational team
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Name used for the organizational team.
alias		0..*	string	A list of alternate names that the organizational team is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
address	C	0..*	Address	An address for the organizational team
partOf	SΣ	1..1	Reference(CareConnect-Organization-1)	The organization of which this organizational team forms a part
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Organization.meta.security	extensible	All Security Labels
Organization.meta.tag	example	Common Tags
Organization.meta.tag:Source	example	Common Tags
Organization.meta.tag:Provenance	example	Common Tags
Organization.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse
Organization.identifier:odsOrganisationCode.type	extensible	Identifier Type Codes
Organization.identifier:odsSiteCode.use	required	IdentifierUse
Organization.identifier:odsSiteCode.type	extensible	Identifier Type Codes
Organization.identifier:localIdentifier.use	required	IdentifierUse
Organization.identifier:localIdentifier.type	extensible	Identifier Type Codes
Organization.type	example	OrganizationType
Organization.contact.purpose	extensible	ContactEntityType
Organization.contact.name.use	required	NameUse

Constraints

Id	Grade	Path(s)	Details	Requirements
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Differential View

This structure is derived from CareConnect-Organization-1

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	CareConnect-Organization-1	A grouping of people or organizations with a common purpose
id	S	0..1	id	Logical id of this artifact
meta
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - 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..1	Identifier	Identifies this organization across multiple systems
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
value	S	1..1	string	The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
active	S	1..1	boolean	Whether this organizational team is active
type	S	1..1	CodeableConcept	Default to Organizational team.
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/organization-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: team
display		1..1	string	Representation defined by the system Fixed Value: Organizational team
name	S	1..1	string	Name used for the organizational team.
alias		0..*	string	A list of alternate names that the organizational team is known as, or was known as in the past
telecom	S	0..*	ContactPoint	Contact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
address		0..*	Address	An address for the organizational team
partOf	S	1..1	Reference(CareConnect-Organization-1)	The organization of which this organizational team forms a part
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
contact		0..0
endpoint		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	CareConnect-Organization-1	A grouping of people or organizations with a common purpose
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags 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..1	Coding	MANDATORY 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..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY 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..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
use	?!Σ	0..1	code	usual | official | temp | secondary (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
identifier:localIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
value	SΣ	1..1	string	The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
active	?!SΣ	1..1	boolean	Whether this organizational team is active
type	SΣ	1..1	CodeableConcept	Default to Organizational team. Binding: OrganizationType (example): Used to categorize the organization
name	SΣC	1..1	string	Name used for the organizational team.
alias		0..*	string	A list of alternate names that the organizational team is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
address	C	0..*	Address	An address for the organizational team
partOf	SΣ	1..1	Reference(CareConnect-Organization-1)	The organization of which this organizational team forms a part
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Organization.meta.security	extensible	All Security Labels
Organization.meta.tag	example	Common Tags
Organization.meta.tag:Source	example	Common Tags
Organization.meta.tag:Provenance	example	Common Tags
Organization.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse
Organization.identifier:odsSiteCode.use	required	IdentifierUse
Organization.identifier:localIdentifier.use	required	IdentifierUse
Organization.type	example	OrganizationType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Organization	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	If 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-4	error	Organization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
org-1	error	Organization	The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	CareConnect-Organization-1	A grouping of people or organizations with a common purpose
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - 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..*	Coding	Tags 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..1	Coding	MANDATORY 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - 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..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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(CareConnect-Organization-1)	Organization that issued id (may be just text)
identifier:localIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
value	SΣ	1..1	string	The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this organizational team is active
type	SΣ	1..1	CodeableConcept	Default to Organizational team. Binding: OrganizationType (example): Used to categorize the organization
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/organization-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: team
display	Σ	1..1	string	Representation defined by the system Fixed Value: Organizational team
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Name used for the organizational team.
alias		0..*	string	A list of alternate names that the organizational team is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details of the Organisational team. To be used for the practical purpose of getting in touch about a person’s care.
address	C	0..*	Address	An address for the organizational team
partOf	SΣ	1..1	Reference(CareConnect-Organization-1)	The organization of which this organizational team forms a part
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Organization.meta.security	extensible	All Security Labels
Organization.meta.tag	example	Common Tags
Organization.meta.tag:Source	example	Common Tags
Organization.meta.tag:Provenance	example	Common Tags
Organization.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse
Organization.identifier:odsOrganisationCode.type	extensible	Identifier Type Codes
Organization.identifier:odsSiteCode.use	required	IdentifierUse
Organization.identifier:odsSiteCode.type	extensible	Identifier Type Codes
Organization.identifier:localIdentifier.use	required	IdentifierUse
Organization.identifier:localIdentifier.type	extensible	Identifier Type Codes
Organization.type	example	OrganizationType
Organization.contact.purpose	extensible	ContactEntityType
Organization.contact.name.use	required	NameUse

Constraints

Id	Grade	Path(s)	Details	Requirements
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The 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