GP Connect

GP Connect FHIR API

The FHIR API from GP Connect — 1 operation(s) for fhir.

Documentation GitHub OpenAPI

Operations 1

POST /FHIR/STU3/Bundle Post an update to the patients record #

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-fhir-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 API'
  version: draft
  description: '# Overview

    Use this API to send structured data to a patient''s GP record.'
tags:
- name: FHIR
paths:
  /FHIR/STU3/Bundle:
    post:
      operationId: post-update
      summary: Post an update to the patients record
      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:fhir:bundle

          '
        required: true
        schema:
          type: string
      - in: header
        name: EncounterId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        description: Successful Request.
        content:
          application/fhir+json:
            schema:
              type: object
              description: "A [bundle](https://hl7.org/fhir/stu3/bundle.html) is posted to the endpoint consisting of four resources:\n - [Patient](https://simplifier.net/guide/gpconnect-data-model/Home/FHIR-Assets/All-assets/Profiles/Profile--CareConnect-GPC-Patient-1?version=current)\n - [Encounter](https://simplifier.net/guide/gpconnect-data-model/Home/FHIR-Assets/All-assets/Profiles/Profile--CareConnect-GPC-Encounter-1?version=current)\n - [Medication Statement](https://simplifier.net/guide/gpconnect-data-model/Home/FHIR-Assets/All-assets/Profiles/Profile--CareConnect-GPC-MedicationStatement-1?version=current)\n - [Observation](https://simplifier.net/guide/gpconnect-data-model/Home/FHIR-Assets/All-assets/Profiles/Profile--CareConnect-GPC-Observation-1?version=current)\n"
            example:
              resourceType: Bundle
              meta:
                versionId: '1'
                lastUpdated: '2023-02-14T11:58:27.1516395+00:00'
              type: collection
              entry:
              - resource:
                  resourceType: Patient
                  id: e461896a-b0c8-457d-9397-b276c9aec312
                  meta:
                    versionId: '1'
                    lastUpdated: '2023-02-14T11:58:27.1516395+00:00'
                    profile:
                    - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1
                  active: true
                  name:
                  - use: official
                    family: Test
                    given:
                    - Roger
                  gender: male
                  birthDate: '1975-12-25'
              - resource:
                  meta:
                    versionId: '1'
                    lastUpdated: '2023-01-24T11:58:38.4899643+00:00'
                    profile:
                    - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1
                  resourceType: Encounter
                  reason:
                  - coding:
                    - extension:
                      - extension:
                        - valueId: '86591008'
                          url: descriptionId
                        - valueString: PharmacyVisit
                          url: descriptionDisplay
                        url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
                      display: Upset Stomach
                      system: http://snomed.info/sct
                      code: '271681002'
                  type:
                  - coding:
                    - display: Face to face encounter
                      code: '1258986006'
                      system: http://snomed.info/sct
                  subject:
                    identifier:
                      extension:
                      - valueCodeableConcept:
                          text: Number present and verified
                          coding:
                          - display: Number present and verified
                            code: '01'
                            system: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
                        url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
                      system: https://fhir.nhs.uk/Id/nhs-number
                      value: '9989453456'
                  participant:
                  - period:
                      start: '2022-12-25T14:01:31+00:00'
                    individual:
                      identifier:
                        system: https://fhir.hl7.org.uk/Id/gmc-number
                        value: '0054272'
                    type:
                    - text: recorder
                      coding:
                      - system: https://fhir.nhs.uk/STU3/ValueSet/GPConnect-ParticipantType-1
                        code: REC
                  period:
                    start: '2022-12-25T10:42:12+00:00'
                  identifier:
                  - system: https://hospital.example/visit-number
                    value: visit-00425123
              - resource:
                  resourceType: MedicationStatement
                  id: 359d0a53-f1ef-4c0b-9d58-01cabbc48413
                  meta:
                    versionId: '1'
                    lastUpdated: '2023-01-24T13:29:33.7462714+00:00'
                    profile:
                    - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-1
                  extension:
                  - url: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-PrescribingAgency-1
                    valueCodeableConcept:
                      coding:
                      - system: https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-PrescribingAgency-1
                        code: prescribed-by-another-organisation
                      text: Prescribed by another organisation
                  identifier:
                  - system: https://hospital.example/medication-statement
                    value: rx-0281156
                  context:
                    identifier:
                      system: https://hospital.example/visit-number
                      value: visit-00425123
                  status: completed
                  medicationCodeableConcept:
                    coding:
                      code: '39732311000001104'
                      system: https://dmd.nhs.uk
                      display: Amoxicillin 250mg capsules
                  effectivePeriod:
                    start: '2023-01-20'
                    end: '2023-01-27'
                  dateAsserted: '2023-01-24T13:29:33.7477005+00:00'
                  informationSource:
                    identifier:
                      system: https://fhir.nhs.uk/Id/ods-organization-code
                      value: RFR
                  subject:
                    identifier:
                      extension:
                      - url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
                        valueCodeableConcept:
                          coding:
                          - system: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
                            code: '01'
                            display: Number present and verified
                          text: Number present and verified
                      system: https://fhir.nhs.uk/Id/nhs-number
                      value: '9989453456'
                  taken: y
                  note:
                  - authorReference:
                      identifier:
                        system: https://fhir.hl7.org.uk/Id/gmc-number
                        value: 00143922
                    time: '2023-01-24T13:29:33.7491725+00:00'
                    text: Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM)
                  dosage:
                  - text: 10 milligram - two times a day - oral - Swallow your capsules whole with a glass of water. DO NOT break, crush or chew them
                    patientInstruction: Swallow your capsules whole with a glass of water. DO NOT break, crush or chew them
                    timing:
                      repeat:
                        frequency: 1
                        period: 2
                        periodUnit: d
                        when:
                        - C
                    route:
                      coding:
                      - system: https://snomed.info/sct
                        code: '26643006'
                      text: oral
                    doseQuantity:
                      value: 10
                      unit: milligram
                      system: https://unitsofmeasure.org
                      code: mg
              - resourceType: Observation
                status: final
                id: e461896a-b0c8-457d-9397-b276c9aec312
                meta:
                  versionId: '1'
                  lastUpdated: '2023-02-14T11:58:27.1516395+00:00'
                  profile:
                  - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1
                comment: Patient has high Temperature
                subject:
                  identifier:
                    extension:
                    - valueCodeableConcept:
                        text: Number present and verified
                        coding:
                        - display: Number present and verified
                          code: '01'
                          system: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
                      url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
                    system: https://fhir.nhs.uk/Id/nhs-number
                    value: '9989453456'
                valueQuantity:
                  code: cel
                  unit: C
                  system: http://unitsofmeasure.org
                  value: 40
                effectiveDateTime: '2023-02-14T11:58:27.153001+00:00'
                performer:
                - identifier:
                    system: https://fhir.hl7.org.uk/Id/gmc-number
                    value: 00143922
                issued: '2023-02-14T11:58:27.1530896+00:00'
                category:
                - text: Vital signs
                  coding:
                  - display: vital-signs
                    code: Vital signs
                    system: http://terminology.hl7.org/CodeSystem/observation-category
                code:
                  text: High Temperature
                  coding:
                  - display: High Temperature
                    code: '285717004'
                    system: http://snomed.info/sct
                context:
                  reference: visit-00425123
      responses:
        '200':
          description: Successful response
          content:
            application/fhir+json:
              schema:
                type: object
                description: 'FILL THIS OUT

                  '
              examples:
                example:
                  description: Succesful bundle post
                  value:
                    resourceType: Bundle
                    id: e461896x-b0cx-4x7d-9344-b276c9aec312
                    meta:
                      versionId: '1'
                      lastUpdated: '2023-02-14T11:58:27.1516395+00:00'
                    type: collection
                    entry:
                    - resource:
                        resourceType: Patient
                        id: e461896a-b0c8-457d-9397-b276c9aec312
                        meta:
                          versionId: '1'
                          lastUpdated: '2023-02-14T11:58:27.1516395+00:00'
                          profile:
                          - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1
                        active: true
                        name:
                        - use: official
                          family: Test
                          given:
                          - Roger
                        gender: male
                        birthDate: '1975-12-25'
                    - resource:
                        meta:
                          versionId: '1'
                          lastUpdated: '2023-01-24T11:58:38.4899643+00:00'
                          profile:
                          - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1
                        resourceType: Encounter
                        reason:
                        - coding:
                          - extension:
                            - extension:
                              - valueId: '86591008'
                                url: descriptionId
                              - valueString: PharmacyVisit
                                url: descriptionDisplay
                              url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
                            display: Upset Stomach
                            system: http://snomed.info/sct
                            code: '271681002'
                        type:
                        - coding:
                          - display: Face to face encounter
                            code: '1258986006'
                            system: http://snomed.info/sct
                        subject:
                          identifier:
                            extension:
                            - valueCodeableConcept:
                                text: Number present and verified
                                coding:
                                - display: Number present and verified
                                  code: '01'
                                  system: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
                              url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
                            system: https://fhir.nhs.uk/Id/nhs-number
                            value: '9989453456'
                        participant:
                        - period:
                            start: '2022-12-25T14:01:31+00:00'
                          individual:
                            identifier:
                              system: https://fhir.hl7.org.uk/Id/gmc-number
                              value: '0054272'
                          type:
                          - text: recorder
                            coding:
                            - system: https://fhir.nhs.uk/STU3/ValueSet/GPConnect-ParticipantType-1
                              code: REC
                        period:
                          start: '2022-12-25T10:42:12+00:00'
                        identifier:
                        - system: https://hospital.example/visit-number
                          value: visit-00425123
                    - resource:
                        resourceType: MedicationStatement
                        id: 359d0a53-f1ef-4c0b-9d58-01cabbc48413
                        meta:
                          versionId: '1'
                          lastUpdated: '2023-01-24T13:29:33.7462714+00:00'
                          profile:
                          - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationStatement-1
                        extension:
                        - url: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-PrescribingAgency-1
                          valueCodeableConcept:
                            coding:
                            - system: https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-PrescribingAgency-1
                              code: prescribed-by-another-organisation
                            text: Prescribed by another organisation
                        identifier:
                        - system: https://hospital.example/medication-statement
                          value: rx-0281156
                        context:
                          identifier:
                            system: https://hospital.example/visit-number
                            value: visit-00425123
                        status: completed
                        medicationCodeableConcept:
                          coding:
                            code: '39732311000001104'
                            system: https://dmd.nhs.uk
                            display: Amoxicillin 250mg capsules
                        effectivePeriod:
                          start: '2023-01-20'
                          end: '2023-01-27'
                        dateAsserted: '2023-01-24T13:29:33.7477005+00:00'
                        informationSource:
                          identifier:
                            system: https://fhir.nhs.uk/Id/ods-organization-code
                            value: RFR
                        subject:
                          identifier:
                            extension:
                            - url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
                              valueCodeableConcept:
                                coding:
                                - system: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
                                  code: '01'
                                  display: Number present and verified
                                text: Number present and verified
                            system: https://fhir.nhs.uk/Id/nhs-number
                            value: '9989453456'
                        taken: y
                        note:
                        - authorReference:
                            identifier:
                              system: https://fhir.hl7.org.uk/Id/gmc-number
                              value: 00143922
                          time: '2023-01-24T13:29:33.7491725+00:00'
                          text: Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM)
                        dosage:
                        - text: 10 milligram - two times a day - oral - Swallow your capsules whole with a glass of water. DO NOT break, crush or chew them
                          patientInstruction: Swallow your capsules whole with a glass of water. DO NOT break, crush or chew them
                          timing:
                            repeat:
                              frequency: 1
                              period: 2
                              periodUnit: d
                              when:
                              - C
                          route:
                            coding:
                            - system: https://snomed.info/sct
                              code: '26643006'
                            text: oral
                          doseQuantity:
                            value: 10
                            unit: milligram
                            system: https://unitsofmeasure.org
                            code: mg
                    - resourceType: Observation
                      status: final
                      id: e461896a-b0c8-457d-9397-b276c9aec312
                      meta:
                        versionId: '1'
                        lastUpdated: '2023-02-14T11:58:27.1516395+00:00'
                        profile:
                        - https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1
                      comment: Patient has high Temperature
                      subject:
                        identifier:
                          extension:
                          - valueCodeableConcept:
                              text: Number present and verified
                              coding:
                              - display: Number present and verified
                                code: '01'
                                system: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
                            url: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
                          system: https://fhir.nhs.uk/Id/nhs-number
                          value: '9989453456'
                      valueQuantity:
                        code: cel
                        unit: C
                        system: http://unitsofmeasure.org
                        value: 40
                      effectiveDateTime: '2023-02-14T11:58:27.153001+00:00'
                      performer:
                      - identifier:
                          system: https://fhir.hl7.org.uk/Id/gmc-number
                          value: 00143922
                      issued: '2023-02-14T11:58:27.1530896+00:00'
                      category:
                      - text: Vital signs
                        coding:
                        - display: vital-signs
                          code: Vital signs
                          system: http://terminology.hl7.org/CodeSystem/observation-category
                      code:
                        text: High Temperature
                        coding:
                        - display: High Temperature
                          code: '285717004'
                          system: http://snomed.info/sct
                      context:
                        reference: visit-00425123
        4XX:
          description: "An error occured as follows:\n\n\n| HTTP Status | Spine error code   | Description\n|-------------|--------------------|------------\n| 400         | INVALID_RESOURCE   | \n  400         | MISSING_FIELD      |\n  400         | MISSING_RESOURCE   |\n| 400         | INVALID_NHS_NUMBER |\n| 422         | UNPROCESSABLE      | \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: INVALID_NHS_NUMBER
                          display: Invalid NHS Number
      tags:
      - FHIR