Organisation Data Service (ODS) Implementation Guide

WARNING

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

This site is provided for information only and it is advised not to develop against these specifications until a formal announcement has been made.

For more information, see the ODS Roadmap

Example - Organization FCE71

Important: This page is under development by NHS England

Tree View

Organization

id : ODS-Organization-FCE71-Example

extension

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole

extension

url : instanceID

value : 214621

extension

url : roleCode

value

coding

system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole

code : RO182

display : PHARMACY

extension

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod

extension

url : dateType

value

system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType

code : Legal

display : Legal

extension

url : period

value

start : 1948-01-01

end : 2023-04-23

extension

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod

extension

url : dateType

value

system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType

code : Operational

display : Operational

extension

url : period

value

start : 1948-01-01

end : 2023-04-23

extension

url : active

value : False

extension

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime

extension

url : type

value

system : https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime

code : LastChangeDate

display : Last Change Date

extension

url : dateTime

value : 2024-01-15

identifier

use : official

system : https://fhir.nhs.uk/Id/ods-organization-code

value : FCE71

assigner

display : NHS BUSINESS SERVICES AUTHORITY

active : False

type

coding

system : https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType

code : Full

display : Full

type

coding

system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass

code : RC1

display : HSCOrg

name : LLOYDS PHARMACY

telecom

system : phone

value : 01922 646521

address

extension

url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey

extension

url : type

value

coding

system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType

code : UPRN

display : Unique Property Reference Number

extension

url : value

value : 100071066809

line : DARTMOUTH STATIONERS

line : 126 LICHFIELD STREET

city : WALSALL

district : WEST MIDLANDS

postalCode : WS1 1SY

country : ENGLAND

Table View

