Endpoint

Update a Specific Endpoint

Creates a new current version for an existing resource (update) or creates an initial version if no resource already exists for the given id (new).

Only the owner of an Endpoint can modify it.

put/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

Request body

resourceTypestring

idstring uuid

statusstring

namestring

addressstring url

headerstring

Example request

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

Response

The Operation was Successful