Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinMayfield committed Jan 10, 2025
1 parent 38831e7 commit 4cfe71e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 15 deletions.
23 changes: 13 additions & 10 deletions input/images-source/component-frontend.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,28 @@

component "FHIR Tools Application" as tool

interface "FHIR RESTful API" as iAWSFHIRWorks
interface "[[https://github.com/NHSDigital/IOPS-FHIR-Integration-Engine FHIR Integration Engine]]" as iAWSFHIRWorks
note right
Security Facade and
Structured Data Capture Services
Implements
[[https://build.fhir.org/ig/HL7/sdc/ FHIR Structured Data Capture]]
end note

component "Clinical Data Repository" as AWSFHIRWorks
note right
AWS FHIRWorks
[[https://github.com/aws-solutions/fhir-works-on-aws AWS FHIRWorks]]"
end note

interface "[[#validation-serivce FHIR Validation Service]]" as iValidate
note right
Implements
[[https://hl7.org/fhir/R4/validation.html FHIR Validation]]
end note

interface "FHIR RESTful API" as iValidate
component "FHIR Validation Service" as validate

tool -- iAWSFHIRWorks
tool -- iValidate
tool --> iAWSFHIRWorks : FHIR RESTful API
tool --> iValidate : FHIR RESTful API

iAWSFHIRWorks -- AWSFHIRWorks
iValidate -- validate
iAWSFHIRWorks --> AWSFHIRWorks : FHIR RESTful API


@enduml
7 changes: 3 additions & 4 deletions input/pagecontent/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ Github Repository: https://github.com/NHSDigital/interoperability-standards-tool
This is a web based application which provides a user interface to backaned FHIR Servers. These provide:

- Clinical Data Repository provided by an [AWS FHIRWorks](https://github.com/aws-solutions/fhir-works-on-aws), this is surfaced via a security and SDC facade which handles cognito authentication and provides [Structured Data Capture](https://build.fhir.org/ig/HL7/sdc/index.html) capabilities - see [FHIR Integration Engine](https://github.com/NHSDigital/IOPS-FHIR-Integration-Engine).
- [FHIR Validation Service](#backend-service)
- An experimental service to convert openEHR to FHIR Questionnaire is provided by [IOPS openFHIR](https://github.com/NHSDigital/IOPS-openFHIR)
- [FHIR Validation Service](#validation-service)

<figure>
{%include component-frontend.svg%}
Expand All @@ -20,13 +19,13 @@ The application is an [Angular application](https://github.com/NHSDigital/FHIR-V
- [@types/fhir](https://www.npmjs.com/package/@types/fhir) for working with HL7 FHIR objects.
- [Covalent Teradata](https://teradata.github.io/covalent/v8/#/) which builds on Angular Material.

### Backend Service
### Validation Service

[FHIR Development and Testing (FHIR Validation) Skunkworks](http://lb-fhir-validator-924628614.eu-west-2.elb.amazonaws.com/swagger-ui/index.html)
Github Repository: https://github.com/NHSDigital/FHIR-Validation

The Validator is based on [HAPI FHIR Instance Validator](https://hapifhir.io/hapi-fhir/docs/validation/instance_validator.html), which is exposed using a [HAPI FHIR Plain Server](https://hapifhir.io/hapi-fhir/docs/server_plain/server_types.html) which gives an FHIR RESTful API to a [FHIR $validate operation](https://www.hl7.org/fhir/resource-operation-validate.html).
This API is documented via [OpenAPI Specification (swagger)](https://swagger.io/specification/) as part of the service [here](http://lb-fhir-validator-924628614.eu-west-2.elb.amazonaws.com/swagger-ui/index.html)
This API is documented via [OpenAPI Specification (swagger)](https://swagger.io/specification/).

<figure>
{%include component-backend.svg%}
Expand Down
2 changes: 1 addition & 1 deletion sushi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ id: nhs.england.validation
canonical: https://fhir.nhs.uk/England/validation
version: 0.0.1-current
name: NHS_England_Validation
title: "FHIR Validation (internal)"
title: "FHIR Validation (internal/skunkworks)"
description: Internal FHIR Validator used in conjunction with IG publication processes
releaseLabel: ci-build

Expand Down

0 comments on commit 4cfe71e

Please sign in to comment.