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.

CapabilityStatement

CapabilityStatement

uri
https://fhir.nhs.uk/CapabilityStatement/nhsdigital-requirements

REST Capabilities Server

ModeServer

Security

ServiceOAuth2 Token

Resource Interactions

Resource TypeProfileSupported Profiles
Accounthttps://fhir.nhs.uk/StructureDefinition/NHSDigital-Account
AllergyIntolerance
AppointmentNHSDigitalAppointment
BinaryNHSDigitalBinary
CapabilityStatementNHSDigitalCapabilityStatement
Condition
ClaimNHSDigitalClaim
CommunicationRequestNHSDigitalCommunicationRequest
EncounterNHSDigitalEncounter
DocumentReferenceNHSDigitalDocumentReference
FlagNHSDigitalFlag
HealthcareServiceNHSDigitalHealthcareService
ImmunizationNHSDigitalImmunization
LocationNHSDigitalLocation
List
MedicationAdministration
MedicationRequestNHSDigitalMedicationRequest
MedicationDispenseNHSDigitalMedicationDispense
MedicationNHSDigitalMedication
MedicationStatementNHSDigitalMedicationStatement
MessageDefinitionNHSDigitalMessageDefinition
ObservationNHSDigitalObservation
OrganizationNHSDigitalOrganization
OperationDefinitionNHSDigitalOperationDefinition
OperationOutcomeNHSDigitalOperationOutcome
PatientNHSDigitalPatient
PractitionerNHSDigitalPractitioner
PractitionerRoleNHSDigitalPractitionerRole
QuestionnaireNHSDigitalQuestionnaire
QuestionnaireResponseNHSDigitalQuestionnaireResponse
RelatedPerson
ServiceRequestNHSDigitalServiceRequest
SlotEnglandSlot
TaskNHSDigitalTask
DeviceSDS Device
EndpointSDS Endpoint


<CapabilityStatement xmlns="http://hl7.org/fhir">
    <id value="nhsdigital-requirements" />
    <url value="https://fhir.nhs.uk/CapabilityStatement/nhsdigital-requirements" />
    <version value="1.0.0" />
    <name value="NHSDigitalRequirements" />
    <status value="active" />
    <date value="2021-04-28T00:00:00+00:00" />
    <publisher value="digital.nhs.uk" />
    <description value="Conformance requirements for NHS Digital Implementation Guide" />
    <kind value="requirements" />
    <fhirVersion value="4.0.1" />
    <format value="application/fhir+json" />
    <format value="application/fhir+xml" />
    <rest>
        <mode value="server" />
        <security>
            <service>
                <coding>
                    <system value="http://terminology.hl7.org/CodeSystem/restful-security-service" />
                    <code value="OAuth" />
                    <display value="OAuth2 Token" />
                </coding>
            </service>
        </security>
        <resource>
            <type value="Account" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Account" />
        </resource>
        <resource>
            <type value="AllergyIntolerance" />
            <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" />
        </resource>
        <resource>
            <type value="Appointment" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Appointment" />
        </resource>
        <resource>
            <type value="Binary" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Binary" />
        </resource>
        <resource>
            <type value="CapabilityStatement" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-CapabilityStatement" />
        </resource>
        <resource>
            <type value="Condition" />
            <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
        </resource>
        <resource>
            <type value="Claim" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim" />
        </resource>
        <resource>
            <type value="CommunicationRequest" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest" />
        </resource>
        <resource>
            <type value="Encounter" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Encounter" />
        </resource>
        <resource>
            <type value="DocumentReference" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-DocumentReference" />
        </resource>
        <resource>
            <type value="Flag" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Flag" />
        </resource>
        <resource>
            <type value="HealthcareService" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService" />
        </resource>
        <resource>
            <type value="Immunization" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Immunization" />
        </resource>
        <resource>
            <type value="Location" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Location" />
        </resource>
        <resource>
            <type value="List" />
            <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" />
        </resource>
        <resource>
            <type value="MedicationAdministration" />
            <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration" />
        </resource>
        <resource>
            <type value="MedicationRequest" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest" />
        </resource>
        <resource>
            <type value="MedicationDispense" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense" />
        </resource>
        <resource>
            <type value="Medication" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Medication" />
        </resource>
        <resource>
            <type value="MedicationStatement" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationStatement" />
        </resource>
        <resource>
            <type value="MessageDefinition" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-MessageDefinition" />
        </resource>
        <resource>
            <type value="Observation" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Observation" />
        </resource>
        <resource>
            <type value="Organization" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization" />
        </resource>
        <resource>
            <type value="OperationDefinition" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationDefinition" />
        </resource>
        <resource>
            <type value="OperationOutcome" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome" />
        </resource>
        <resource>
            <type value="Patient" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient" />
        </resource>
        <resource>
            <type value="Practitioner" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner" />
        </resource>
        <resource>
            <type value="PractitionerRole" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole" />
        </resource>
        <resource>
            <type value="Questionnaire" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Questionnaire" />
        </resource>
        <resource>
            <type value="QuestionnaireResponse" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-QuestionnaireResponse" />
        </resource>
        <resource>
            <type value="RelatedPerson" />
            <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
        </resource>
        <resource>
            <type value="ServiceRequest" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest" />
        </resource>
        <resource>
            <type value="Slot" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/England-Slot" />
        </resource>
        <resource>
            <type value="Task" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task" />
        </resource>
        <resource>
            <type value="Device" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/SDS-Device" />
        </resource>
        <resource>
            <type value="Endpoint" />
            <profile value="https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint" />
        </resource>
    </rest>
