GP Connect - Access Record HTML

Version: This is the current 0.x (DSTU2) version of GP Connect API for building the Access Record: HTML capability only. For other capabilities and specifications, please visit the GP Connect Specifications page.

Get the FHIR capability statement

Use case

Get the Access Record HTML FHIR capability statement.

API specification

See API specification for more details about topic such as:

Who can use the API
Related APIs
API status and roadmap
Service level
Security and authorisation
Environments and testing
Onboarding
Error handling

Payload response body

Provider systems:

MUST return a 200 OK HTTP status code on successful retrieval of the conformance statement
MUST ensure that the FHIR version number returned by the FHIR server endpoint conformance statement matches the FHIR version stated in the endpoint base URL. Refer to Spine Directory Services) for details of the format of the FHIR base URL to be used.

An example GP Connect Conformance Statement of type capability is shown below ready for customisation and embedding into GP Connect assured provider systems. Providers should use this conformance statement as a base for their own conformance statement, replacing the element in square brackets ([ & ]) with specific information of their implementation. The main version at the top of the conformance statement should represent the GP Connect specification version which the FHIR server implements.

Payload response examples

{
    "resourceType": "Conformance",
    "meta": {
        "versionId": "1E17479D0EBE5D7AA9B45A493D67AE98"
    },
    "version": "0.7.2",
    "name": "GP Connect",
    "publisher": "<GP Connect Provider Organisation>",
    "contact": {
        "name": "<GP Connect Provider Organisation> Helpdesk"
    },
    "date": "2019-11-21",
    "description": "This server implements the GP Connect API version 0.7.2",
    "copyright": "Copyright NHS Digital 2016",
    "kind": "capability",
    "software": {
        "name": "<GP Connect Provider Software name>",
        "version": "1",
        "releaseDate": "2025-08-07"
    },
    "fhirVersion": "1.0.2",
    "acceptUnknown": "both",
    "format": [
        "application/json+fhir"
    ],
    "profile": [
        {
            "reference": "http://fhir.nhs.net/StructureDefinition/gpconnect-patient-1"
        },
        {
            "reference": "http://fhir.nhs.net/StructureDefinition/gpconnect-operationoutcome-1"
        },
        {
            "reference": "http://fhir.nhs.net/StructureDefinition/gpconnect-practitioner-1"
        },
        {
            "reference": "http://fhir.nhs.net/StructureDefinition/gpconnect-organization-1"
        },
        {
            "reference": "http://fhir.nhs.net/StructureDefinition/gpconnect-searchset-bundle-1"
        },
        {
            "reference": "http://fhir.nhs.net/StructureDefinition/gpconnect-carerecord-composition-1"
        }
    ],
    "rest": [
        {
            "mode": "server",
            "operation": [
                {
                    "name": "gpc.getcarerecord",
                    "definition": {
                        "reference": "OperationDefinition/gpc.getcarerecord"
                    }
                }
            ]
        }
    ]
}