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 - OrganizationAffiliation 383689

Important: This page is under development by NHS England

Tree View

OrganizationAffiliation

id : ODS-OrganizationAffiliation-383689-Example

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 : 2015-05-11

end : 2020-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 : 2015-05-11

end : 2020-03-31

identifier

system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance

value : 383689

active : False

period

start : 2015-05-11

end : 2020-03-31

organization

reference : Organization/ODS-Organization-FDC49-Example

identifier

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

value : FDC49

participatingOrganization

reference : Organization/ODS-Organization-Q72-Example

identifier

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

value : Q72

code

coding

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

code : RE5

display : IS LOCATED IN THE GEOGRAPHY OF

Table View

OrganizationAffiliation.id[0]	ODS-OrganizationAffiliation-383689-Example
OrganizationAffiliation.extension[0].extension[0].url[0]	dateType
OrganizationAffiliation.extension[0].extension[0].value[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
OrganizationAffiliation.extension[0].extension[0].value[0].code[0]	Legal
OrganizationAffiliation.extension[0].extension[0].value[0].display[0]	Legal
OrganizationAffiliation.extension[0].extension[1].url[0]	period
OrganizationAffiliation.extension[0].extension[1].value[0].start[0]	2015-05-11
OrganizationAffiliation.extension[0].extension[1].value[0].end[0]	2020-03-31
OrganizationAffiliation.extension[0].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
OrganizationAffiliation.extension[1].extension[0].url[0]	dateType
OrganizationAffiliation.extension[1].extension[0].value[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
OrganizationAffiliation.extension[1].extension[0].value[0].code[0]	Operational
OrganizationAffiliation.extension[1].extension[0].value[0].display[0]	Operational
OrganizationAffiliation.extension[1].extension[1].url[0]	period
OrganizationAffiliation.extension[1].extension[1].value[0].start[0]	2015-05-11
OrganizationAffiliation.extension[1].extension[1].value[0].end[0]	2020-03-31
OrganizationAffiliation.extension[1].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
OrganizationAffiliation.identifier[0].system[0]	https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance
OrganizationAffiliation.identifier[0].value[0]	383689
OrganizationAffiliation.active[0]	False
OrganizationAffiliation.period[0].start[0]	2015-05-11
OrganizationAffiliation.period[0].end[0]	2020-03-31
OrganizationAffiliation.organization[0].reference[0]	Organization/ODS-Organization-FDC49-Example
OrganizationAffiliation.organization[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
OrganizationAffiliation.organization[0].identifier[0].value[0]	FDC49
OrganizationAffiliation.participatingOrganization[0].reference[0]	Organization/ODS-Organization-Q72-Example
OrganizationAffiliation.participatingOrganization[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
OrganizationAffiliation.participatingOrganization[0].identifier[0].value[0]	Q72
OrganizationAffiliation.code[0].coding[0].system[0]	https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship
OrganizationAffiliation.code[0].coding[0].code[0]	RE5
OrganizationAffiliation.code[0].coding[0].display[0]	IS LOCATED IN THE GEOGRAPHY OF

XML View

<OrganizationAffiliation xmlns="http://hl7.org/fhir">
    <id value="ODS-OrganizationAffiliation-383689-Example" />
    <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="2015-05-11" />
                <end value="2020-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="2015-05-11" />
                <end value="2020-03-31" />
            </valuePeriod>
        </extension>
    </extension>
    <identifier>
        <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance" />
        <value value="383689" />
    </identifier>
    <active value="false" />
    <period>
        <start value="2015-05-11" />
        <end value="2020-03-31" />
    </period>
    <organization>
        <reference value="Organization/ODS-Organization-FDC49-Example" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
            <value value="FDC49" />
        </identifier>
    </organization>
    <participatingOrganization>
        <reference value="Organization/ODS-Organization-Q72-Example" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
            <value value="Q72" />
        </identifier>
    </participatingOrganization>
    <code>
        <coding>
            <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship" />
            <code value="RE5" />
            <display value="IS LOCATED IN THE GEOGRAPHY OF" />
        </coding>
    </code>
</OrganizationAffiliation>

JSON View

{
    "resourceType": "OrganizationAffiliation",
    "id": "ODS-OrganizationAffiliation-383689-Example",
    "extension":  [
        {
            "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": "2015-05-11",
                        "end": "2020-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": "2015-05-11",
                        "end": "2020-03-31"
                    }
                }
            ]
        }
    ],
    "identifier":  [
        {
            "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance",
            "value": "383689"
        }
    ],
    "active": false,
    "period": {
        "start": "2015-05-11",
        "end": "2020-03-31"
    },
    "organization": {
        "reference": "Organization/ODS-Organization-FDC49-Example",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "FDC49"
        }
    },
    "participatingOrganization": {
        "reference": "Organization/ODS-Organization-Q72-Example",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "Q72"
        }
    },
    "code":  [
        {
            "coding":  [
                {
                    "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship",
                    "code": "RE5",
                    "display": "IS LOCATED IN THE GEOGRAPHY OF"
                }
            ]
        }
    ]
}