HealthcareService

Get the HealthcareServices for an identifier

get/HealthcareService

Request

Base URL
https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4
URL
https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4/HealthcareService
Auth
HTTP bearer

Query parameters

HealthcareService.providedBystring

Example:https://fhir.nhs.uk/Id/ods-organization-code|A001

The identifier of the organization that is managing the endpoint(s). This needs to be URL Encoded as its passed as a query parameter and part of the URL.

HealthcareService.identifierstring

Example:https://fhir.nhs.uk/Id/dos-service-id|1000099999

The identifier of the HealthcareService. This needs to be URL Encoded as its passed as a query parameter and part of the URL.

Response

The operation was successful

resourceTypestring

idstring

typestring

totalinteger

timestampstring

Example response

{
  "id": "777a156c-af3c-4748-a8a3-7e95e4b0df9a",
  "type": "searchset",
  "total": 2,
  "entry": [
    {
      "resource": {
        "resourceType": "HealthcareService",
        "id": "7ded9440-3543-4809-b834-25c9be211195",
        "meta": {
          "lastUpdated": "2021-10-11T15:01:30+00:00",
          "profile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService"
          ]
        },
        "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/dos-service-id",
            "value": "1000099999",
            "display": "Directory of Services (DOS)"
          }
        ],
        "active": true,
        "name": "Example Healthcare Service",
        "providedBy": [
          {
            "identifier": {
              "system": "https://fhir.nhs.uk/Id/dos-service-id",
              "value": "1000099999",
              "display": "Directory of Services (DOS)"
            }
          }
        ],
        "endpoint": [
          {
            "reference": "Endpoint/7ded9440-3543-4809-b834-25c9be211195"
          }
        ]
      }
    }
  ]
}

Changes

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