DK EER Endpoint Register (EER)
0.8.0 - ci-build Denmark flag

DK EER Endpoint Register (EER), published by . This guide is not an authorized publication; it is the continuous build for version 0.8.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-ehmi-eer/ and changes regularly. See the Directory of published versions

Extension: EerDigitalSignatureExtension - Detailed Descriptions

Draft as of 2024-11-21

Definitions for the eer-dk-digital-signature-extension extension.

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

0. Extension
Definition

EER Digital Signature for eDelivery Extension

ShortEER Digital Signature for eDelivery Extension
2. Extension.url
Fixed Valuehttp://medcomehmi.dk/ig/dk-ehmi-eer/StructureDefinition/eer-dk-digital-signature-extension
4. Extension.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 6. Extension.value[x]:valueSignature
    Slice NamevalueSignature
    Control0..1
    TypeSignature
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    8. Extension.value[x]:valueSignature.sigFormat
    Control1..?
    10. Extension.value[x]:valueSignature.data
    Control1..?

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

    0. Extension
    Definition

    EER Digital Signature for eDelivery Extension


    Optional Extension Element - found in all resources.

    ShortEER Digital Signature for eDelivery ExtensionOptional Extensions Element
    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    2. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://medcomehmi.dk/ig/dk-ehmi-eer/StructureDefinition/eer-dk-digital-signature-extension
    4. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control0..1
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 6. Extension.value[x]:valueSignature
      Slice NamevalueSignature
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control0..1
      TypeSignature, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Extension.value[x]:valueSignature.type
      Definition

      An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.

      ShortIndication of the reason the entity signed the object(s)
      Comments

      Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".

      Control1..*
      BindingThe codes SHOULD be taken from SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type
      (preferred to http://hl7.org/fhir/ValueSet/signature-type)

      An indication of the reason that an entity signed the object.

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Extension.value[x]:valueSignature.when
      Definition

      When the digital signature was signed.

      ShortWhen the signature was created
      Comments

      This should agree with the information in the signature.

      Control1..1
      Typeinstant
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Extension.value[x]:valueSignature.who
      Definition

      A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

      ShortWho signed
      Comments

      This should agree with the information in the signature.

      Control1..1
      TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. Extension.value[x]:valueSignature.sigFormat
      Definition

      A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.

      ShortThe technical format of the signature
      Control10..1
      BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
      (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

      The mime type of an attachment. Any valid mime type is allowed.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Extension.value[x]:valueSignature.data
      Definition

      The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

      ShortThe actual signature content (XML DigSig. JWS, picture, etc.)
      Comments

      Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form.

      Control10..1
      Typebase64Binary
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

      0. Extension
      Definition

      EER Digital Signature for eDelivery Extension

      ShortEER Digital Signature for eDelivery Extension
      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      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())
      2. Extension.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. Extension.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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://medcomehmi.dk/ig/dk-ehmi-eer/StructureDefinition/eer-dk-digital-signature-extension
        8. Extension.value[x]
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortValue of extension
        Control0..1
        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 10. Extension.value[x]:valueSignature
          Slice NamevalueSignature
          Definition

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          ShortValue of extension
          Control0..1
          TypeSignature
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. Extension.value[x]:valueSignature.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
          14. Extension.value[x]:valueSignature.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 Extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Extension.value[x]:valueSignature.type
            Definition

            An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.

            ShortIndication of the reason the entity signed the object(s)
            Comments

            Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".

            Control1..*
            BindingThe codes SHOULD be taken from SignatureTypeCodes
            (preferred to http://hl7.org/fhir/ValueSet/signature-type)

            An indication of the reason that an entity signed the object.

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            18. Extension.value[x]:valueSignature.when
            Definition

            When the digital signature was signed.

            ShortWhen the signature was created
            Comments

            This should agree with the information in the signature.

            Control1..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Extension.value[x]:valueSignature.who
            Definition

            A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

            ShortWho signed
            Comments

            This should agree with the information in the signature.

            Control1..1
            TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. Extension.value[x]:valueSignature.onBehalfOf
            Definition

            A reference to an application-usable description of the identity that is represented by the signature.

            ShortThe party represented
            Comments

            The party that can't sign. For example a child.

            Control0..1
            TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
            Is Modifierfalse
            Summarytrue
            Requirements

            used when the signature is on behalf of a non-signer.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Extension.value[x]:valueSignature.targetFormat
            Definition

            A mime type that indicates the technical format of the target resources signed by the signature.

            ShortThe technical format of the signed resources
            Comments

            "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

            Control0..1
            BindingThe codes SHALL be taken from Mime Types
            (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

            The mime type of an attachment. Any valid mime type is allowed.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Extension.value[x]:valueSignature.sigFormat
            Definition

            A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.

            ShortThe technical format of the signature
            Control1..1
            BindingThe codes SHALL be taken from Mime Types
            (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

            The mime type of an attachment. Any valid mime type is allowed.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            28. Extension.value[x]:valueSignature.data
            Definition

            The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

            ShortThe actual signature content (XML DigSig. JWS, picture, etc.)
            Comments

            Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form.

            Control1..1
            Typebase64Binary
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))