FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagextehr.eu.ehds.models
Resource TypeStructureDefinition
IdStructureDefinition-EHDSEndpoint.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/Xt-EHR/xt-ehr-common/StructureDefinition-EHDSEndpoint.html
URLhttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEndpoint
Version0.2.1
Statusdraft
Date2026-02-04T19:00:50+00:00
NameEHDSEndpoint
TitleEndpoint model
DescriptionEHDS refined base model for Endpoint
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEndpoint
Kindlogical

Resources that use this resource

StructureDefinition
EHDSImagingStudyImaging study model

Resources that this resource uses

StructureDefinition
EHDSOrganisationOrganisation model

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition EHDSEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSEndpoint 0..*BaseEndpoint model
Instances of this logical model can be the target of a Reference
... identifier 1..*IdentifierIdentifier
... status 1..1CodeableConceptStatus
Binding Description: (preferred): hl7:EndpointStatus
... connectionType 1..*CodeableConceptConnection type
Binding Description: (preferred): hl7:endpoint-connection-type
... name 0..1stringName
... managingOrganisation 0..1EHDSOrganisationManaging organisation
... payload 0..*BasePayload
.... type 0..*CodeableConceptType
Binding Description: (preferred): hl7:endpoint-payload-type
.... mimeType 0..*CodeableConceptMime type
Binding Description: (preferred): BCP-13
.... profileCanonical 0..*uriProfile Canonical
.... profileUri 0..*uriProfile uri
... address 1..1uriAddress
... header 0..*stringHeader

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "EHDSEndpoint",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    }
  ],
  "url": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEndpoint",
  "version": "0.2.1",
  "name": "EHDSEndpoint",
  "title": "Endpoint model",
  "status": "draft",
  "date": "2026-02-04T19:00:50+00:00",
  "publisher": "Xt-EHR",
  "contact": [
    {
      "name": "Xt-EHR",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.xt-ehr.eu/"
        }
      ]
    }
  ],
  "description": "EHDS refined base model for Endpoint",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEndpoint",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "EHDSEndpoint",
        "path": "EHDSEndpoint",
        "short": "Endpoint model",
        "definition": "EHDS refined base model for Endpoint",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.identifier",
        "path": "EHDSEndpoint.identifier",
        "short": "Identifier",
        "definition": "Identifier for the organisation that is used to identify the endpoint across multiple disparate systems.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.identifier",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.status",
        "path": "EHDSEndpoint.status",
        "short": "Status",
        "definition": "Status of the endpoint. The endpoint status represents whether the endpoint can currently be used for connections or why it can't be used.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSEndpoint.status",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "hl7:EndpointStatus"
        }
      },
      {
        "id": "EHDSEndpoint.connectionType",
        "path": "EHDSEndpoint.connectionType",
        "short": "Connection type",
        "definition": "A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).",
        "min": 1,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.connectionType",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "hl7:endpoint-connection-type"
        }
      },
      {
        "id": "EHDSEndpoint.name",
        "path": "EHDSEndpoint.name",
        "short": "Name",
        "definition": "A friendly name that this endpoint can be referred to with.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSEndpoint.name",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.managingOrganisation",
        "path": "EHDSEndpoint.managingOrganisation",
        "short": "Managing organisation",
        "definition": "The organisation that provides technical management services for this endpoint.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSEndpoint.managingOrganisation",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.payload",
        "path": "EHDSEndpoint.payload",
        "short": "Payload",
        "definition": "The set of payloads that are provided/available at this endpoint.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.payload",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.payload.type",
        "path": "EHDSEndpoint.payload.type",
        "short": "Type",
        "definition": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.payload.type",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "hl7:endpoint-payload-type"
        }
      },
      {
        "id": "EHDSEndpoint.payload.mimeType",
        "path": "EHDSEndpoint.payload.mimeType",
        "short": "Mime type",
        "definition": "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.payload.mimeType",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "BCP-13"
        }
      },
      {
        "id": "EHDSEndpoint.payload.profileCanonical",
        "path": "EHDSEndpoint.payload.profileCanonical",
        "short": "Profile Canonical",
        "definition": "The FHIR profile that is expected at this endpoint. It describes the resources that are handled, or even simply which resource types.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.payload.profileCanonical",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.payload.profileUri",
        "path": "EHDSEndpoint.payload.profileUri",
        "short": "Profile uri",
        "definition": "The profile (as a uri) that is expected at this endpoint when not represented using a FHIR profile.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.payload.profileUri",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.address",
        "path": "EHDSEndpoint.address",
        "short": "Address",
        "definition": "The uri that describes the actual end-point to connect to.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSEndpoint.address",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.header",
        "path": "EHDSEndpoint.header",
        "short": "Header",
        "definition": "Additional headers / information to send as part of the notification. Usage depends on the channel type.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSEndpoint.header",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "EHDSEndpoint",
        "path": "EHDSEndpoint",
        "short": "Endpoint model",
        "definition": "EHDS refined base model for Endpoint"
      },
      {
        "id": "EHDSEndpoint.identifier",
        "path": "EHDSEndpoint.identifier",
        "short": "Identifier",
        "definition": "Identifier for the organisation that is used to identify the endpoint across multiple disparate systems.",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.status",
        "path": "EHDSEndpoint.status",
        "short": "Status",
        "definition": "Status of the endpoint. The endpoint status represents whether the endpoint can currently be used for connections or why it can't be used.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "hl7:EndpointStatus"
        }
      },
      {
        "id": "EHDSEndpoint.connectionType",
        "path": "EHDSEndpoint.connectionType",
        "short": "Connection type",
        "definition": "A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "hl7:endpoint-connection-type"
        }
      },
      {
        "id": "EHDSEndpoint.name",
        "path": "EHDSEndpoint.name",
        "short": "Name",
        "definition": "A friendly name that this endpoint can be referred to with.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.managingOrganisation",
        "path": "EHDSEndpoint.managingOrganisation",
        "short": "Managing organisation",
        "definition": "The organisation that provides technical management services for this endpoint. ",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.payload",
        "path": "EHDSEndpoint.payload",
        "short": "Payload",
        "definition": "The set of payloads that are provided/available at this endpoint.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.payload.type",
        "path": "EHDSEndpoint.payload.type",
        "short": "Type",
        "definition": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "hl7:endpoint-payload-type"
        }
      },
      {
        "id": "EHDSEndpoint.payload.mimeType",
        "path": "EHDSEndpoint.payload.mimeType",
        "short": "Mime type",
        "definition": "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. ",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "BCP-13"
        }
      },
      {
        "id": "EHDSEndpoint.payload.profileCanonical",
        "path": "EHDSEndpoint.payload.profileCanonical",
        "short": "Profile Canonical",
        "definition": "The FHIR profile that is expected at this endpoint. It describes the resources that are handled, or even simply which resource types.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.payload.profileUri",
        "path": "EHDSEndpoint.payload.profileUri",
        "short": "Profile uri",
        "definition": "The profile (as a uri) that is expected at this endpoint when not represented using a FHIR profile.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.address",
        "path": "EHDSEndpoint.address",
        "short": "Address",
        "definition": "The uri that describes the actual end-point to connect to.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "EHDSEndpoint.header",
        "path": "EHDSEndpoint.header",
        "short": "Header",
        "definition": "Additional headers / information to send as part of the notification. Usage depends on the channel type.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}