NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available.

Organization

Leeds Teaching Trust

{
    "resourceType": "Organization",
    "id": "RR8",
    "extension":  [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships",
            "extension":  [
                {
                    "url": "highLevelHealthGeography",
                    "valueIdentifier": {
                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                        "value": "QWO"
                    }
                }
            ]
        }
    ],
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR8"
        }
    ],
    "active": true,
    "type":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role",
                    "extension":  [
                        {
                            "url": "primaryRole",
                            "valueBoolean": true
                        },
                        {
                            "url": "status",
                            "valueString": "Active"
                        }
                    ]
                },
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod",
                    "extension":  [
                        {
                            "url": "activePeriod",
                            "valuePeriod": {
                                "start": "1998-04-01"
                            }
                        },
                        {
                            "url": "dateType",
                            "valueString": "Operational"
                        }
                    ]
                }
            ],
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
                    "code": "197",
                    "display": "NHS TRUST"
                }
            ]
        }
    ],
    "name": "LEEDS TEACHING HOSPITALS NHS TRUST",
    "telecom":  [
        {
            "system": "fax",
            "value": "0113 242 6496",
            "use": "work"
        },
        {
            "system": "phone",
            "value": "0113 243 3144",
            "use": "work"
        }
    ],
    "address":  [
        {
            "line":  [
                "ST. JAMES'S UNIVERSITY HOSPITAL",
                "BECKETT STREET"
            ],
            "city": "LEEDS",
            "district": "WEST YORKSHIRE",
            "postalCode": "LS9 7TF",
            "country": "ENGLAND"
        }
    ]
}
<Organization xmlns="http://hl7.org/fhir">
    <id value="RR8" />
    <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships">
        <extension url="highLevelHealthGeography">
            <valueIdentifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="QWO" />
            </valueIdentifier>
        </extension>
    </extension>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="RR8" />
    </identifier>
    <active value="true" />
    <type>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role">
            <extension url="primaryRole">
                <valueBoolean value="true" />
            </extension>
            <extension url="status">
                <valueString value="Active" />
            </extension>
        </extension>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod">
            <extension url="activePeriod">
                <valuePeriod>
                    <start value="1998-04-01" />
                </valuePeriod>
            </extension>
            <extension url="dateType">
                <valueString value="Operational" />
            </extension>
        </extension>
        <coding>
            <system value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
            <code value="197" />
            <display value="NHS TRUST" />
        </coding>
    </type>
    <name value="LEEDS TEACHING HOSPITALS NHS TRUST" />
    <telecom>
        <system value="fax" />
        <value value="0113 242 6496" />
        <use value="work" />
    </telecom>
    <telecom>
        <system value="phone" />
        <value value="0113 243 3144" />
        <use value="work" />
    </telecom>
    <address>
        <line value="ST. JAMES&#39;S UNIVERSITY HOSPITAL" />
        <line value="BECKETT STREET" />
        <city value="LEEDS" />
        <district value="WEST YORKSHIRE" />
        <postalCode value="LS9 7TF" />
        <country value="ENGLAND" />
    </address>
</Organization>
Organization

NHS Nightingale Hospital Yorkshire and the Humber

{
    "resourceType": "Location",
    "id": "RR805",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-site-code",
            "value": "RR805"
        }
    ],
    "status": "active",
    "type":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role",
                    "extension":  [
                        {
                            "url": "primaryRole",
                            "valueBoolean": true
                        },
                        {
                            "url": "status",
                            "valueString": "Active"
                        }
                    ]
                },
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod",
                    "extension":  [
                        {
                            "url": "activePeriod",
                            "valuePeriod": {
                                "start": "2020-04-01"
                            }
                        },
                        {
                            "url": "dateType",
                            "valueString": "Operational"
                        }
                    ]
                }
            ],
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
                    "code": "198",
                    "display": "NHS TRUST SITE"
                }
            ]
        }
    ],
    "name": "NHS NIGHTINGALE HOSPITAL YORKSHIRE AND THE HUMBER",
    "address": {
        "line":  [
            "KINGS ROAD"
        ],
        "city": "HARROGATE",
        "postalCode": "HG1 5LA",
        "country": "ENGLAND"
    },
    "managingOrganization": {
        "reference": "https://directory.spineservices.nhs.uk/R4/Organization/RR8",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RR8"
        },
        "display": "Leeds Teaching NHS Trusts"
    }
}
<Location xmlns="http://hl7.org/fhir">
    <id value="RR805" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-site-code" />
        <value value="RR805" />
    </identifier>
    <status value="active" />
    <name value="NHS NIGHTINGALE HOSPITAL YORKSHIRE AND THE HUMBER" />
    <type>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role">
            <extension url="primaryRole">
                <valueBoolean value="true" />
            </extension>
            <extension url="status">
                <valueString value="Active" />
            </extension>
        </extension>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod">
            <extension url="activePeriod">
                <valuePeriod>
                    <start value="2020-04-01" />
                </valuePeriod>
            </extension>
            <extension url="dateType">
                <valueString value="Operational" />
            </extension>
        </extension>
        <coding>
            <system value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
            <code value="198" />
            <display value="NHS TRUST SITE" />
        </coding>
    </type>
    <address>
        <line value="KINGS ROAD" />
        <city value="HARROGATE" />
        <postalCode value="HG1 5LA" />
        <country value="ENGLAND" />
    </address>
    <managingOrganization>
        <reference value="https://directory.spineservices.nhs.uk/R4/Organization/RR8" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
            <value value="RR8" />
        </identifier>
        <display value="Leeds Teaching NHS Trusts" />
    </managingOrganization>
