API Hub

Explore and Make use of Nationally Defined Messaging APIs

This is a HL7 FHIR server, and as you appear to be accessing this page from a web browser you are seeing a HTML version of the requested resource(s). You can also access this URL from a FHIR client as a ReSTful API call. For more details please see the HL7 FHIR specification.
{
  "resourceType": "CodeSystem",
  "id": "eRS-AvailableActionsForUser-1",
  "text": {
    "status": "generated"
  },
  "url": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AvailableActionsForUser-1",
  "version": "1.1.0",
  "name": "eRS Available Actions For User",
  "status": "active",
  "date": "2022-03-10",
  "publisher": "NHS Digital",
  "contact": [
    {
      "name": "Interoperability Team",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work"
        }
      ]
    }
  ],
  "description": "A CodeSystem to identify the eRS available actions for a user.",
  "copyright": "Copyright © 2022 NHS Digital",
  "caseSensitive": true,
  "content": "complete",
  "concept": [
    {
      "code": "RECORD_REVIEW_OUTCOME",
      "display": "This action currently allows you to persist an eRS-ReviewOutcome of RETURN_TO_REFERRER_WITH_ADVICE or ACCEPT_REFER_BOOK_LATER"
    },
    {
      "code": "CANCEL_DIRECTLY_BOOKED_APPOINTMENT",
      "display": "This action allows you to cancel appointments made to directly bookable services (DBS)"
    },
    {
      "code": "CANCEL_REFERRAL",
      "display": "This action allows you to cancel the referral. This will also cancel the current appointment, if there is one"
    },
    {
      "code": "CREATE_APPOINTMENT",
      "display": "This action currently allows you to create an appointment at a service. This allows for an appointment to be booked if there are appointment slots available for the provided service, or allows for a 'proposed' appointment to be created if no slots are available. It is also possible to create a 'proposed' appointment via this action to request the service to triage the related referral, if the specified service is listed as 'triage' service."
    },
    {
      "code": "CHANGE_SHORTLIST",
      "display": "This action allows you to change the current shortlist associated with a referral"
    },
    {
      "code": "CHANGE_SHORTLIST_AND_SEND_FOR_TRIAGE",
      "display": "This action allows you to change the current shortlist to send the referral to a single appropriate (triage) service. This action has now been deprecated, the CHANGE_SHORTLIST action should be used instead."
    }
  ]
}