About the Documentation

Demystifying the digital architecture of NHS Wales

These documentation pages are aimed at anybody designing, developing and testing applications that will integrate with NHS Wales systems and data.

They are curated by NHS Wales Informatics Service as part of the Digital Health Ecosystem project, but anybody is free to contribute or suggest changes, all you need is a GitHub account, and it’s as easy as clicking on the Edit Me link at the top of any documentation page.

The site is published using GitHub pages and the pages are written in Markdown. This makes it really easy to add diagrams with a code block of Mermaid JS or Plant UML.

Here’s an example of a Mermaid JS sequence diagram - you can use the Mermaid Live Editor to check your syntax

sequenceDiagram
    Doctor ->> Patient: What seems to be the problem?
    Note right of Patient: Patient thinks<br>for a minute

    Patient ->> Doctor: I feel like a pair of curtains
    Doctor ->> Patient: Pull yourself together

Here’s an example of Plant UML Component Diagram - you can use the Plant UML online editor to check your syntax

@startuml

[Component]
[Another component] as Comp2  
component Comp3
component [Last\ncomponent] as Comp4

@enduml