'Organisation' is the core component of the ODS data model for both Health and Social Care Organisation and Site record classes. All the other components of the model for these classes stem from the Organisation component.
All instances of Organisation and Site entities have an identifier (ODS code) supplied as part of the Organisation component. The identifier is unique within health and social care informatics and is never changed for the lifetime of the record. Identifiers are never reused – they are only ever closed and never deleted*. Some codes can follow the evolution of an organisation - for example, Sustainability and Transformation Partnerships evolved into Integrated Care Boards. They retained their same ODS codes as they were intentionally given a generic organisation type / primary role of 'Strategic Partnership' and it is the non primary roles that show their evolution, initially having an STP non primary role which was then end dated and an ICB non primary role added.
*Note: it is extremely rare but ODS codes can be withdrawn from publication if they were created in error or ODS are instructed to remove from publication for security purposes. In these rare cases, ODS will confirm the deletion or publication withdrawal via the ODS FHIR R4 Notices endpoint.
Organisation Data Attributes
Master Data Attribute (ODS Internal Reference) | Attribute Type | Length | Nullable | Description / Notes | Mapping to ODS Data Search & Export field (excluding predefined reports) | Mapping to ORD API (ORD schema containers, elements and attributes) | Mapping to ODS STU3 API | Mapping to ODS FHIR R4 API Please refer to ODS FHIR R4 Implementation Guide and the OAS Specification | |
| Organization Resource | ODS Organisation CodeSystem | ||||||||
| OrganisationCode | [nvarchar] | 12 | NOT NULL | The organisation or site code See Organisation/Site code descriptions for code formats per organisation type. | Code | Organisation.OrgId.extension | identifier.value (also id) | identifier.value (also id) | concept.code |
| OrgName | [nvarchar] | 100 | NOT NULL | Organisation Name The name of the entity/organisation. Wherever possible this will conform to any legally-defined value that exists. If this is not available the name will be provided by the Organisation the record identifies (or the owning Organisation, if the entity has a record class of 'Site'). | Name | Organisation.Name | name | name | concept.display |
| OrgTypeID | [nvarchar] | 20 | NOT NULL | Primary Role ID. Identifier for the primary role / organisation type of a code. Please refer to the Roles Reference Data Catalogue page for a full description. | Primary Role ID | Organisation.Roles.Role.id (where primaryRole = true) | Extension: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole | property.primaryRole, property.role | |
| OrgTypeName | [nvarchar] | 255 | NOT NULL | Primary Role/Organisation Type Name. Please refer to the Roles Reference Data Catalogue page for a full description. | Primary Role Name | OrganisationRole (CodeSystem) Roles.Role.displayName | Extension: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole | ||
| LegalStartDate | [nvarchar] | 8 | NULL | xs:date format YYYY-MM-DD Legal start date for an organisation (where provided and accepted for the organisation type), or the code start date if this is not known/provided to ODS. ODS often apply a default start date of 01/04/YY or 01/10/YY, whichever immediately precedes the date on which the code was requested. | Legal Start Date | Organisation.Date.Start (Where Organisation.Date.Type = Legal) | extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1 valuePeriod.start (Legal) | Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period Start: where Type=dateTime period.start (Legal) | property.legStartDate |
| LegalEndDate | [nvarchar] | 8 | NULL | xs:date format YYYY-MM-DD Legal end date for an organisation (where provided and accepted for the organisation type), or the code end date if this is not known/provided to ODS. ODS often apply a default end date which is the last day of the previous month in which the code closure request was received by ODS. | Legal End Date | Organisation.Date.End (Where Organisation.Date.Type = Legal) | extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1 valuePeriod.end (Legal) | Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period End: where Type=dateTime period.end (Legal) | property.legEndDate |
| OperationalStartDate | [nvarchar] | 8 | NULL | xs:date format YYYY-MM-DD Operational dates allow a code to be open / available to systems in advance of the legal start of an organisation, to support system configuration/set up etc | Operational Start Date | Organisation.Date.Start (Where Organisation.Date.Type = Operational) | extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1 valuePeriod.start (Operational) | Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period Start: where Type=dateTime period.start (Operational) | property.opStartDate |
| OperationalEndDate | [nvarchar] | 8 | NULL | xs:date format YYYY-MM-DD A code can remain operationally open for a period of time following legal closure to enable system migration/shut down. ODS aim to limit the period in which a code remains operationally open after legal closure to less than 6 months, but there are exceptions based on organisation/supplier constraints. | Operational End Date | Organisation.Date.End (Where Organisation.Date.Type = Operational) | extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1 valuePeriod.end (Operational) | Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period End: where Type=dateTime period.end (Operational) | property.opEndDate |
| AssigningAuthorityName | [nvarchar] | 100 | NOT NULL | Authority who masters the organisation coding range for the organisation type. | Not available | Organisation.OrgID. assigningAuthorityName | Not available | Not available | property.assigningAuth |
| LastChangeDate | [nvarchar] | 8 | NULL | xs:date format YYYY-MM-DD The date on which the record was last changed (created or amended). This date can be used by consumers to identify amended records since a point in time. | Last Changed | Organisation.LastChangeDate | meta.lastUpdated | Extension: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime> Code value="last-change-date" Display value="Last Change Date" valueDateTime | property.lastChangedDate |
| StatusName | [nvarchar] | 8 | NULL | ACTIVE, INACTIVE Status is derived from the operational start/end dates. A code must be legally and operationally closed to be INACTIVE. If an end date is in the future, the code will remain ACTIVE until that end date has passed. Each entity’s status is provided within the Organisation component as a quick way to identify active records apart from inactive ones. If you require the PROPOSED or DORMANT statuses for Prescribing Cost Centre codes then these can be found via the Organization and AdditionalAttributes CodeSystem (AATypeID = 8 (dormant), AATypeID = 9 (Proposed)) | Status | Organisation.Status | status (active) | status (active) | property.status (active/retired) |
| RecordClass | [nvarchar] | 8 | NULL | High level type/class of record published by ODS. Includes: RC1 (Organisation) or RC2 (Site) | Record Class | Organisation.orgRecordClass | type.coding.code type.coding.display | codesystem: ODSRecordClass | property.orgRecordClass |
| Record Use Type (RefOnly) | [nvarchar] | 8 | NOT NULL | refOnly or full The existence of relationships in the data allows an active record to reference a record that has been archived. In order to preserve a degree of referential integrity, a ‘skeleton’ version of archived records (i.e. with relationships and other content omitted) are published in the data. These are known as RefOnly records. | Ref Only | Organisation.refOnly | codesystem: England-ODSRecordUseType | property.refOnly | |
