Please note:

This version of the UK Core is a development copy.
This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

StructureDefinition UKCore-Organization

Canonical_URL	Status	Current_Version	Last_Updated	Description
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization	active	2.5.1	2024-07-23	This profile defines the UK constraints and extensions on the International FHIR resource Organization.

Profile_Purpose
This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

UKCoreOrganization (Organization)	I		Organization	There are no (further) constraints on this element Element id Organization Short description A grouping of people or organizations with a common purpose Definition A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. Data type Organization Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: 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-3: 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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` org-1: The organization SHALL at least have a name or an identifier, and possibly more than one `(identifier.count() + name.count()) > 0` Mappings rim: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
id	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Organization.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Organization.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id Organization.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id Organization.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Organization.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
mainLocation	I	0..1	Extension(Reference(Location))	Element id Organization.extension:mainLocation Short description The main location of the organisation. Alternate names extensions, user content Definition The main location of the organisation. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(Reference(Location)) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
organizationPeriod	I	0..1	Extension(Period)	Element id Organization.extension:organizationPeriod Short description The date range that this organization SHOULD be considered available. Alternate names extensions, user content Definition The date range that this organization SHOULD be considered available. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension(Period) Extension URL http://hl7.org/fhir/StructureDefinition/organization-period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value http://hl7.org/fhir/StructureDefinition/organization-period Mappings rim: N/A
value[x]		1..1		Element id Organization.extension:organizationPeriod.value[x] Short description The date range that this organization SHOULD be considered available. Definition The date range that this organization SHOULD be considered available. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valuePeriod			Period	There are no (further) constraints on this element Data type Period
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
identifier	S Σ I	0..*	Identifier	Element id Organization.identifier Short description Identifies this organization across multiple systems. Definition Identifier for the organization that is used to identify the organization across multiple disparate systems. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
odsOrganisationCode	Σ I	0..1	Identifier	Element id Organization.identifier:odsOrganisationCode Short description Organisation Data Service code Definition Identifier code supplier by the Organisation Data Service. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Organization.identifier:odsOrganisationCode.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-organization-code Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim: n/a v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
odsSiteCode	Σ I	0..1	Identifier	Element id Organization.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Organization.identifier:odsSiteCode.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-site-code Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim: n/a v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
active	S Σ ?!	0..1	boolean	Element id Organization.active Short description Identifies this organization across multiple systems. Definition Whether the organization's record is still in active use. Requirements Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Comments This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.status v2: No equivalent in HL7 v2 rim: .status servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
type	Σ	0..*	CodeableConceptBinding	Element id Organization.type Short description Kind of organization Definition The kind(s) of organization that this is. Requirements Need to be able to track the kind of organization that this is - different organization types have different uses. Comments Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Data type CodeableConcept Binding A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class v2: No equivalent in v2 rim: .code servd: n/a
name	S Σ I	0..1	string	Element id Organization.name Short description A name associated with the organization. Definition A name associated with the organization. Requirements Need to use the name as the label of the organization. Comments If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XON.1 rim: .name servd: .PreferredName/Name
alias		0..*	string	There are no (further) constraints on this element Element id Organization.alias Short description A list of alternate names that the organization is known as, or was known as in the past Definition A list of alternate names that the organization is known as, or was known as in the past. Requirements Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. Comments There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .name
telecom	S I	0..*	ContactPoint	Element id Organization.telecom Short description Contact details for the organization. Definition A contact detail for the organization. Requirements Human contact for the organization. Comments The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: ORC-22? rim: .telecom servd: ./ContactPoints
address	S I	0..*	Address	Element id Organization.address Short description An address for the organization. Definition An address for the organization. Requirements May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Comments Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings rim: n/a v2: XAD rim: AD servd: Address v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
partOf	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.partOf Short description The organization of which this organization forms a part Definition The organization of which this organization forms a part. Requirements Need to be able to track the hierarchy of organizations within an organization. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: No equivalent in HL7 v2 rim: .playedBy[classCode=Part].scoper servd: n/a
contact		0..*	BackboneElement	There are no (further) constraints on this element Element id Organization.contact Short description Contact for the organization for a certain purpose Definition Contact for the organization for a certain purpose. Requirements Need to keep track of assigned contact points within bigger organization. Comments Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .contactParty
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
purpose		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.contact.purpose Short description The type of contact Definition Indicates a purpose for which the contact can be reached. Requirements Need to distinguish between multiple contact persons. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding The purpose for which you would contact a contact party. ContactEntityType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: ./type
name		0..1	HumanName	There are no (further) constraints on this element Element id Organization.contact.name Short description A name associated with the contact Definition A name associated with the contact. Requirements Need to be able to track the person by name. Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: PID-5, PID-9 rim: ./name
telecom	I	0..*	ContactPoint	There are no (further) constraints on this element Element id Organization.contact.telecom Short description Contact details (telephone, email, etc.) for a contact Definition A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: PID-13, PID-14 rim: ./telecom
address		0..1	Address	There are no (further) constraints on this element Element id Organization.contact.address Short description Visiting or postal addresses for the contact Definition Visiting or postal addresses for the contact. Requirements May need to keep track of a contact party's address for contacting, billing or reporting requirements. Comments Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XAD rim: AD servd: Address v2: PID-11 rim: ./addr
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id Organization.endpoint Short description Technical endpoints providing access to services operated for the organization Definition Technical endpoints providing access to services operated for the organization. Requirements Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Detailed Descriptions

Organization
Definition	A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: 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-3: 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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` org-1: The organization SHALL at least have a name or an identifier, and possibly more than one `(identifier.count() + name.count()) > 0`
Mappings	rim: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
Organization.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Organization.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A
Organization.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Organization.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Organization.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A rim: Act.text?
Organization.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: Entity. Role, or Act rim: N/A
Organization.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.extension:mainLocation
Definition	The main location of the organisation.
Cardinality	0...1
Type	Extension(Reference(Location))
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.extension:organizationPeriod
Definition	The date range that this organization SHOULD be considered available.
Cardinality	0...1
Type	Extension(Period)
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.extension:organizationPeriod.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.extension:organizationPeriod.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...0
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.extension:organizationPeriod.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/StructureDefinition/organization-period
Mappings	rim: N/A
Organization.extension:organizationPeriod.value[x]
Definition	The date range that this organization SHOULD be considered available.
Cardinality	1...1
Type	Period
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A
Organization.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.identifier
Definition	Identifier for the organization that is used to identify the organization across multiple disparate systems.
Cardinality	0...*
Type	Identifier
Must Support	True
Summary	True
Requirements	Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Slicing	Unordered, Open, by system(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
Organization.identifier:odsOrganisationCode
Definition	Identifier code supplier by the Organisation Data Service.
Cardinality	0...1
Type	Identifier
Summary	True
Requirements	Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
Organization.identifier:odsOrganisationCode.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.identifier:odsOrganisationCode.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.identifier:odsOrganisationCode.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: N/A rim: Role.code or implied by context
Organization.identifier:odsOrganisationCode.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
Organization.identifier:odsOrganisationCode.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/Id/ods-organization-code
Mappings	rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Organization.identifier:odsOrganisationCode.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	rim: n/a v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Organization.identifier:odsOrganisationCode.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Comments	A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
Mappings	rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Organization.identifier:odsOrganisationCode.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Organization.identifier:odsSiteCode
Definition	ODS Site code to identify the organisation at site level.
Cardinality	0...1
Type	Identifier
Summary	True
Requirements	Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
Organization.identifier:odsSiteCode.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.identifier:odsSiteCode.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.identifier:odsSiteCode.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: N/A rim: Role.code or implied by context
Organization.identifier:odsSiteCode.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
Organization.identifier:odsSiteCode.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/Id/ods-site-code
Mappings	rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Organization.identifier:odsSiteCode.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	rim: n/a v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Organization.identifier:odsSiteCode.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Comments	A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
Mappings	rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Organization.identifier:odsSiteCode.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Organization.active
Definition	Whether the organization's record is still in active use.
Cardinality	0...1
Type	boolean
Must Support	True
Modifier	True
Summary	True
Requirements	Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
Comments	This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a w5: FiveWs.status v2: No equivalent in HL7 v2 rim: .status servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
Organization.type
Definition	The kind(s) of organization that this is.
Cardinality	0...*
Type	CodeableConcept
Binding	A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible)
Summary	True
Requirements	Need to be able to track the kind of organization that this is - different organization types have different uses.
Comments	Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class v2: No equivalent in v2 rim: .code servd: n/a
Organization.name
Definition	A name associated with the organization.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Requirements	Need to use the name as the label of the organization.
Comments	If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XON.1 rim: .name servd: .PreferredName/Name
Organization.alias
Definition	A list of alternate names that the organization is known as, or was known as in the past.
Cardinality	0...*
Type	string
Requirements	Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful.
Comments	There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: .name
Organization.telecom
Definition	A contact detail for the organization.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Requirements	Human contact for the organization.
Comments	The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()`
Mappings	rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: ORC-22? rim: .telecom servd: ./ContactPoints
Organization.address
Definition	An address for the organization.
Cardinality	0...*
Type	Address
Must Support	True
Requirements	May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
Comments	Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()`
Mappings	rim: n/a v2: XAD rim: AD servd: Address v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
Organization.partOf
Definition	The organization of which this organization forms a part.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Requirements	Need to be able to track the hierarchy of organizations within an organization.
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: No equivalent in HL7 v2 rim: .playedBy[classCode=Part].scoper servd: n/a
Organization.contact
Definition	Contact for the organization for a certain purpose.
Cardinality	0...*
Type	BackboneElement
Requirements	Need to keep track of assigned contact points within bigger organization.
Comments	Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: .contactParty
Organization.contact.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.contact.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.contact.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Organization.contact.purpose
Definition	Indicates a purpose for which the contact can be reached.
Cardinality	0...1
Type	CodeableConcept
Binding	The purpose for which you would contact a contact party. ContactEntityType (extensible)
Requirements	Need to distinguish between multiple contact persons.
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: ./type
Organization.contact.name
Definition	A name associated with the contact.
Cardinality	0...1
Type	HumanName
Requirements	Need to be able to track the person by name.
Comments	Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: PID-5, PID-9 rim: ./name
Organization.contact.telecom
Definition	A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Cardinality	0...*
Type	ContactPoint
Requirements	People have (primary) ways to contact them in some way such as phone, email.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()`
Mappings	rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: PID-13, PID-14 rim: ./telecom
Organization.contact.address
Definition	Visiting or postal addresses for the contact.
Cardinality	0...1
Type	Address
Requirements	May need to keep track of a contact party's address for contacting, billing or reporting requirements.
Comments	Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XAD rim: AD servd: Address v2: PID-11 rim: ./addr
Organization.endpoint
Definition	Technical endpoints providing access to services operated for the organization.
Cardinality	0...*
Type	Reference(Endpoint)
Requirements	Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Table View

Organization		..
Organization.extension	Extension	..
Organization.extension	Extension	..
Organization.extension.value[x]		..
Organization.identifier		..
Organization.identifier		..1
Organization.identifier.system		1..
Organization.identifier.value		1..
Organization.identifier		..1
Organization.identifier.system		1..
Organization.identifier.value		1..
Organization.active		..
Organization.type		..
Organization.name		..
Organization.telecom		..
Organization.address		..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Organization" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
    <version value="2.5.1" />
    <name value="UKCoreOrganization" />
    <title value="UK Core Organization" />
    <status value="active" />
    <date value="2024-07-23" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Organization](https://hl7.org/fhir/R4/Organization.html)." />
    <purpose value="This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Organization" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" />
    <derivation value="constraint" />
    <differential>
        <element id="Organization.extension:mainLocation">
            <path value="Organization.extension" />
            <sliceName value="mainLocation" />
            <short value="The main location of the organisation." />
            <definition value="The main location of the organisation." />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation" />
            </type>
        </element>
        <element id="Organization.extension:organizationPeriod">
            <path value="Organization.extension" />
            <sliceName value="organizationPeriod" />
            <short value="The date range that this organization SHOULD be considered available." />
            <definition value="The date range that this organization SHOULD be considered available." />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/organization-period" />
            </type>
        </element>
        <element id="Organization.extension:organizationPeriod.value[x]">
            <path value="Organization.extension.value[x]" />
            <short value="The date range that this organization SHOULD be considered available." />
            <definition value="The date range that this organization SHOULD be considered available." />
        </element>
        <element id="Organization.identifier">
            <path value="Organization.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <short value="Identifies this organization across multiple systems." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode">
            <path value="Organization.identifier" />
            <sliceName value="odsOrganisationCode" />
            <short value="Organisation Data Service code" />
            <definition value="Identifier code supplier by the Organisation Data Service." />
            <max value="1" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-organization-code" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
        </element>
        <element id="Organization.identifier:odsSiteCode">
            <path value="Organization.identifier" />
            <sliceName value="odsSiteCode" />
            <short value="ODS Site code to identify the organisation at site level" />
            <definition value="ODS Site code to identify the organisation at site level." />
            <max value="1" />
        </element>
        <element id="Organization.identifier:odsSiteCode.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-site-code" />
        </element>
        <element id="Organization.identifier:odsSiteCode.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
        </element>
        <element id="Organization.active">
            <path value="Organization.active" />
            <short value="Identifies this organization across multiple systems." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type">
            <path value="Organization.type" />
            <binding>
                <strength value="extensible" />
                <description value="A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType" />
            </binding>
        </element>
        <element id="Organization.name">
            <path value="Organization.name" />
            <short value="A name associated with the organization." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.telecom">
            <path value="Organization.telecom" />
            <short value="Contact details for the organization." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.address">
            <path value="Organization.address" />
            <short value="An address for the organization." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Organization",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
    "version": "2.5.1",
    "name": "UKCoreOrganization",
    "title": "UK Core Organization",
    "status": "active",
    "date": "2024-07-23",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Organization](https://hl7.org/fhir/R4/Organization.html).",
    "purpose": "This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Organization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization.extension:mainLocation",
                "path": "Organization.extension",
                "sliceName": "mainLocation",
                "short": "The main location of the organisation.",
                "definition": "The main location of the organisation.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.extension:organizationPeriod",
                "path": "Organization.extension",
                "sliceName": "organizationPeriod",
                "short": "The date range that this organization SHOULD be considered available.",
                "definition": "The date range that this organization SHOULD be considered available.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/organization-period"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.extension:organizationPeriod.value[x]",
                "path": "Organization.extension.value[x]",
                "short": "The date range that this organization SHOULD be considered available.",
                "definition": "The date range that this organization SHOULD be considered available."
            },
            {
                "id": "Organization.identifier",
                "path": "Organization.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                },
                "short": "Identifies this organization across multiple systems.",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:odsOrganisationCode",
                "path": "Organization.identifier",
                "sliceName": "odsOrganisationCode",
                "short": "Organisation Data Service code",
                "definition": "Identifier code supplier by the Organisation Data Service.",
                "max": "1"
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-organization-code"
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.value",
                "path": "Organization.identifier.value",
                "min": 1
            },
            {
                "id": "Organization.identifier:odsSiteCode",
                "path": "Organization.identifier",
                "sliceName": "odsSiteCode",
                "short": "ODS Site code to identify the organisation at site level",
                "definition": "ODS Site code to identify the organisation at site level.",
                "max": "1"
            },
            {
                "id": "Organization.identifier:odsSiteCode.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-site-code"
            },
            {
                "id": "Organization.identifier:odsSiteCode.value",
                "path": "Organization.identifier.value",
                "min": 1
            },
            {
                "id": "Organization.active",
                "path": "Organization.active",
                "short": "Identifies this organization across multiple systems.",
                "mustSupport": true
            },
            {
                "id": "Organization.type",
                "path": "Organization.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType"
                }
            },
            {
                "id": "Organization.name",
                "path": "Organization.name",
                "short": "A name associated with the organization.",
                "mustSupport": true
            },
            {
                "id": "Organization.telecom",
                "path": "Organization.telecom",
                "short": "Contact details for the organization.",
                "mustSupport": true
            },
            {
                "id": "Organization.address",
                "path": "Organization.address",
                "short": "An address for the organization.",
                "mustSupport": true
            }
        ]
    }
}

Feedback

Click here to:

Report issue for UKCore-Organization, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

General Practice - Example to illustrate a General Practice organisation.
Example UKCore-Organization-WhiteRoseMedicalCentre

Hospital - Example to illustrate a Hospital organisation.
Example UKCore-Organization-LeedsTeachingHospital

Main Location - Example to illustrate the mainLocation extension.
Example UKCore-Extension-MainLocation

Organization Period - Example to illustrate the core-defined organization-period extension.
Example UKCore-Extension-OrganizationPeriod

Example Usage Scenarios

Query for organisation information using the query parameter identifier Organization.identifier for a known ODS code.
Exchange organisation information within a FHIR document or message.

Profile Specific Implementation Guidance:

Mandatory and Must Support Data Elements

The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.

Element	Reason
`Organization.identifier`	Identifies this organization across multiple systems.
`Organization.active`	Identifies this organization across multiple systems.
`Organization.name`	A name associated with the organization.
`Organization.telecom`	Contact details for the organization.
`Organization.address`	An address for the organization.

Extensions

More information about the extensions can be found using the links below.

Extension	Context	Link	Comment
mainLocation	Organization	Extension UKCore-MainLocation	The main location of the organisation.
organizationPeriod	Organization	Core-defined Extension organization-period	The date range that this organization SHOULD be considered available.

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context	Strength	Link
Organization.type	extensible	https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType

`identifier`

It is recommended that the Organization.identifier value is odsOrganisationCode, but another identifier can be used.

The organisation ODS code

Element	Description
`Organization.identifier:odsOrganisationCode.use`	usual \| official \| temp \| secondary \| old (If known)
`Organization.identifier:odsOrganisationCode.type`	This is not required with ODS
`Organization.identifier:odsOrganisationCode.system`	The url is `https://fhir.nhs.uk/Id/ods-organisation-code`
`Organization.identifier:odsOrganisationCode.value`	The ODS code
`Organization.identifier:odsOrganisationCode.period`	The period for which the code is valid - MAY be omitted
`Organization.identifier:odsOrganisationCode.assigner`	Implicit for ODS codes - SHOULD be omitted

The ODS site code for a specific site in the organisation

Element	Description
`Organization.identifier:odsSiteCode.use`	usual \| official \| temp \| secondary \| old (If known)
`Organization.identifier:odsSiteCode.type`	This is not required with ODS
`Organization.identifier:odsSiteCode.system`	The url is `https://fhir.nhs.uk/Id/ods-site-code`
`Organization.identifier:odsSiteCode.value`	The ODS site code
`Organization.identifier:odsSiteCode.period`	The period for which the code is valid - MAY be omitted
`Organization.identifier:odsSiteCode.assigner`	Implicit for ODS site codes - SHOULD be omitted

`telecom`

A contact detail (e.g. a telephone number or an email address) by which the organisation may be contacted.

Telecom uses the ContactPoint datatype.

`address`

The address of the organisation using the Address datatype.

`partOf`

Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Organization.