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.
package_name: uk.nhsdigital.r4
derivation: constraint
name: SDSEndpoint
type: Endpoint
elements:
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        ExtensionSDSReliabilityConfiguration:
          match: {url: null}
          schema: {type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration', index: 1}
  identifier:
    mustSupport: true
    index: 2
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      min: null
      slices:
        NhsEndpointServiceId:
          match: {system: null}
          schema:
            short: NHS Endpoint Service Id
            pattern:
              type: Identifier
              value: {value: 'https://fhir.nhs.uk/Id/nhsEndpointServiceId'}
            _required: true
            index: 3
          min: 1
          max: 1
        NhsMhsFQDN:
          match: {system: null}
          schema:
            short: NHS Message Handling Service Fully Qualified Domain Name
            pattern:
              type: Identifier
              value: {value: 'https://fhir.nhs.uk/Id/nhsMhsFQDN'}
            _required: true
            index: 4
          min: 1
          max: 1
        NhsMhsPartyKey:
          match: {system: null}
          schema:
            short: NHS Message Handling Service Party Key
            pattern:
              type: Identifier
              value: {value: 'https://fhir.nhs.uk/Id/nhsMhsPartyKey'}
            _required: true
            index: 5
          min: 1
          max: 1
        NhsMhsCPAId:
          match: {system: null}
          schema:
            short: NHS Message Handling Service CPA Identifier
            pattern:
              type: Identifier
              value: {value: 'https://fhir.nhs.uk/Id/nhsMhsCPAId'}
            _required: true
            index: 6
          min: 1
          max: 1
        NhsSpineASID:
          match: {system: null}
          schema:
            short: NHS Spine Accredited System Identifier
            pattern:
              type: Identifier
              value: {value: 'https://fhir.nhs.uk/Id/nhsSpineASID'}
            _required: true
            index: 7
          min: 1
  status: {mustSupport: true, index: 8}
  connectionType: {mustSupport: true, index: 9}
  managingOrganization: {mustSupport: true, index: 10}
  payloadType:
    mustSupport: true
    index: 11
    elements:
      coding:
        index: 12
        elements:
          system:
            pattern: {type: Uri, value: 'http://terminology.hl7.org/CodeSystem/endpoint-payload-type'}
            index: 13
          code:
            pattern: {type: Code, value: any}
            index: 14
          display:
            pattern: {type: String, value: Any}
            index: 15
        required: [display, system, code]
    required: [coding]
  address: {short: 'The technical base address, NhsMhsEndPoint, for connecting to this endpoint', mustSupport: true, index: 16}
package_version: 2.0.19-dev
extensions:
  ExtensionSDSReliabilityConfiguration: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration', type: Extension, mustSupport: true, index: 1}
class: profile
kind: resource
url: https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint
base: http://hl7.org/fhir/StructureDefinition/Endpoint
version: 1.0.0
required: [managingOrganization]