FHIR IG Statistics: StructureDefinition/SDS-Endpoint

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "SDS-Endpoint",
  "url": "https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint",
  "version": "1.0.0",
  "name": "SDSEndpoint",
  "title": "SDS Endpoint",
  "status": "draft",
  "date": "2020-08-07",
  "publisher": "NHS Digital",
  "contact": [
    {
      "name": "NHS Digital",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work",
          "rank": 1
        }
      ]
    }
  ],
  "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.",
  "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.",
  "copyright": "NHS Digital",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Endpoint",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Endpoint",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Endpoint.extension",
        "path": "Endpoint.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Endpoint.extension:ExtensionSDSReliabilityConfiguration",
        "path": "Endpoint.extension",
        "sliceName": "ExtensionSDSReliabilityConfiguration",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Endpoint.identifier",
        "path": "Endpoint.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "mustSupport": true
      },
      {
        "id": "Endpoint.identifier:NhsEndpointServiceId",
        "path": "Endpoint.identifier",
        "sliceName": "NhsEndpointServiceId",
        "short": "NHS Endpoint Service Id",
        "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Endpoint.identifier:NhsEndpointServiceId.system",
        "path": "Endpoint.identifier.system",
        "fixedUri": "https://fhir.nhs.uk/Id/nhsEndpointServiceId"
      },
      {
        "id": "Endpoint.identifier:NhsMhsFQDN",
        "path": "Endpoint.identifier",
        "sliceName": "NhsMhsFQDN",
        "short": "NHS Message Handling Service Fully Qualified Domain Name",
        "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Endpoint.identifier:NhsMhsFQDN.system",
        "path": "Endpoint.identifier.system",
        "fixedUri": "https://fhir.nhs.uk/Id/nhsMhsFQDN"
      },
      {
        "id": "Endpoint.identifier:NhsMhsPartyKey",
        "path": "Endpoint.identifier",
        "sliceName": "NhsMhsPartyKey",
        "short": "NHS Message Handling Service Party Key",
        "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Endpoint.identifier:NhsMhsPartyKey.system",
        "path": "Endpoint.identifier.system",
        "fixedUri": "https://fhir.nhs.uk/Id/nhsMhsPartyKey"
      },
      {
        "id": "Endpoint.identifier:NhsMhsCPAId",
        "path": "Endpoint.identifier",
        "sliceName": "NhsMhsCPAId",
        "short": "NHS Message Handling Service CPA Identifier",
        "definition": "Identifier for the service that is used to identify the endpoint across multiple disparate systems.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Endpoint.identifier:NhsMhsCPAId.system",
        "path": "Endpoint.identifier.system",
        "fixedUri": "https://fhir.nhs.uk/Id/nhsMhsCPAId"
      },
      {
        "id": "Endpoint.identifier:NhsSpineASID",
        "path": "Endpoint.identifier",
        "sliceName": "NhsSpineASID",
        "short": "NHS Spine Accredited System Identifier",
        "min": 1
      },
      {
        "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",
        "path": "Endpoint.managingOrganization",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Endpoint.payloadType",
        "path": "Endpoint.payloadType",
        "mustSupport": true
      },
      {
        "id": "Endpoint.payloadType.coding",
        "path": "Endpoint.payloadType.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Endpoint.payloadType.coding.system",
        "path": "Endpoint.payloadType.coding.system",
        "min": 1,
        "fixedUri": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type"
      },
      {
        "id": "Endpoint.payloadType.coding.code",
        "path": "Endpoint.payloadType.coding.code",
        "min": 1,
        "fixedCode": "any"
      },
      {
        "id": "Endpoint.payloadType.coding.display",
        "path": "Endpoint.payloadType.coding.display",
        "min": 1,
        "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
      }
    ]
  }
}