</Location>
Location

Leeds CCG

{
    "resourceType": "Organization",
    "id": "15F",
    "extension":  [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships",
            "extension":  [
                {
                    "url": "nationalGrouping",
                    "valueIdentifier": {
                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                        "value": "Q72"
                    }
                }
            ]
        }
    ],
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "15F"
        }
    ],
    "active": true,
    "type":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role",
                    "extension":  [
                        {
                            "url": "primaryRole",
                            "valueBoolean": true
                        },
                        {
                            "url": "status",
                            "valueString": "Active"
                        }
                    ]
                },
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod",
                    "extension":  [
                        {
                            "url": "activePeriod",
                            "valuePeriod": {
                                "start": "2017-12-12"
                            }
                        },
                        {
                            "url": "dateType",
                            "valueString": "Operational"
                        }
                    ]
                },
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod",
                    "extension":  [
                        {
                            "url": "activePeriod",
                            "valuePeriod": {
                                "start": "2018-04-01"
                            }
                        },
                        {
                            "url": "dateType",
                            "valueString": "Legal"
                        }
                    ]
                }
            ],
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
                    "code": "98",
                    "display": "CLINICAL COMMISSIONING GROUP"
                }
            ]
        }
    ],
    "name": "NHS LEEDS CCG",
    "address":  [
        {
            "line":  [
                "SUITES 2 - 4 WIRA HOUSE",
                "RING ROAD",
                "WEST PARK"
            ],
            "city": "LEEDS",
            "district": "WEST YORKSHIRE",
            "postalCode": "LS16 6EB",
            "country": "ENGLAND"
        }
    ]
}
<Organization xmlns="http://hl7.org/fhir">
    <id value="15F" />
    <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships">
        <extension url="nationalGrouping">
            <valueIdentifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="Q72" />
            </valueIdentifier>
        </extension>
    </extension>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="15F" />
    </identifier>
    <active value="true" />
    <type>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role">
            <extension url="primaryRole">
                <valueBoolean value="true" />
            </extension>
            <extension url="status">
                <valueString value="Active" />
            </extension>
        </extension>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod">
            <extension url="activePeriod">
                <valuePeriod>
                    <start value="2017-12-12" />
                </valuePeriod>
            </extension>
            <extension url="dateType">
                <valueString value="Operational" />
            </extension>
        </extension>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod">
            <extension url="activePeriod">
                <valuePeriod>
                    <start value="2018-04-01" />
                </valuePeriod>
            </extension>
            <extension url="dateType">
                <valueString value="Legal" />
            </extension>
        </extension>
        <coding>
            <system value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
            <code value="98" />
            <display value="CLINICAL COMMISSIONING GROUP" />
        </coding>
    </type>
    <name value="NHS LEEDS CCG" />
    <address>
        <line value="SUITES 2 - 4 WIRA HOUSE" />
        <line value="RING ROAD" />
        <line value="WEST PARK" />
        <city value="LEEDS" />
        <district value="WEST YORKSHIRE" />
        <postalCode value="LS16 6EB" />
        <country value="ENGLAND" />
    </address>
</Organization>
Organization

The Swan Medical Centre

