{
  "description": "Defines the constraints and extensions on the Endpoint resource to register a locally hosted, regional, or  national service with the Spine Directory Service for the delivery/retrieval of information.",
  "_filename": "SDS-Endpoint.json",
  "package_name": "uk.nhsdigital.r4",
  "date": "2020-08-07",
  "derivation": "constraint",
  "publisher": "NHS Digital",
  "fhirVersion": "4.0.1",
  "purpose": "An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information. Sufficient information is required to ensure that a connection can be made securely, and appropriate data transmitted as defined by the endpoint owner. This is not a description of details of the current system, as found in CapabilityStatement, but of another (potentially external) system.",
  "name": "SDSEndpoint",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  }, {
    "uri": "http://hl7.org/fhir/fivews",
    "name": "FiveWs Pattern Mapping",
    "identity": "w5"
  } ],
  "abstract": false,
  "copyright": "NHS Digital",
  "type": "Endpoint",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "SDS Endpoint",
  "package_version": "2.1.32-discovery",
  "status": "draft",
  "id": "64678368-1ed9-49a1-b416-284f66a7a7b7",
  "kind": "resource",
  "url": "https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint",
  "version": "1.0.0",
  "differential": {
    "element": [ {
      "id": "Endpoint.extension",
      "path": "Endpoint.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "Endpoint.extension:ExtensionSDSReliabilityConfiguration",
      "path": "Endpoint.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration" ]
      } ],
      "sliceName": "ExtensionSDSReliabilityConfiguration",
      "mustSupport": true
    }, {
      "id": "Endpoint.identifier",
      "path": "Endpoint.identifier",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "system",
          "type": "value"
        } ]
      },
      "mustSupport": true
    }, {
      "id": "Endpoint.identifier:NhsEndpointServiceId",
      "max": "1",
      "min": 1,
      "path": "Endpoint.identifier",
      "short": "NHS Endpoint Service Id",
      "sliceName": "NhsEndpointServiceId",
      "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems."
    }, {
      "id": "Endpoint.identifier:NhsEndpointServiceId.system",
      "path": "Endpoint.identifier.system",
      "fixedUri": "https://fhir.nhs.uk/Id/nhsEndpointServiceId"
    }, {
      "id": "Endpoint.identifier:NhsMhsFQDN",
      "max": "1",
      "min": 1,
      "path": "Endpoint.identifier",
      "short": "NHS Message Handling Service Fully Qualified Domain Name",
      "sliceName": "NhsMhsFQDN",
      "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems."
    }, {
      "id": "Endpoint.identifier:NhsMhsFQDN.system",
      "path": "Endpoint.identifier.system",
      "fixedUri": "https://fhir.nhs.uk/Id/nhsMhsFQDN"
    }, {
      "id": "Endpoint.identifier:NhsMhsPartyKey",
      "max": "1",
      "min": 1,
      "path": "Endpoint.identifier",
      "short": "NHS Message Handling Service Party Key",
      "sliceName": "NhsMhsPartyKey",
      "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems."
    }, {
      "id": "Endpoint.identifier:NhsMhsPartyKey.system",
      "path": "Endpoint.identifier.system",
      "fixedUri": "https://fhir.nhs.uk/Id/nhsMhsPartyKey"
    }, {
      "id": "Endpoint.identifier:NhsMhsCPAId",
      "max": "1",
      "min": 1,
      "path": "Endpoint.identifier",
      "short": "NHS Message Handling Service CPA Identifier",
      "sliceName": "NhsMhsCPAId",
      "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems."
    }, {
      "id": "Endpoint.identifier:NhsMhsCPAId.system",
      "path": "Endpoint.identifier.system",
      "fixedUri": "https://fhir.nhs.uk/Id/nhsMhsCPAId"
    }, {
      "id": "Endpoint.identifier:NhsSpineASID",
      "min": 1,
      "path": "Endpoint.identifier",
      "short": "NHS Spine Accredited System Identifier",
      "sliceName": "NhsSpineASID"
    }, {
      "id": "Endpoint.identifier:NhsSpineASID.system",
      "path": "Endpoint.identifier.system",
      "fixedUri": "https://fhir.nhs.uk/Id/nhsSpineASID"
    }, {
      "id": "Endpoint.status",
      "path": "Endpoint.status",
      "mustSupport": true
    }, {
      "id": "Endpoint.connectionType",
      "path": "Endpoint.connectionType",
      "mustSupport": true
    }, {
      "id": "Endpoint.managingOrganization",
      "min": 1,
      "path": "Endpoint.managingOrganization",
      "mustSupport": true
    }, {
      "id": "Endpoint.payloadType",
      "path": "Endpoint.payloadType",
      "mustSupport": true
    }, {
      "id": "Endpoint.payloadType.coding",
      "max": "1",
      "min": 1,
      "path": "Endpoint.payloadType.coding"
    }, {
      "id": "Endpoint.payloadType.coding.system",
      "min": 1,
      "path": "Endpoint.payloadType.coding.system",
      "fixedUri": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type"
    }, {
      "id": "Endpoint.payloadType.coding.code",
      "min": 1,
      "path": "Endpoint.payloadType.coding.code",
      "fixedCode": "any"
    }, {
      "id": "Endpoint.payloadType.coding.display",
      "min": 1,
      "path": "Endpoint.payloadType.coding.display",
      "fixedString": "Any"
    }, {
      "id": "Endpoint.address",
      "path": "Endpoint.address",
      "short": "The technical base address, NhsMhsEndPoint, for connecting to this endpoint",
      "definition": "The uri that describes the actual end-point to connect to. Represents the NHS Message Handling System (MHS) EndPoint.",
      "mustSupport": true
    } ]
  },
  "contact": [ {
    "name": "NHS Digital",
    "telecom": [ {
      "use": "work",
      "rank": 1,
      "value": "interoperabilityteam@nhs.net",
      "system": "email"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}