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.

Other

SDS-Device

{
    "resourceType": "Device",
    "id": "f0f0e921-92ca-4a88-a550-2dbb36f703af",
    "extension":  [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ManagingOrganisation",
            "valueReference": {
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "T10101"
                },
                "display": "Some GP System provider"
            }
        }
    ],
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/nhsSpineASID",
            "value": "227319907548"
        },
        {
            "system": "https://fhir.nhs.uk/Id/nhsMhsPartyKey",
            "value": "R8008-0000806"
        },
        {
            "system": "https://fhir.nhs.uk/Id/nhsEndpointServiceId",
            "value": "urn:nhs:names:services:psis:REPC_IN150016UK05"
        }
    ],
    "owner": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "R8008"
        },
        "display": "Some GP Practice"
    }
}
<Device xmlns="http://hl7.org/fhir">
    <id value="f0f0e921-92ca-4a88-a550-2dbb36f703af" />
    <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ManagingOrganisation">
        <valueReference>
            <identifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="T10101" />
            </identifier>
            <display value="Some GP System provider" />
        </valueReference>
    </extension>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsSpineASID" />
        <value value="227319907548" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsMhsPartyKey" />
        <value value="R8008-0000806" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsEndpointServiceId" />
        <value value="urn:nhs:names:services:psis:REPC_IN150016UK05" />
    </identifier>
    <owner>
        <identifier>
            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
            <value value="R8008" />
        </identifier>
        <display value="Some GP Practice" />
    </owner>
</Device>
Device

SDS-Endpoint

{
    "resourceType": "Endpoint",
    "id": "f0f0e921-92ca-4a88-a550-2dbb36f703af",
    "extension":  [
        {
            "extension":  [
                {
                    "url": "nhsMHSSyncReplyMode",
                    "valueString": "MSHSignalsOnly"
                },
                {
                    "url": "nhsMHSRetryInterval",
                    "valueString": "PT1M"
                },
                {
                    "url": "nhsMHSRetries",
                    "valueInteger": 2
                },
                {
                    "url": "nhsMHSPersistDuration",
                    "valueString": "PT5M"
                },
                {
                    "url": "nhsMHSDuplicateElimination",
                    "valueString": "always"
                },
                {
                    "url": "nhsMHSAckRequested",
                    "valueString": "always"
                },
                {
                    "url": "nhsMHSActor",
                    "valueString": "ebs"
                }
            ],
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"
        }
    ],
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/nhsEndpointServiceId",
            "value": "urn:nhs:names:services:psis:REPC_IN150016UK05"
        },
        {
            "system": "https://fhir.nhs.uk/Id/nhsMhsFQDN",
            "value": "192.168.128.11"
        },
        {
            "system": "https://fhir.nhs.uk/Id/nhsMhsPartyKey",
            "value": "R8008-0000806"
        },
        {
            "system": "https://fhir.nhs.uk/Id/nhsMhsCPAId",
            "value": "S20001A000182"
        },
        {
            "system": "https://fhir.nhs.uk/Id/nhsSpineASID",
            "value": "227319907548"
        }
    ],
    "status": "active",
    "connectionType": {
        "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code": "hl7-fhir-msg",
        "display": "HL7 FHIR Messaging"
    },
    "managingOrganization": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "R8008"
        }
    },
    "payloadType":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
                    "code": "any",
                    "display": "Any"
                }
            ]
        }
    ],
    "address": "https://192.168.128.11/reliablemessaging/reliablerequest"
}
<Endpoint xmlns="http://hl7.org/fhir">
    <id value="f0f0e921-92ca-4a88-a550-2dbb36f703af" />
    <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration">
        <extension url="nhsMHSSyncReplyMode">
            <valueString value="MSHSignalsOnly" />
        </extension>
        <extension url="nhsMHSRetryInterval">
            <valueString value="PT1M" />
        </extension>
        <extension url="nhsMHSRetries">
            <valueInteger value="2" />
        </extension>
        <extension url="nhsMHSPersistDuration">
            <valueString value="PT5M" />
        </extension>
        <extension url="nhsMHSDuplicateElimination">
            <valueString value="always" />
        </extension>
        <extension url="nhsMHSAckRequested">
            <valueString value="always" />
        </extension>
        <extension url="nhsMHSActor">
            <valueString value="ebs" />
        </extension>
    </extension>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsEndpointServiceId" />
        <value value="urn:nhs:names:services:psis:REPC_IN150016UK05" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsMhsFQDN" />
        <value value="192.168.128.11" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsMhsPartyKey" />
        <value value="R8008-0000806" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsMhsCPAId" />
        <value value="S20001A000182" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhsSpineASID" />
        <value value="227319907548" />
    </identifier>
    <status value="active" />
    <connectionType>
        <system value="http://terminology.hl7.org/CodeSystem/endpoint-connection-type" />
        <code value="hl7-fhir-msg" />
        <display value="HL7 FHIR Messaging" />
    </connectionType>
    <managingOrganization>
        <identifier>
            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
            <value value="R8008" />
        </identifier>
    </managingOrganization>
    <payloadType>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/endpoint-payload-type" />
            <code value="any" />
            <display value="Any" />
        </coding>
    </payloadType>
    <address value="https://192.168.128.11/reliablemessaging/reliablerequest" />