Organization.id[0]	ODS-Organization-FCE71-Example
Organization.extension[0].extension[0].url[0]	instanceID
Organization.extension[0].extension[0].value[0]	214621
Organization.extension[0].extension[1].url[0]	roleCode
Organization.extension[0].extension[1].value[0].coding[0].system[0]	https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole
Organization.extension[0].extension[1].value[0].coding[0].code[0]	RO182
Organization.extension[0].extension[1].value[0].coding[0].display[0]	PHARMACY
Organization.extension[0].extension[2].extension[0].url[0]	dateType
Organization.extension[0].extension[2].extension[0].value[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
Organization.extension[0].extension[2].extension[0].value[0].code[0]	Legal
Organization.extension[0].extension[2].extension[0].value[0].display[0]	Legal
Organization.extension[0].extension[2].extension[1].url[0]	period
Organization.extension[0].extension[2].extension[1].value[0].start[0]	1948-01-01
Organization.extension[0].extension[2].extension[1].value[0].end[0]	2023-04-23
Organization.extension[0].extension[2].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
Organization.extension[0].extension[3].extension[0].url[0]	dateType
Organization.extension[0].extension[3].extension[0].value[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
Organization.extension[0].extension[3].extension[0].value[0].code[0]	Operational
Organization.extension[0].extension[3].extension[0].value[0].display[0]	Operational
Organization.extension[0].extension[3].extension[1].url[0]	period
Organization.extension[0].extension[3].extension[1].value[0].start[0]	1948-01-01
Organization.extension[0].extension[3].extension[1].value[0].end[0]	2023-04-23
Organization.extension[0].extension[3].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
Organization.extension[0].extension[4].url[0]	active
Organization.extension[0].extension[4].value[0]	False
Organization.extension[0].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole
Organization.extension[1].extension[0].url[0]	type
Organization.extension[1].extension[0].value[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime
Organization.extension[1].extension[0].value[0].code[0]	LastChangeDate
Organization.extension[1].extension[0].value[0].display[0]	Last Change Date
Organization.extension[1].extension[1].url[0]	dateTime
Organization.extension[1].extension[1].value[0]	2024-01-15
Organization.extension[1].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime
Organization.identifier[0].use[0]	official
Organization.identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Organization.identifier[0].value[0]	FCE71
Organization.identifier[0].assigner[0].display[0]	NHS BUSINESS SERVICES AUTHORITY
Organization.active[0]	False
Organization.type[0].coding[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType
Organization.type[0].coding[0].code[0]	Full
Organization.type[0].coding[0].display[0]	Full
Organization.type[1].coding[0].system[0]	https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass
Organization.type[1].coding[0].code[0]	RC1
Organization.type[1].coding[0].display[0]	HSCOrg
Organization.name[0]	LLOYDS PHARMACY
Organization.telecom[0].system[0]	phone
Organization.telecom[0].value[0]	01922 646521
Organization.address[0].extension[0].extension[0].url[0]	type
Organization.address[0].extension[0].extension[0].value[0].coding[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType
Organization.address[0].extension[0].extension[0].value[0].coding[0].code[0]	UPRN
Organization.address[0].extension[0].extension[0].value[0].coding[0].display[0]	Unique Property Reference Number
Organization.address[0].extension[0].extension[1].url[0]	value
Organization.address[0].extension[0].extension[1].value[0]	100071066809
Organization.address[0].extension[0].url[0]	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
Organization.address[0].line[0]	DARTMOUTH STATIONERS
Organization.address[0].line[1]	126 LICHFIELD STREET
Organization.address[0].city[0]	WALSALL
Organization.address[0].district[0]	WEST MIDLANDS
Organization.address[0].postalCode[0]	WS1 1SY
Organization.address[0].country[0]	ENGLAND

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="ODS-Organization-FCE71-Example" />
    <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole">
        <extension url="instanceID">
            <valueInteger value="214621" />
        </extension>
        <extension url="roleCode">
            <valueCodeableConcept>
                <coding>
                    <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole" />
                    <code value="RO182" />
                    <display value="PHARMACY" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod">
            <extension url="dateType">
                <valueCoding>
                    <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" />
                    <code value="Legal" />
                    <display value="Legal" />
                </valueCoding>
            </extension>
            <extension url="period">
                <valuePeriod>
                    <start value="1948-01-01" />
                    <end value="2023-04-23" />
                </valuePeriod>
            </extension>
        </extension>
        <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod">
            <extension url="dateType">
                <valueCoding>
                    <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" />
                    <code value="Operational" />
                    <display value="Operational" />
                </valueCoding>
            </extension>
            <extension url="period">
                <valuePeriod>
                    <start value="1948-01-01" />
                    <end value="2023-04-23" />
                </valuePeriod>
            </extension>
        </extension>
        <extension url="active">
            <valueBoolean value="false" />
        </extension>
    </extension>
    <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime">
        <extension url="type">
            <valueCoding>
                <system value="https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime" />
                <code value="LastChangeDate" />
                <display value="Last Change Date" />
            </valueCoding>
        </extension>
        <extension url="dateTime">
            <valueDateTime value="2024-01-15" />
        </extension>
    </extension>
    <identifier>
        <use value="official" />
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="FCE71" />
        <assigner>
            <display value="NHS BUSINESS SERVICES AUTHORITY" />
        </assigner>
    </identifier>
    <active value="false" />
    <type>
        <coding>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType" />
            <code value="Full" />
            <display value="Full" />
        </coding>
    </type>
    <type>
        <coding>
            <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass" />
            <code value="RC1" />
            <display value="HSCOrg" />
        </coding>
    </type>
    <name value="LLOYDS PHARMACY" />
    <telecom>
        <system value="phone" />
        <value value="01922 646521" />
    </telecom>
    <address>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
            <extension url="type">
                <valueCodeableConcept>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
                        <code value="UPRN" />
                        <display value="Unique Property Reference Number" />
                    </coding>
                </valueCodeableConcept>
            </extension>
            <extension url="value">
                <valueString value="100071066809" />
            </extension>
        </extension>
        <line value="DARTMOUTH STATIONERS" />
        <line value="126 LICHFIELD STREET" />
        <city value="WALSALL" />
        <district value="WEST MIDLANDS" />
        <postalCode value="WS1 1SY" />
        <country value="ENGLAND" />
    </address>
</Organization>

JSON View

{
    "resourceType": "Organization",
    "id": "ODS-Organization-FCE71-Example",
    "extension":  [
        {
            "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole",
            "extension":  [
                {
                    "url": "instanceID",
                    "valueInteger": 214621
                },
                {
                    "url": "roleCode",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole",
                                "code": "RO182",
                                "display": "PHARMACY"
                            }
                        ]
                    }
                },
                {
                    "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod",
                    "extension":  [
                        {
                            "url": "dateType",
                            "valueCoding": {
                                "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType",
                                "code": "Legal",
                                "display": "Legal"
                            }
                        },
                        {
                            "url": "period",
                            "valuePeriod": {
                                "start": "1948-01-01",
                                "end": "2023-04-23"
                            }
                        }
                    ]
                },
                {
                    "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod",
                    "extension":  [
                        {
                            "url": "dateType",
                            "valueCoding": {
                                "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType",
                                "code": "Operational",
                                "display": "Operational"
                            }
                        },
                        {
                            "url": "period",
                            "valuePeriod": {
                                "start": "1948-01-01",
                                "end": "2023-04-23"
                            }
                        }
                    ]
                },
                {
                    "url": "active",
                    "valueBoolean": false
                }
            ]
        },
        {
            "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime",
            "extension":  [
                {
                    "url": "type",
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime",
                        "code": "LastChangeDate",
                        "display": "Last Change Date"
                    }
                },
                {
                    "url": "dateTime",
                    "valueDateTime": "2024-01-15"
                }
            ]
        }
    ],
    "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "FCE71",
            "assigner": {
                "display": "NHS BUSINESS SERVICES AUTHORITY"
            }
        }
    ],
    "active": false,
    "type":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType",
                    "code": "Full",
                    "display": "Full"
                }
            ]
        },
        {
            "coding":  [
                {
                    "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass",
                    "code": "RC1",
                    "display": "HSCOrg"
                }
            ]
        }
    ],
    "name": "LLOYDS PHARMACY",
    "telecom":  [
        {
            "system": "phone",
            "value": "01922 646521"
        }
    ],
    "address":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey",
                    "extension":  [
                        {
                            "url": "type",
                            "valueCodeableConcept": {
                                "coding":  [
                                    {
                                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                                        "code": "UPRN",
                                        "display": "Unique Property Reference Number"
                                    }
                                ]
                            }
                        },
                        {
                            "url": "value",
                            "valueString": "100071066809"
                        }
                    ]
                }
            ],
            "line":  [
                "DARTMOUTH STATIONERS",
                "126 LICHFIELD STREET"
            ],
            "city": "WALSALL",
            "district": "WEST MIDLANDS",
            "postalCode": "WS1 1SY",
            "country": "ENGLAND"
        }
    ]
}