{
    "resourceType": "Organization",
    "id": "17c4270d-6966-4788-8cbc-1d1d63536b25",
    "extension":  [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships",
            "extension":  [
                {
                    "url": "commissionedBy",
                    "valueIdentifier": {
                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                        "value": "15E"
                    }
                },
                {
                    "url": "primaryCareNetwork",
                    "valueIdentifier": {
                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                        "value": "U46437"
                    }
                }
            ]
        }
    ],
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "M85011"
        }
    ],
    "active": true,
    "type":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
                    "code": "76",
                    "display": "GP PRACTICE"
                }
            ]
        },
        {
            "extension":  [
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role",
                    "extension":  [
                        {
                            "url": "primaryRole",
                            "valueBoolean": false
                        },
                        {
                            "url": "status",
                            "valueString": "Active"
                        }
                    ]
                },
                {
                    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod",
                    "extension":  [
                        {
                            "url": "activePeriod",
                            "valuePeriod": {
                                "start": "2014-04-15"
                            }
                        },
                        {
                            "url": "dateType",
                            "valueString": "Operational"
                        }
                    ]
                }
            ],
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
                    "code": "76",
                    "display": "GP PRACTICE"
                }
            ]
        }
    ],
    "name": "THE SWAN MEDICAL CENTRE",
    "telecom":  [
        {
            "system": "phone",
            "value": "0121 7060337"
        }
    ],
    "address":  [
        {
            "line":  [
                "4 WILLARD RD",
                "SOUTH YARDLEY"
            ],
            "city": "BIRMINGHAM",
            "district": "WEST MIDLANDS",
            "postalCode": "B25 8AA",
            "country": "ENGLAND"
        }
    ]
}
<Organization xmlns="http://hl7.org/fhir">
    <id value="17c4270d-6966-4788-8cbc-1d1d63536b25" />
    <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships">
        <extension url="commissionedBy">
            <valueIdentifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="15E" />
            </valueIdentifier>
        </extension>
        <extension url="primaryCareNetwork">
            <valueIdentifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="U46437" />
            </valueIdentifier>
        </extension>
    </extension>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="M85011" />
    </identifier>
    <active value="true" />
    <type>
        <coding>
            <system value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
            <code value="76" />
            <display value="GP PRACTICE" />
        </coding>
    </type>
    <type>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role">
            <extension url="primaryRole">
                <valueBoolean value="false" />
            </extension>
            <extension url="status">
                <valueString value="Active" />
            </extension>
        </extension>
        <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod">
            <extension url="activePeriod">
                <valuePeriod>
                    <start value="2014-04-15" />
                </valuePeriod>
            </extension>
            <extension url="dateType">
                <valueString value="Operational" />
            </extension>
        </extension>
        <coding>
            <system value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
            <code value="76" />
            <display value="GP PRACTICE" />
        </coding>
    </type>
    <name value="THE SWAN MEDICAL CENTRE" />
    <telecom>
        <system value="phone" />
        <value value="0121 7060337" />
    </telecom>
    <address>
        <line value="4 WILLARD RD" />
        <line value="SOUTH YARDLEY" />
        <city value="BIRMINGHAM" />
        <district value="WEST MIDLANDS" />
        <postalCode value="B25 8AA" />
        <country value="ENGLAND" />
    </address>
</Organization>
Organization

HMP Leeds

{
    "resourceType": "Organization",
    "id": "YDE47",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "YDE47"
        }
    ],
    "active": true,
    "type":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
                    "code": "175",
                    "display": "PRISON"
                }
            ]
        }
    ],
    "name": "HMP LEEDS",
    "address":  [
        {
            "line":  [
                "GLOUCESTER TERRACE",
                "ARMLEY"
            ],
            "city": "LEEDS",
            "district": "WEST YORKSHIRE",
            "postalCode": "LS12 2TJ",
            "country": "ENGLAND"
        }
    ]
}
<Organization xmlns="http://hl7.org/fhir">
    <id value="YDE47" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
        <value value="YDE47" />
    </identifier>
    <active value="true" />
    <type>
        <coding>
            <system value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
            <code value="175" />
            <display value="PRISON" />
        </coding>
    </type>
    <name value="HMP LEEDS" />
    <address>
        <line value="GLOUCESTER TERRACE" />
        <line value="ARMLEY" />
        <city value="LEEDS" />
        <district value="WEST YORKSHIRE" />
        <postalCode value="LS12 2TJ" />
        <country value="ENGLAND" />
    </address>
</Organization>
Organization
back to top