Status: DRAFT: For Review

Introduction

This profile sets minimum expectations for the Organization resource. We use the UKCore-Organization structure definition as a base to this profile.

Organisation coverage and references

• A Data Provider MUST offer Organisation FHIR resources to represent its own organisation(s)
• When referencing an organisation then the "reference" (url of FHIR Resource) and "display" (name) MUST be populated
  • For an external organisation then the url could be either to an ad-hoc Contained Resource, or to the regional master organisation record
  • The "identifier" in the reference MAY be populated with the organisation's ODS Code

Mandatory fields

The following fields are mandatory:

1. Name - The name of the organisation

Must Support fields

In addition the following fields are "Must Support" - ie they must be populated if relevant and known:

1. Identifier: ODS Organisation code - Must be populated where available. Almost all organisations in both Health and Social Care do have an ODS Code which both identifies the organisation and allows other details to be looked up from the master ODS records. However it is recognised that there may be some circumstances with new or smaller providers where it cannot be mandated.

2. Identifier:Local Id - As with most other resources, there is the option to include a local identifier. The wide use of ODS codes to uniquely identify an organisation makes it less important to also include a local id. However in cases where an ODS code does not exist then a local id MUST be provided instead to help identify the organisation.

3. Type - The type of organisation, as classified by ODS

4. Active - Essential if not active. Good practice to always populate anyway.

5. Address - The organisation's address. (Noting that the definitive address can always be looked up given the ODS code)

6. Telecom - Can be populated if known (UK Core has flagged this element as MS) - although the Location and Practitioner resources are likely to provide more specific and useful contact details

Optional fields

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

• Other Identifiers -
  • ODS Site Code - ODS Site code which may optionally be populated if relevant.

Discouraged or Removed fields

• Extensions - Discouraged. As these do not appear to be vital for our usage here.

• Part Of - Discouraged. We are expecting a simple, flat structure based on ODS codes. (Any modelling of ODS hierarchy could be done separately and does not need to be built into the resources).

• Contact - Discouraged. These administrative contact details would need to be kept up-to-date, and do not appear particularly relevant to maintain or exchange.

• Endpoint - Removed. Technical endpoints are captured elsewhere (ie via the Participant Registry)

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