</Endpoint>
Endpoint

Provenance

{
    "resourceType": "Provenance",
    "id": "28828C55-8FA7-42D7-916F-FCF076E0C10E",
    "target":  [
        {
            "type": "MedicationRequest",
            "identifier": {
                "system": "https://fhir.nhs.uk/Id/prescription-order-item-number",
                "value": "a54219b8-f741-4c47-b662-e4f8dfa49ab6"
            }
        }
    ],
    "recorded": "02/27/2008 11:38:00",
    "agent":  [
        {
            "who": {
                "identifier": {
                    "system": "https://fhir.hl7.org.uk/Id/gmc-number",
                    "value": "C9876543"
                }
            }
        }
    ],
    "signature":  [
        {
            "type":  [
                {
                    "system": "urn:iso-astm:E1762-95:2013",
                    "code": "1.2.840.10065.1.12.1.1"
                }
            ],
            "when": "02/27/2008 11:38:00",
            "who": {
                "reference": "urn:uuid:16708936-6397-4e03-b84f-4aaa790633e0"
            },
            "data": "PFNpZ25hdHVyZSB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnIyI+PFNpZ25lZEluZm8+PENhbm9uaWNhbGl6YXRpb25NZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzEwL3htbC1leGMtYzE0biMiLz48U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnI3JzYS1zaGExIi8+PFJlZmVyZW5jZT48VHJhbnNmb3Jtcz48VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8xMC94bWwtZXhjLWMxNG4jIi8+PC9UcmFuc2Zvcm1zPjxEaWdlc3RNZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5L3htbGRzaWcjc2hhMSIvPjxEaWdlc3RWYWx1ZT4zWWxGUU1PcncyUTBkVWt5dHpzNTBKRjdIVW89PC9EaWdlc3RWYWx1ZT48L1JlZmVyZW5jZT48L1NpZ25lZEluZm8+PFNpZ25hdHVyZVZhbHVlPlhwanNLWFBmVVc3MDhyR1B1T0FwaGxyNC9VQTIzZjNiaGRCT29jRUoxN0JYVjBKcnV6MUUxS0xGUXdxMzdFSmZuVm8vV0NMVFNqZ2sKa3AwQldqNWJHM0pqRWZqNzhaakkxeVZTUmJmYlZYWFFYMEdMWm1pU0dKcmhXbkZadDhjRnJ4TzFNRkF0U0xtS2Z5WEt6YnVIc0xUbQpzSFFLcFhDUmRabkZtS0JvakxtcDdOQnIwbExFOFBodHR1OEYyRWFldTJ3UFE4NHAxaU5XOTFmbzFIK1NGVnhDK0JSb1BJMXBvbFhnCjQyY2VUam9KNytGcVlQREhmQzduTkZJZ1RZSlpsUWRib01OYm5kdjZCUER1RnEwd3VzUWpEUTR6TVorOENscFJkdDNpS215bFhObUsKa0pBMTVXMHBGYkdxMFhuZjNTMU1YV0Vsa2FDSVVDZEdLMldzUEE9PTwvU2lnbmF0dXJlVmFsdWU+PEtleUluZm8+PFg1MDlEYXRhPjxYNTA5Q2VydGlmaWNhdGU+TUlJRUpEQ0NBd3lnQXdJQkFnSVVLM3hrRVVsUmhYUEpLTlZ3cnlxTFpSb05UUVF3RFFZSktvWklodmNOQVFFTEJRQXdSREVPTUF3RwpBMVVFQ2hNRlNGTkRTVU14RVRBUEJnTlZCQXNUQ0U5d1pXNTBaWE4wTVI4d0hRWURWUVFERXhaRlVGTWdUbTl1TFhKbGNIVmthV0YwCmFXOXVJRU5CTUI0WERUSXdNREl5TnpFek1EY3lNbG9YRFRJeU1ESXlOakV6TURjeU1sb3dPekVPTUF3R0ExVUVDaE1GU0ZORFNVTXgKR3pBWkJnTlZCQXNURWxOdmJIVjBhVzl1SUVGemMzVnlZVzVqWlRFTU1Bb0dBMVVFQXhNRFJVMVZNSUlCSWpBTkJna3Foa2lHOXcwQgpBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFwMEc0R2FjN1MwbXFsSFkvc1crRUZaWkw4QVUrRk1SclNGSWVmSVNvY0E2RHNIZVBnSHBnCjB0SmNkbWozTjQ1VlI2RkhEckt4NURnLzAwNVIvdDhnYnVJSEYraUkxcHVUY1Y5aldQbWFra3VybFZQQVJtaUF5NzY3V1BrOW1wVW8KbGZvSGRJTEtxZklXTXpRelc3QzRMOHZGSzU1QkllVjQvbElEdkVweForTEhXYmttay9oMWRXZXh1cGpPVGZxVG4vVWl4K0xhdDJUcApxellTck0wYmVwOHA4dWNuZE41c3FjbTZVa1BvdGhzeE5FaTJIamtkOGFvSDFINEtJVndnY0J3V2UrWHJMWEs1V2FyTVcwWTlxZ1FLCnhNc252VzhveUhhODNta0hZK2U4T2VOL1NucVlqa2FnMEk0cHZiQlRjbHJHZklTY0lmVFpvclZuMld2Q0lRSURBUUFCbzRJQkZUQ0MKQVJFd0NRWURWUjBUQkFJd0FEQU9CZ05WSFE4QkFmOEVCQU1DQmFBd0lBWURWUjBsQVFIL0JCWXdGQVlJS3dZQkJRVUhBd0VHQ0NzRwpBUVVGQndNQ01EWUdDV0NHU0FHRytFSUJEUVFwRmlkUGNHVnVkR1Z6ZERvZ1QzQmxibE5UVENCSFpXNWxjbUYwWldRZ1EyVnlkR2xtCmFXTmhkR1V3SFFZRFZSME9CQllFRkFINHB0Y2tPaHNVekJmVmp0L20wNUdpTzhYUk1Ic0dBMVVkSXdSME1IS0FGTklSdlg5b21ybDcKWlhTcUVJTnk2dzJyUFFkdW9VK2tUVEJMTVJRd0VnWURWUVFLRXd0T1NGTWdSR2xuYVhSaGJERVJNQThHQTFVRUN4TUlUM0JsYm5SbApjM1F4SURBZUJnTlZCQU1URjA5d1pXNTBaWE4wSUZKdmIzUWdRWFYwYUc5eWFYUjVnZ2tBNnUwY1hiTHFLb1F3RFFZSktvWklodmNOCkFRRUxCUUFEZ2dFQkFFRGNyUGNkcklDNXVmVkhyYTYyb0dCUC9sejVvSnEzUWw5M1BoZ3c5QkRidW1QVTc0UCtYZ1FvTzl2dzh4TzIKWWI0K1BMN00yQnVKbzNmRHFjRHNXKzRCNHQ5bWRoV1c3bFJqTjNXY3Vqb0xzbFB6MjNjZnl4Q2dabllNTURiT2hCckp4VkN6WWVDNgpueDZPaGtMMVYzWW9lK09JeXJSZVV6cHplQndzVVg1cTgwMmROYVYxeXJiNmFpMmljZ3hxcFkrZk9aWUZMUmVmUElxdXRCSzczaG5ECnV4RGpJKzdlaHlGcGFwZk9YVkJtTFRhY0x4TEYxRHkvNytHSVhiZEl3YmVkZXQ0cDJJY0VhUlgwZVdUMFUvL1pKU2VCcW5PT3BYbzYKNERmWnRTOVZsMmV4SGJISHFZYzBSVk5wS0ltYVdWck15ZEMxcU9leGpVWlNWQlZkK1pvPTwvWDUwOUNlcnRpZmljYXRlPjwvWDUwOURhdGE+PC9LZXlJbmZvPjwvU2lnbmF0dXJlPg=="
        }
    ]
}
<Provenance xmlns="http://hl7.org/fhir">
    <id value="28828C55-8FA7-42D7-916F-FCF076E0C10E" />
    <target>
        <type value="MedicationRequest" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/prescription-order-item-number" />
            <value value="a54219b8-f741-4c47-b662-e4f8dfa49ab6" />
        </identifier>
    </target>
    <recorded value="2008-02-27T11:38:00+00:00" />
    <agent>
        <who>
            <identifier>
                <system value="https://fhir.hl7.org.uk/Id/gmc-number" />
                <value value="C9876543" />
            </identifier>
        </who>
    </agent>
    <signature>
        <type>
            <system value="urn:iso-astm:E1762-95:2013" />
            <code value="1.2.840.10065.1.12.1.1" />
        </type>
        <when value="2008-02-27T11:38:00+00:00" />
        <who>
            <reference value="urn:uuid:16708936-6397-4e03-b84f-4aaa790633e0" />
        </who>
        <data value="PFNpZ25hdHVyZSB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnIyI+PFNpZ25lZEluZm8+PENhbm9uaWNhbGl6YXRpb25NZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzEwL3htbC1leGMtYzE0biMiLz48U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnI3JzYS1zaGExIi8+PFJlZmVyZW5jZT48VHJhbnNmb3Jtcz48VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8xMC94bWwtZXhjLWMxNG4jIi8+PC9UcmFuc2Zvcm1zPjxEaWdlc3RNZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5L3htbGRzaWcjc2hhMSIvPjxEaWdlc3RWYWx1ZT4zWWxGUU1PcncyUTBkVWt5dHpzNTBKRjdIVW89PC9EaWdlc3RWYWx1ZT48L1JlZmVyZW5jZT48L1NpZ25lZEluZm8+PFNpZ25hdHVyZVZhbHVlPlhwanNLWFBmVVc3MDhyR1B1T0FwaGxyNC9VQTIzZjNiaGRCT29jRUoxN0JYVjBKcnV6MUUxS0xGUXdxMzdFSmZuVm8vV0NMVFNqZ2sKa3AwQldqNWJHM0pqRWZqNzhaakkxeVZTUmJmYlZYWFFYMEdMWm1pU0dKcmhXbkZadDhjRnJ4TzFNRkF0U0xtS2Z5WEt6YnVIc0xUbQpzSFFLcFhDUmRabkZtS0JvakxtcDdOQnIwbExFOFBodHR1OEYyRWFldTJ3UFE4NHAxaU5XOTFmbzFIK1NGVnhDK0JSb1BJMXBvbFhnCjQyY2VUam9KNytGcVlQREhmQzduTkZJZ1RZSlpsUWRib01OYm5kdjZCUER1RnEwd3VzUWpEUTR6TVorOENscFJkdDNpS215bFhObUsKa0pBMTVXMHBGYkdxMFhuZjNTMU1YV0Vsa2FDSVVDZEdLMldzUEE9PTwvU2lnbmF0dXJlVmFsdWU+PEtleUluZm8+PFg1MDlEYXRhPjxYNTA5Q2VydGlmaWNhdGU+TUlJRUpEQ0NBd3lnQXdJQkFnSVVLM3hrRVVsUmhYUEpLTlZ3cnlxTFpSb05UUVF3RFFZSktvWklodmNOQVFFTEJRQXdSREVPTUF3RwpBMVVFQ2hNRlNGTkRTVU14RVRBUEJnTlZCQXNUQ0U5d1pXNTBaWE4wTVI4d0hRWURWUVFERXhaRlVGTWdUbTl1TFhKbGNIVmthV0YwCmFXOXVJRU5CTUI0WERUSXdNREl5TnpFek1EY3lNbG9YRFRJeU1ESXlOakV6TURjeU1sb3dPekVPTUF3R0ExVUVDaE1GU0ZORFNVTXgKR3pBWkJnTlZCQXNURWxOdmJIVjBhVzl1SUVGemMzVnlZVzVqWlRFTU1Bb0dBMVVFQXhNRFJVMVZNSUlCSWpBTkJna3Foa2lHOXcwQgpBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFwMEc0R2FjN1MwbXFsSFkvc1crRUZaWkw4QVUrRk1SclNGSWVmSVNvY0E2RHNIZVBnSHBnCjB0SmNkbWozTjQ1VlI2RkhEckt4NURnLzAwNVIvdDhnYnVJSEYraUkxcHVUY1Y5aldQbWFra3VybFZQQVJtaUF5NzY3V1BrOW1wVW8KbGZvSGRJTEtxZklXTXpRelc3QzRMOHZGSzU1QkllVjQvbElEdkVweForTEhXYmttay9oMWRXZXh1cGpPVGZxVG4vVWl4K0xhdDJUcApxellTck0wYmVwOHA4dWNuZE41c3FjbTZVa1BvdGhzeE5FaTJIamtkOGFvSDFINEtJVndnY0J3V2UrWHJMWEs1V2FyTVcwWTlxZ1FLCnhNc252VzhveUhhODNta0hZK2U4T2VOL1NucVlqa2FnMEk0cHZiQlRjbHJHZklTY0lmVFpvclZuMld2Q0lRSURBUUFCbzRJQkZUQ0MKQVJFd0NRWURWUjBUQkFJd0FEQU9CZ05WSFE4QkFmOEVCQU1DQmFBd0lBWURWUjBsQVFIL0JCWXdGQVlJS3dZQkJRVUhBd0VHQ0NzRwpBUVVGQndNQ01EWUdDV0NHU0FHRytFSUJEUVFwRmlkUGNHVnVkR1Z6ZERvZ1QzQmxibE5UVENCSFpXNWxjbUYwWldRZ1EyVnlkR2xtCmFXTmhkR1V3SFFZRFZSME9CQllFRkFINHB0Y2tPaHNVekJmVmp0L20wNUdpTzhYUk1Ic0dBMVVkSXdSME1IS0FGTklSdlg5b21ybDcKWlhTcUVJTnk2dzJyUFFkdW9VK2tUVEJMTVJRd0VnWURWUVFLRXd0T1NGTWdSR2xuYVhSaGJERVJNQThHQTFVRUN4TUlUM0JsYm5SbApjM1F4SURBZUJnTlZCQU1URjA5d1pXNTBaWE4wSUZKdmIzUWdRWFYwYUc5eWFYUjVnZ2tBNnUwY1hiTHFLb1F3RFFZSktvWklodmNOCkFRRUxCUUFEZ2dFQkFFRGNyUGNkcklDNXVmVkhyYTYyb0dCUC9sejVvSnEzUWw5M1BoZ3c5QkRidW1QVTc0UCtYZ1FvTzl2dzh4TzIKWWI0K1BMN00yQnVKbzNmRHFjRHNXKzRCNHQ5bWRoV1c3bFJqTjNXY3Vqb0xzbFB6MjNjZnl4Q2dabllNTURiT2hCckp4VkN6WWVDNgpueDZPaGtMMVYzWW9lK09JeXJSZVV6cHplQndzVVg1cTgwMmROYVYxeXJiNmFpMmljZ3hxcFkrZk9aWUZMUmVmUElxdXRCSzczaG5ECnV4RGpJKzdlaHlGcGFwZk9YVkJtTFRhY0x4TEYxRHkvNytHSVhiZEl3YmVkZXQ0cDJJY0VhUlgwZVdUMFUvL1pKU2VCcW5PT3BYbzYKNERmWnRTOVZsMmV4SGJISHFZYzBSVk5wS0ltYVdWck15ZEMxcU9leGpVWlNWQlZkK1pvPTwvWDUwOUNlcnRpZmljYXRlPjwvWDUwOURhdGE+PC9LZXlJbmZvPjwvU2lnbmF0dXJlPg==" />
    </signature>
</Provenance>
Provenance
back to top