GP Connect

GP Connect Meta API

The Meta API from GP Connect — 1 operation(s) for meta.

Documentation GitHub OpenAPI

Operations 1

GET /meta Get update record FHIR capability statement #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/gp-connect-meta-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: '[DRAFT]gp-connect-update-record-fhir Meta API'
  version: draft
  description: '# Overview

    Use this API to send structured data to a patient''s GP record.'
tags:
- name: Meta
paths:
  /meta:
    get:
      operationId: get-capabilitystatement
      summary: Get update record FHIR capability statement
      description: ''
      parameters:
      - in: header
        name: SSP-Trace-ID
        description: 'The provider''s Trace ID (normally a GUID  or UUID)

          '
        required: true
        schema:
          type: string
      - in: header
        name: SSP-From
        description: 'The provider''s ASID

          '
        required: true
        schema:
          type: string
      - in: header
        name: SSP-To
        description: 'The consumer''s ASID

          '
        required: true
        schema:
          type: string
      - in: header
        name: SSP-InteractionID
        description: 'urn:nhs:names:services:gpconnect:structured:fhir:rest:read:metadata-1

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/fhir+json:
              schema:
                type: object
                description: 'FILL THIS OUT

                  '
              examples:
                example:
                  description: Succesful capability statement retrieval
                  value:
                    resourceType: CapabilityStatement
                    version: 1.0.0
                    name: GP Connect API - Update Record
                    status: active
                    date: '2020-02-10'
                    publisher: '[Provider Software Vendor Name]'
                    contact:
                    - name: '[Provider Software Vendor Contact Name]'
                    description: This server implements the GP Connect API - Update Record version 1.0.0
                    copyright: Copyright NHS Digital 2016-21
                    kind: capability
                    software:
                      name: '[Provider Software Name]'
                      version: '[Provider Software Version]'
                      releaseDate: '[Provider Software Release Date]'
                    fhirVersion: 3.0.1
                    acceptUnknown: both
                    format:
                    - application/fhir+json
                    - application/fhir+xml
                    profile:
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1/_history/1.8
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1/_history/1.4
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1/_history/1.2
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-1/_history/1.7
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1/_history/1.3
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-OperationOutcome-1/_history/1.2
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1/_history/1.5
                    - reference: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1/_history/1.7
                    rest:
                    - mode: server
                      security:
                        cors: true
        4XX:
          description: "An error occured as follows:\n\n\n| HTTP Status | Error code   | Description\n|-------------|--------------------|------------\n| 403         | ACCESS DENIED   | GP Connect is not enabled at the practice\n  403         | ACCESS DENIED      | The Update Record Structured capability is not enabled at the practice\n"
          content:
            application/fhir+json:
              schema:
                type: object
                description: Link
              examples:
                example:
                  value:
                    resourceType: OperationOutcome
                    meta:
                      profile:
                      - https://fhir.hl7.org.uk/StructureDefinition/GPConnect-OperationOutcome-1
                    issue:
                    - severity: error
                      code: value
                      details:
                        coding:
                        - system: https://fhir.nhs.uk/STU3/ValueSet/Spine-ErrorOrWarningCode-1
                          code: ACCESS DENIED
                          display: GP Connect is not enabled at the practice
      tags:
      - Meta