NHnhs
Endpoint

Get the Endpoints based on HealthcareService and Endpoint identifiers

Get the Endpoints for an identifier, its address will be omitted if the Endpoint.header is set to private unless the requestor is the owner.

get/Endpoint

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/Endpoint
  • Auth
    HTTP bearer

Query parameters

_has'HealthcareService.Identifier' | 'HealthcareService.Id'

The healthcareService you want the Endpoints returned for. This needs to be URL Encoded as its passed as a query parameter and part of the URL.

HealthcareService PropertyExample
HealthcareService.Identifier_has:HealthcareService.Identifier=https://fhir.nhs.uk/Id/dos-service-id|1000099999
HealthcareService.Id_has:HealthcareService.Id=95852b93-d1ab-4c51-8e7d-c24cf9b257a9
Endpoint.identifierstring
Example:https://fhir.nhs.uk/Id/EndpointSystem|EndpointValue

The identifier of the type of Endpoint, usually the identifier set by the organisation/supplier that created the Endpoint. It is important to note that this is not the same as Endpoint.id, which is the unique identifier for the Endpoint resource. The Endpoint.identifier can be shared across multiple Endpoint resources. 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": "Endpoint",
        "id": "91607239-b002-470a-8709-6b25bd50fdd1",
        "meta": {
          "lastUpdated": "2021-10-11T15:01:30+00:00",
          "profile": [
            "http://hl7.org/fhir/structuredefinition/endpoint"
          ]
        },
        "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/dos-service-id",
            "value": "1000099999",
            "display": "Directory of Services (DOS)"
          }
        ],
        "status": "active",
        "name": "Service Endpoint name",
        "connectionType": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
              "code": "hl7-fhir-msg",
              "display": "HL7 FHIR Messaging"
            }
          ]
        },
        "payloadType": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
                "code": "bars",
                "display": "BaRS"
              }
            ]
          }
        ],
        "managingOrganization": [
          {
            "identifier": {
              "system": "https://fhir.nhs.uk/Id/ods-organization-code",
              "value": "X254"
            }
          }
        ],
        "address": "https://myService.nhs.uk/Base/Address",
        "header": "public",
        "period": {
          "start": "2021-10-11T15:01:30+00:00",
          "end": "2021-10-12T15:01:30+00:00"
        }
      }
    }
  ]
}

Changes

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