GP Connect - Access Record HTML

This guidance is under active development by NHS England and content may be added or updated on a regular basis.
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.

Search examples

Request summary view

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "patientNHSNumber",
            "valueIdentifier": {
                "system": "http://fhir.nhs.net/Id/nhs-number",
                "value": "9999999999"
            }
        },
        {
            "name": "recordSection",
            "valueCodeableConcept": {
                "coding": [
                    {
                        "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
                        "code": "SUM"
                    }
                ]
            }
        }
    ]
}

Request encounters view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "ENC"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

Request clinical items view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "CLI"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

Request problems and issues view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "PRB"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

Request allergies and adverse reactions view

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "patientNHSNumber",
            "valueIdentifier": {
                "system": "http://fhir.nhs.net/Id/nhs-number",
                "value": "9999999999"
            }
        },
        {
            "name": "recordSection",
            "valueCodeableConcept": {
                "coding": [
                    {
                        "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
                        "code": "ALL"
                    }
                ]
            }
        }
    ]
}

Request medications view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "MED"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

Request referrals view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "REF"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

Request observations view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "OBS"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

Request immunisations view

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "patientNHSNumber",
            "valueIdentifier": {
                "system": "http://fhir.nhs.net/Id/nhs-number",
                "value": "9999999999"
            }
        },
        {
            "name": "recordSection",
            "valueCodeableConcept": {
                "coding": [
                    {
                        "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
                        "code": "IMM"
                    }
                ]
            }
        }
    ]
}

Request administrative items view

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "http://fhir.nhs.net/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "recordSection",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://fhir.nhs.net/ValueSet/gpconnect-record-section-1",
            "code": "ADM"
          }
        ]
      }
    },
    {
      "name": "timePeriod",
      "valuePeriod": {
        "start": "2022-06-19",
        "end": "2024-12-31"
      }
    }
  ]
}

back to top