We're updating the issue view to help you get more done.Learn more

Improve documentation on 'plain text' EHR URIs

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.

Status

Assignee

Thomas Beale

Reporter

Thomas Beale

Raised By

Heath Frankel

Impact Analysis

None.

Analyst

Seref Arikan
Sebastian Iancu
Sebastian Garde
Erik Sundvall
Bostjan Lah
Bjørn Næss

Change Description

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

Acceptance

Shinji KOBAYASHI
Sebastian Iancu
Sebastian Garde
Ian McNicoll
Erik Sundvall
Diego Bosca
Boštjan Lah

Components

Fix versions

Affects versions

Release 1.0.3

Due date

2018/11/30

Priority

Minor