Koppelmij Implementation Guide
0.1.0 - ci-build

Koppelmij Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: LmEnpoint - Detailed Descriptions

Active as of 2026-05-08

Definitions for the pt-lm-Endpoint logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. pt-lm-Endpoint
Definition

This (FHIR) Endpoint profile represents the technical FHIR REST endpoint of a source system (XIS), used by a ProviderModule to retrieve and update task data and the required context for the ProviderModule use case.


Base definition for all elements in a resource.

ShortEndpointBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. pt-lm-Endpoint.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. pt-lm-Endpoint.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on pt-lm-Endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. pt-lm-Endpoint.ClientId
    Definition

    Client identifier used as 'audience' in the DVA token exchange (Endpoint extension).

    ShortClient identifier used as 'audience' in the DVA token exchange (Endpoint extension).
    Comments

    Maps to Endpoint.extension('http://medmij.nl/fhir/StructureDefinition/ext-ClientID').valueString

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. pt-lm-Endpoint.managingOrganization
    Definition

    The organization responsible for operating and maintaining this FHIR REST endpoint (the source system/XIS) that exposes ProviderModule task data and related context.

    ShortThe organization responsible for operating and maintaining this FHIR REST endpoint (the source system/XIS) that exposes ProviderModule task data and related context.
    Control0..1
    TypeReference(Organization)
    10. pt-lm-Endpoint.Adress
    Definition

    FHIR resource endpoint

    ShortFHIR resource endpoint
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

    Guidance on how to interpret the contents of this table can be foundhere

    0. pt-lm-Endpoint
    Definition

    This (FHIR) Endpoint profile represents the technical FHIR REST endpoint of a source system (XIS), used by a ProviderModule to retrieve and update task data and the required context for the ProviderModule use case.

    ShortEndpoint
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. pt-lm-Endpoint.ClientId
    Definition

    Client identifier used as 'audience' in the DVA token exchange (Endpoint extension).

    ShortClient identifier used as 'audience' in the DVA token exchange (Endpoint extension).
    Comments

    Maps to Endpoint.extension('http://medmij.nl/fhir/StructureDefinition/ext-ClientID').valueString

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. pt-lm-Endpoint.managingOrganization
    Definition

    The organization responsible for operating and maintaining this FHIR REST endpoint (the source system/XIS) that exposes ProviderModule task data and related context.

    ShortThe organization responsible for operating and maintaining this FHIR REST endpoint (the source system/XIS) that exposes ProviderModule task data and related context.
    Control0..1
    TypeReference(Organization)
    6. pt-lm-Endpoint.Adress
    Definition

    FHIR resource endpoint

    ShortFHIR resource endpoint
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

    Guidance on how to interpret the contents of this table can be foundhere

    0. pt-lm-Endpoint
    Definition

    This (FHIR) Endpoint profile represents the technical FHIR REST endpoint of a source system (XIS), used by a ProviderModule to retrieve and update task data and the required context for the ProviderModule use case.

    ShortEndpoint
    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    2. pt-lm-Endpoint.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    4. pt-lm-Endpoint.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on pt-lm-Endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. pt-lm-Endpoint.ClientId
      Definition

      Client identifier used as 'audience' in the DVA token exchange (Endpoint extension).

      ShortClient identifier used as 'audience' in the DVA token exchange (Endpoint extension).
      Comments

      Maps to Endpoint.extension('http://medmij.nl/fhir/StructureDefinition/ext-ClientID').valueString

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      8. pt-lm-Endpoint.managingOrganization
      Definition

      The organization responsible for operating and maintaining this FHIR REST endpoint (the source system/XIS) that exposes ProviderModule task data and related context.

      ShortThe organization responsible for operating and maintaining this FHIR REST endpoint (the source system/XIS) that exposes ProviderModule task data and related context.
      Control0..1
      TypeReference(Organization)
      10. pt-lm-Endpoint.Adress
      Definition

      FHIR resource endpoint

      ShortFHIR resource endpoint
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension