Retrieve healthcare service

Overview

Use this endpoint to retrieve attributes about a single service.

Pre-requisites

In order to use this endpoint the patient must be an authenticated user.

The patient needs to have authenticated via [[HYPERLINK_NHS_LOGIN]] and meet the required identity proofing level (currently this is "P9").

You need to have identified one service ID to use this endpoint.

Use case

As an authenticated user

I want to know more about a healthcare service

So that I can make appropriate decisions about my care

Related endpoints

If a referral currently has an appointment booking to a service or is deferred to a service then [[HYPERLINK_A001]] can be used to retrieve the Service ID of that service.

get/FHIR/R4/HealthcareService/{id}

Request

Base URL
https://int.api.service.nhs.uk/e-referrals-service-patient-care-api
URL
https://int.api.service.nhs.uk/e-referrals-service-patient-care-api/FHIR/R4/HealthcareService/{id}
Auth
HTTP bearer

Path parameters

idstring required

Example:1

The ID of the healthcare service to be retrieved. It must be valid and relate to an existing Healthcare Service otherwise a HTTP 404 response will be returned.

Parameters

#/paths/~1FHIR~1R4~1ServiceRequest/get/parameters/3 (unresolved $ref)

Response

The Response contains a Healthcare service.

idstring required

resourceType'HealthcareService' required

namestring required

Name of the HealthcareService (as per e-RS Directory of Services).

Example response

{
  "id": "123",
  "meta": {
    "versionId": "4",
    "profile": [
      "https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService-PatientCare"
    ]
  },
  "identifier": [
    {
      "system": "https://fhir.nhs.uk/Id/ers-service",
      "value": "11002"
    }
  ],
  "resourceType": "HealthcareService",
  "providedBy": {
    "identifier": {
      "system": "https://fhir.nhs.uk/Id/ods-organization-code",
      "value": "R69"
    }
  },
  "specialty": [
    {
      "coding": [
        [
          {
            "system": "https://fhir.nhs.uk/CodeSystem/eRS-Specialty",
            "code": "DERMATOLOGY",
            "display": "Dermatology"
          }
        ]
      ]
    }
  ],
  "type": [
    {
      "coding": [
        {
          "system": "https://fhir.nhs.uk/CodeSystem/eRS-AppointmentType",
          "code": "DAY_CASE"
        }
      ]
    }
  ],
  "location": [
    {
      "identifier": {
        "system": "https://fhir.nhs.uk/Id/ods-site-code",
        "value": "R6901"
      }
    }
  ],
  "name": "Direct SVC 1",
  "endpoint": [
    {
      "identifier": {
        "system": "https://fhir.nhs.uk/Id/nhsSpineASID",
        "value": "9912003888"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.