Library

Browse and search developer information

A008: Retrieve Worklist

Description

This lets authorised users retrieve the ‘Referrals for Review’ work list. This is the same as the existing interface. This work list gives details of new referrals sent to the service by GPs and others. It includes their key attributes.

Input

To follow

Output

To follow

Code Sample

Code snippets are taken from the consumer example. See Code Samples for further details.

FHIR Structure Definition for Referral for Review Worklist – with results

{
  "resourceType": "List",
  "meta": {
    "profile": [
      "http://fhir.nhs.net/StructureDefinition/ers-fetchworklist-list-1"
    ]
  },
  "contained": [
    {
      "resourceType": "Practitioner",
      "id": "123456789012",
      "meta": {
        "profile": [
          "http://fhir.nhs.net/StructureDefinition/ers-practitioner-1"
        ]
      },
      "identifier": [
        {
          "system": "http://fhir.nhs.net/Id/sds-user-id",
          "value": "123456789012"
        }
      ]
    },
    {
      "resourceType": "Patient",
      "id": "9900002831",
      "meta": {
        "profile": [
          "http://fhir.nhs.net/StructureDefinition/ers-patient-1"
        ]
      },
      "identifier": [
        {
          "system": "http://fhir.nhs.net/Id/nhs-number",
          "value": "9900002831"
        }
      ]
    }
  ],
  "status": "current",
  "mode": "snapshot",
  "entry": [
    {
      "extension": [
        {
          "url": "http://fhir.nhs.net/StructureDefinition/extension-ers-referralsforreview-worklistitem-1",
          "extension": [
            {
              "url": "patient",
              "valueReference": {
                "reference": "#9900002831"
              }
            },
            {
              "url": "priority",
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "http://fhir.nhs.net/ValueSet/ers-priority-1",
                    "code": "ROUTINE"
                  }
                ]
              }
            },
            {
              "url": "appointmentStart",
              "valueDateTime": "2016-08-12T19:23:53Z"
            },
            {
              "url": "dateWhenBookingMade",
              "valueDateTime": "2016-08-12T19:23:53Z"
            },
            {
              "url": "clinicalInfoFirstSubmitted",
              "valueDateTime": "2016-08-12T19:23:53Z"
            },
            {
              "url": "clinicalInfoLastUpdated",
              "valueDateTime": "2016-08-12T19:23:53Z"
            },
            {
              "url": "clinicalInfoPrinted",
              "valueBoolean": true
            },
            {
              "url": "allocatedClinician",
              "valueReference": {
                "reference": "#123456789012"
              }
            },
            {
              "url": "requestContextStatus",
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "http://fhir.nhs.net/ValueSet/ers-requestcontextstatus-1",
                    "code": "NEVER_REVIEWED",
                    "display": "Never Reviewed"
                  }
                ]
              }
            },
            {
              "url": "specialty",
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "http://fhir.nhs.net/ValueSet/ers-specialty-1",
                    "code": "DERMATOLOGY",
                    "display": "Dermatology"
                  }
                ]
              }
            }
          ]
        }
      ],
      "item": {
        "reference": "ReferralRequest/000234620011"
      }
    }
  ]
}

Notes

Response Messages

HTTP Status Code Reason Response Model Headers
403 Forbidden
422 Unprocessable Entity – Provided data could not be processed due to a validation error.