Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: Organization

Extension of UKCore Organization and includes elements from IHE Mobile Care Services Discovery (mCSD)

Usage:

• Refer to this Resource Profile: DocumentReference
• Examples for this Resource Profile: THE MOIR MEDICAL CENTRE and LEEDS TEACHING HOSPITALS NHS TRUST

Formal Views of Profile Content

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

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

This structure is derived from UKCoreOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			UKCoreOrganization
identifier		1..*	Identifier	Identifies this organization across multiple systems.
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
Slices for identifier				Content/Rules for all slices
identifier:odsOrganisationCode		0..1	OrganisationCode	An identifier intended for computation
identifier:odsSiteCode		0..1	Identifier	DO NOT USE. Sites are to be handled as Locations.
Documentation for this format

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
mainLocation	N	0..1	Reference(Location)	The main location of the organisation. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod	N	0..1	(Complex)	The date range that this organization SHOULD be considered available. URL: http://hl7.org/fhir/StructureDefinition/organization-period
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]	N	1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣC	1..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:odsOrganisationCode		0..1	OrganisationCode	An identifier intended for computation
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:odsSiteCode	ΣC	0..1	Identifier	DO NOT USE. Sites are to be handled as Locations.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!SΣ	0..1	boolean	Identifies this organization across multiple systems.
name	SΣC	0..1	string	A name associated with the organization.
telecom	SC	0..*	ContactPoint	Contact details for the organization. cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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

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	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
mainLocation	N	0..1	Reference(Location)	The main location of the organisation. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod	N	0..1	(Complex)	The date range that this organization SHOULD be considered available. URL: http://hl7.org/fhir/StructureDefinition/organization-period
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]	N	1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣC	1..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:odsOrganisationCode		0..1	OrganisationCode	An identifier intended for computation
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:odsSiteCode	ΣC	0..1	Identifier	DO NOT USE. Sites are to be handled as Locations.
id		0..1	string	Unique id for inter-element referencing
extension	N	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	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
active	?!SΣ	0..1	boolean	Identifies this organization across multiple systems.
type	Σ	0..*	CodeableConcept	Kind of organization Binding: UK Core Organization Type (extensible): A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts
name	SΣC	0..1	string	A name associated with the organization.
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details for the organization. cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
partOf	ΣC	0..1	Reference(Organization)	The organization of which this organization forms a part ref-1: SHALL have a contained resource if a local reference is provided
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	C	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact cpt-2: A system is required if a value is provided.
address		0..1	Address	Visiting or postal addresses for the contact
endpoint	C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization ref-1: SHALL have a contained resource if a local reference is provided
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type 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.type	extensible	UKCoreOrganizationType https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard

This structure is derived from UKCoreOrganization

Summary

Mandatory: 3 elements

Structures

This structure refers to these other structures:

• Organisation Code (https://fhir.virtually.healthcare/StructureDefinition/organisation-code)

Differential View

This structure is derived from UKCoreOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			UKCoreOrganization
identifier		1..*	Identifier	Identifies this organization across multiple systems.
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
Slices for identifier				Content/Rules for all slices
identifier:odsOrganisationCode		0..1	OrganisationCode	An identifier intended for computation
identifier:odsSiteCode		0..1	Identifier	DO NOT USE. Sites are to be handled as Locations.
Documentation for this format

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
mainLocation	N	0..1	Reference(Location)	The main location of the organisation. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod	N	0..1	(Complex)	The date range that this organization SHOULD be considered available. URL: http://hl7.org/fhir/StructureDefinition/organization-period
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]	N	1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣC	1..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:odsOrganisationCode		0..1	OrganisationCode	An identifier intended for computation
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:odsSiteCode	ΣC	0..1	Identifier	DO NOT USE. Sites are to be handled as Locations.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!SΣ	0..1	boolean	Identifies this organization across multiple systems.
name	SΣC	0..1	string	A name associated with the organization.
telecom	SC	0..*	ContactPoint	Contact details for the organization. cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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

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	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
mainLocation	N	0..1	Reference(Location)	The main location of the organisation. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation
organizationPeriod	N	0..1	(Complex)	The date range that this organization SHOULD be considered available. URL: http://hl7.org/fhir/StructureDefinition/organization-period
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-period"
value[x]	N	1..1	Period	The date range that this organization SHOULD be considered available.
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣC	1..*	Identifier	Identifies this organization across multiple systems. Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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 Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:odsOrganisationCode		0..1	OrganisationCode	An identifier intended for computation
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
value	Σ	1..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:odsSiteCode	ΣC	0..1	Identifier	DO NOT USE. Sites are to be handled as Locations.
id		0..1	string	Unique id for inter-element referencing
extension	N	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	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
active	?!SΣ	0..1	boolean	Identifies this organization across multiple systems.
type	Σ	0..*	CodeableConcept	Kind of organization Binding: UK Core Organization Type (extensible): A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts
name	SΣC	0..1	string	A name associated with the organization.
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	Contact details for the organization. cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address	An address for the organization. org-2: An address of an organization can never be of use 'home'
partOf	ΣC	0..1	Reference(Organization)	The organization of which this organization forms a part ref-1: SHALL have a contained resource if a local reference is provided
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	C	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact cpt-2: A system is required if a value is provided.
address		0..1	Address	Visiting or postal addresses for the contact
endpoint	C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization ref-1: SHALL have a contained resource if a local reference is provided
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type 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.type	extensible	UKCoreOrganizationType https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard

This structure is derived from UKCoreOrganization

Summary

Mandatory: 3 elements

Structures

This structure refers to these other structures:

• Organisation Code (https://fhir.virtually.healthcare/StructureDefinition/organisation-code)

Other representations of profile: CSV, Excel, Schematron