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 4VE03

Important: This page is under development by NHS England

Tree View

Organization

id : ODS-Organization-4VE03-Example

extension

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

extension

url : instanceID

value : 32717

extension

url : roleCode

value

coding

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

code : RO171

display : PRIMARY CARE GROUP

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 : 1999-04-01

end : 2002-03-31

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 : 1999-04-01

end : 2002-03-31

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 : 2014-04-15

identifier

use : official

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

value : 4VE03

assigner

display : HSCIC

active : False

type

coding

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

code : RefOnly

display : RefOnly

type

coding

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

code : RC1

display : HSCOrg

name : HIGH WEALD PCG

address

line : ROTHER HOUSE

line : THE OFFICE VILLAGE, RIVER WAY

city : UCKFIELD

district : EAST SUSSEX

postalCode : TN22 1SL

country : ENGLAND

Table View

Organization.id[0]	ODS-Organization-4VE03-Example
Organization.extension[0].extension[0].url[0]	instanceID
Organization.extension[0].extension[0].value[0]	32717
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]	RO171
Organization.extension[0].extension[1].value[0].coding[0].display[0]	PRIMARY CARE GROUP
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]	1999-04-01
Organization.extension[0].extension[2].extension[1].value[0].end[0]	2002-03-31
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]	1999-04-01
Organization.extension[0].extension[3].extension[1].value[0].end[0]	2002-03-31
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]	2014-04-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]	4VE03
Organization.identifier[0].assigner[0].display[0]	HSCIC
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]	RefOnly
Organization.type[0].coding[0].display[0]	RefOnly
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]	HIGH WEALD PCG
Organization.address[0].line[0]	ROTHER HOUSE
Organization.address[0].line[1]	THE OFFICE VILLAGE, RIVER WAY
Organization.address[0].city[0]	UCKFIELD
Organization.address[0].district[0]	EAST SUSSEX
Organization.address[0].postalCode[0]	TN22 1SL
Organization.address[0].country[0]	ENGLAND

XML View

<Organization xmlns="http://hl7.org/fhir">
    <id value="ODS-Organization-4VE03-Example" />
    <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole">
        <extension url="instanceID">
            <valueInteger value="32717" />
        </extension>
        <extension url="roleCode">
            <valueCodeableConcept>
                <coding>
                    <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole" />
                    <code value="RO171" />
                    <display value="PRIMARY CARE GROUP" />
                </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="1999-04-01" />
                    <end value="2002-03-31" />
                </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="1999-04-01" />
                    <end value="2002-03-31" />
                </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="2014-04-15" />
        </extension>
    </extension>
    <identifier>
        <use value="official" />
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="4VE03" />
        <assigner>
            <display value="HSCIC" />
        </assigner>
    </identifier>
    <active value="false" />
    <type>
        <coding>
            <system value="https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType" />
            <code value="RefOnly" />
            <display value="RefOnly" />
        </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="HIGH WEALD PCG" />
    <address>
        <line value="ROTHER HOUSE" />
        <line value="THE OFFICE VILLAGE, RIVER WAY" />
        <city value="UCKFIELD" />
        <district value="EAST SUSSEX" />
        <postalCode value="TN22 1SL" />
        <country value="ENGLAND" />
    </address>
</Organization>

JSON View

{
    "resourceType": "Organization",
    "id": "ODS-Organization-4VE03-Example",
    "extension":  [
        {
            "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole",
            "extension":  [
                {
                    "url": "instanceID",
                    "valueInteger": 32717
                },
                {
                    "url": "roleCode",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole",
                                "code": "RO171",
                                "display": "PRIMARY CARE GROUP"
                            }
                        ]
                    }
                },
                {
                    "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": "1999-04-01",
                                "end": "2002-03-31"
                            }
                        }
                    ]
                },
                {
                    "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": "1999-04-01",
                                "end": "2002-03-31"
                            }
                        }
                    ]
                },
                {
                    "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": "2014-04-15"
                }
            ]
        }
    ],
    "identifier":  [
        {
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "4VE03",
            "assigner": {
                "display": "HSCIC"
            }
        }
    ],
    "active": false,
    "type":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType",
                    "code": "RefOnly",
                    "display": "RefOnly"
                }
            ]
        },
        {
            "coding":  [
                {
                    "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass",
                    "code": "RC1",
                    "display": "HSCOrg"
                }
            ]
        }
    ],
    "name": "HIGH WEALD PCG",
    "address":  [
        {
            "line":  [
                "ROTHER HOUSE",
                "THE OFFICE VILLAGE, RIVER WAY"
            ],
            "city": "UCKFIELD",
            "district": "EAST SUSSEX",
            "postalCode": "TN22 1SL",
            "country": "ENGLAND"
        }
    ]
}