Access Record Structured FHIR examples

The following is a set of request/response examples for Consultations:

Example 1

Request

Example of a call to return the following items from a patient's structured record:

  • Consultations

Request payload

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "https://fhir.nhs.uk/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "includeConsultations",
      "part": [
        {
          "name": "includeNumberOfMostRecent",
          "valuePositiveInt": 3
        }
      ]
    },
  ]
}

Response payload

The response payload is available as a json file by clicking on the link below. The first consultation in the example is in line with the diagram on the consultation guidance page. It also contains a further two consultations which are described in the spreadsheet that can be downloaded using the link below.
Response payload
Spreadsheet description of example