</CapabilityStatement>

{
    "resourceType": "CapabilityStatement",
    "id": "nhsdigital-requirements",
    "url": "https://fhir.nhs.uk/CapabilityStatement/nhsdigital-requirements",
    "version": "1.0.0",
    "name": "NHSDigitalRequirements",
    "status": "active",
    "date": "04/28/2021 00:00:00",
    "publisher": "digital.nhs.uk",
    "description": "Conformance requirements for NHS Digital Implementation Guide",
    "kind": "requirements",
    "fhirVersion": "4.0.1",
    "format":  [
        "application/fhir+json",
        "application/fhir+xml"
    ],
    "rest":  [
        {
            "mode": "server",
            "security": {
                "service":  [
                    {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                                "code": "OAuth",
                                "display": "OAuth2 Token"
                            }
                        ]
                    }
                ]
            },
            "resource":  [
                {
                    "type": "Account",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Account"
                },
                {
                    "type": "AllergyIntolerance",
                    "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance"
                },
                {
                    "type": "Appointment",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Appointment"
                },
                {
                    "type": "Binary",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Binary"
                },
                {
                    "type": "CapabilityStatement",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CapabilityStatement"
                },
                {
                    "type": "Condition",
                    "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"
                },
                {
                    "type": "Claim",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim"
                },
                {
                    "type": "CommunicationRequest",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest"
                },
                {
                    "type": "Encounter",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Encounter"
                },
                {
                    "type": "DocumentReference",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-DocumentReference"
                },
                {
                    "type": "Flag",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Flag"
                },
                {
                    "type": "HealthcareService",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService"
                },
                {
                    "type": "Immunization",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Immunization"
                },
                {
                    "type": "Location",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Location"
                },
                {
                    "type": "List",
                    "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List"
                },
                {
                    "type": "MedicationAdministration",
                    "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration"
                },
                {
                    "type": "MedicationRequest",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest"
                },
                {
                    "type": "MedicationDispense",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense"
                },
                {
                    "type": "Medication",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Medication"
                },
                {
                    "type": "MedicationStatement",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationStatement"
                },
                {
                    "type": "MessageDefinition",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MessageDefinition"
                },
                {
                    "type": "Observation",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Observation"
                },
                {
                    "type": "Organization",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization"
                },
                {
                    "type": "OperationDefinition",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationDefinition"
                },
                {
                    "type": "OperationOutcome",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome"
                },
                {
                    "type": "Patient",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient"
                },
                {
                    "type": "Practitioner",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner"
                },
                {
                    "type": "PractitionerRole",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole"
                },
                {
                    "type": "Questionnaire",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Questionnaire"
                },
                {
                    "type": "QuestionnaireResponse",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-QuestionnaireResponse"
                },
                {
                    "type": "RelatedPerson",
                    "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                },
                {
                    "type": "ServiceRequest",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest"
                },
                {
                    "type": "Slot",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/England-Slot"
                },
                {
                    "type": "Task",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task"
                },
                {
                    "type": "Device",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/SDS-Device"
                },
                {
                    "type": "Endpoint",
                    "profile": "https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint"
                }
            ]
        }
    ]
}
back to top