This structure is derived from UKCoreOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			UKCoreOrganization
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
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
Slices for extension				Content/Rules for all slices
extension:mainLocation		0..1	ExtensionUKCoreMainLocation	DISCOURAGED
extension:organizationPeriod		0..1	OrgPeriod(5.1.0)	DISCOURAGED
Slices for identifier				Content/Rules for all slices
identifier:odsOrganisationCode	S	0..1	Identifier	Organisation Data Service code
system	S	1..1	uri	The namespace for the identifier value
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:odsSiteCode		0..1	Identifier	ODS Site code to identify the organisation at site level
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
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.interweavedigital.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
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active		0..1	boolean	Whether this organization is still active - must be both populated and understood if 'false'
type	S	0..1	CodeableConcept	Kind of organization Binding: InterweaveOrganizationType (required)
coding		0..*	Coding	Kind of organization (based on ODS organisation types)
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name		1..1	string	A name associated with the organization.
telecom		0..*	ContactPoint	Contact details of the location. (However contact details of Locations and Practitioners are probably more useful).
address		0..1	Address	An address for the organization.
use		0..1	code	DISCOURAGED: Not really relevant here - it is just the current address of the location.
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
postalCode	S	0..1	string	Postal code for area
period		0..1	Period	DISCOURAGED: Preferably just relevant current details
partOf		0..1	Reference(InterweaveOrganization)	DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
contact		0..*	BackboneElement	DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	required	InterweaveOrganizationType https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-OrganizationType from this IG

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	UKCoreOrganization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (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://fhir.interweavedigital.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: CommonTags (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://fhir.interweavedigital.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: CommonLanguages (preferred): 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
Slices for extension				Content/Rules for all slices
mainLocation		0..1	Reference(Location)	DISCOURAGED URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod		0..1	(Complex)	DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]		1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:odsOrganisationCode	SΣC	0..1	Identifier	Organisation Data Service code
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣC	0..1	Identifier	Identifies this organization across multiple systems.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (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.interweavedigital.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(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this organization is still active - must be both populated and understood if 'false'
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: InterweaveOrganizationType (required)
coding	Σ	0..*	Coding	Kind of organization (based on ODS organisation types)
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
name	SΣC	1..1	string	A name associated with the organization.
telecom	SC	0..*	ContactPoint	Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). org-3: The telecom of an organization can never be of use 'home'
address	SC	0..1	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
use	?!Σ	0..1	code	DISCOURAGED: Not really relevant here - it is just the current address of the location. Binding: AddressUse (required): The use of an address. Example General: home
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
period	Σ	0..1	Period	DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
contact		0..*	BackboneElement	DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Organization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:odsSiteCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.type	required	InterweaveOrganizationType https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-OrganizationType from this IG
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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-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()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, 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..*	UKCoreOrganization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonLanguages (preferred): 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
mainLocation		0..1	Reference(Location)	DISCOURAGED URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod		0..1	(Complex)	DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]		1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:odsOrganisationCode	SΣC	0..1	Identifier	Organisation Data Service code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣC	0..1	Identifier	Identifies this organization across multiple systems.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.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(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this organization is still active - must be both populated and understood if 'false'
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: InterweaveOrganizationType (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Kind of organization (based on ODS organisation types)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
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	A name associated with the organization.
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). org-3: The telecom of an organization can never be of use 'home'
address	SC	0..1	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	DISCOURAGED: Not really relevant here - it is just the current address of the location. Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
contact		0..*	BackboneElement	DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Organization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:odsOrganisationCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.identifier:odsSiteCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:odsSiteCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:localIdentifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	required	InterweaveOrganizationType https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-OrganizationType from this IG
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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-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()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, 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()

Differential View

This structure is derived from UKCoreOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			UKCoreOrganization
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
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
Slices for extension				Content/Rules for all slices
extension:mainLocation		0..1	ExtensionUKCoreMainLocation	DISCOURAGED
extension:organizationPeriod		0..1	OrgPeriod(5.1.0)	DISCOURAGED
Slices for identifier				Content/Rules for all slices
identifier:odsOrganisationCode	S	0..1	Identifier	Organisation Data Service code
system	S	1..1	uri	The namespace for the identifier value
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:odsSiteCode		0..1	Identifier	ODS Site code to identify the organisation at site level
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
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.interweavedigital.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
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active		0..1	boolean	Whether this organization is still active - must be both populated and understood if 'false'
type	S	0..1	CodeableConcept	Kind of organization Binding: InterweaveOrganizationType (required)
coding		0..*	Coding	Kind of organization (based on ODS organisation types)
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name		1..1	string	A name associated with the organization.
telecom		0..*	ContactPoint	Contact details of the location. (However contact details of Locations and Practitioners are probably more useful).
address		0..1	Address	An address for the organization.
use		0..1	code	DISCOURAGED: Not really relevant here - it is just the current address of the location.
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
postalCode	S	0..1	string	Postal code for area
period		0..1	Period	DISCOURAGED: Preferably just relevant current details
partOf		0..1	Reference(InterweaveOrganization)	DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
contact		0..*	BackboneElement	DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	required	InterweaveOrganizationType https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-OrganizationType from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	UKCoreOrganization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (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://fhir.interweavedigital.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: CommonTags (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://fhir.interweavedigital.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: CommonLanguages (preferred): 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
Slices for extension				Content/Rules for all slices
mainLocation		0..1	Reference(Location)	DISCOURAGED URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod		0..1	(Complex)	DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]		1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:odsOrganisationCode	SΣC	0..1	Identifier	Organisation Data Service code
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣC	0..1	Identifier	Identifies this organization across multiple systems.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (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.interweavedigital.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(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this organization is still active - must be both populated and understood if 'false'
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: InterweaveOrganizationType (required)
coding	Σ	0..*	Coding	Kind of organization (based on ODS organisation types)
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
name	SΣC	1..1	string	A name associated with the organization.
telecom	SC	0..*	ContactPoint	Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). org-3: The telecom of an organization can never be of use 'home'
address	SC	0..1	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
use	?!Σ	0..1	code	DISCOURAGED: Not really relevant here - it is just the current address of the location. Binding: AddressUse (required): The use of an address. Example General: home
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
period	Σ	0..1	Period	DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
contact		0..*	BackboneElement	DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Organization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:odsSiteCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.type	required	InterweaveOrganizationType https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-OrganizationType from this IG
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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-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()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, 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..*	UKCoreOrganization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonLanguages (preferred): 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
mainLocation		0..1	Reference(Location)	DISCOURAGED URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod		0..1	(Complex)	DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]		1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:odsOrganisationCode	SΣC	0..1	Identifier	Organisation Data Service code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:odsSiteCode	ΣC	0..1	Identifier	ODS Site code to identify the organisation at site level
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
identifier:localIdentifier	SΣC	0..1	Identifier	Identifies this organization across multiple systems.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.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(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this organization is still active - must be both populated and understood if 'false'
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: InterweaveOrganizationType (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Kind of organization (based on ODS organisation types)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
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	A name associated with the organization.
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). org-3: The telecom of an organization can never be of use 'home'
address	SC	0..1	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	DISCOURAGED: Not really relevant here - it is just the current address of the location. Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
contact		0..*	BackboneElement	DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Organization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.identifier:odsOrganisationCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:odsOrganisationCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.identifier:odsSiteCode.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:odsSiteCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier:localIdentifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	required	InterweaveOrganizationType https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-OrganizationType from this IG
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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-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()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, 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()

This structure is derived from UKCoreOrganization

Summary

Mandatory: 1 element(11 nested mandatory elements)
Must-Support: 19 elements
Fixed: 3 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

• InterweaveOrganization (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Organization)

Slices

This structure defines the following Slices:

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