Uploaded image for project: 'Specifications: Reference Model'
  1. Specifications: Reference Model
  2. SPECRM-78

Improve documentation on 'plain text' EHR URIs

    Details

    • Type: Change Request
    • Status: Closed
    • Priority: Minor
    • Resolution: Done
    • Affects versions: Release 1.0.3
    • Fix versions: Release 1.0.4
    • Components: Core IMs
    • Labels:
      None
    • Impact Analysis:
      None.
    • Change Description:
      Hide
      Add text in the following places to indicate that so-called plain-text URIs are allowed, but have to be RFC-3986-encoded for use in machine-processing contexts:
      - text for DV_URI class in UML.
      - text in explanatory section in URI section of RM Data types
      - explanatory text in section 11 (Paths) of Architecture Overview

      Small fixes to text clarity, formatting also added in these sections.

      https://www.openehr.org/releases/RM/latest/docs/data_types/data_types.html#_uri_package
      and
      https://www.openehr.org/releases/BASE/latest/docs/architecture_overview/architecture_overview.html#_ehr_uris
      Show
      Add text in the following places to indicate that so-called plain-text URIs are allowed, but have to be RFC-3986-encoded for use in machine-processing contexts: - text for DV_URI class in UML. - text in explanatory section in URI section of RM Data types - explanatory text in section 11 (Paths) of Architecture Overview Small fixes to text clarity, formatting also added in these sections. https://www.openehr.org/releases/RM/latest/docs/data_types/data_types.html#_uri_package and https://www.openehr.org/releases/BASE/latest/docs/architecture_overview/architecture_overview.html#_ehr_uris

      Description

      Add statements in Architecture Overview and also DV_EHR_URI description also LINK description to indicate that EHR URIs are 'plain text' and need to be RFC3986-encoded when applied to REST APIs or other URI-consuming contexts.

        Attachments

          Issue links

          CR fixes the problem in

          Problem Report - A problem with a deployed instance of the product SPECPR-48 DV_EHR_URI values suggested in architecture overview are not valid against RFC2396

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

            Activity

                People

                • Assignee:
                  Thomas Beale
                  Reporter:
                  Thomas Beale
                  Raised By:
                  Heath Frankel
                  Analyst:
                  Bjørn Næss, Bostjan Lah, Erik Sundvall, Sebastian Garde, Sebastian Iancu, Seref Arikan
                  Acceptance:
                  Boštjan Lah, Diego Bosca, Erik Sundvall, Ian McNicoll, Sebastian Garde, Sebastian Iancu, Shinji KOBAYASHI
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  1 Start watching this issue

                  Dates

                  • Due:
                    Created:
                    Updated:
                    Resolved: