NHnhs
Endpoint

Get a Specific Endpoint

Read operation for a specific Endpoint

get/Endpoint/{id}

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/{id}
  • Auth
    HTTP bearer

Response

The Operation was Successful

resourceTypestring
idstring uuid
statusstring
namestring
addressstring url
headerstring

Example response

{
  "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.