Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinMayfield committed Jan 10, 2025
1 parent d23c281 commit 5ccce14
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 10 deletions.
40 changes: 34 additions & 6 deletions input/fsh/capability-statement.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,50 @@ InstanceOf: CapabilityStatement
Title: "FHIR Validation (Internal)"
Usage: #definition
* description = """
TODO
This is a summary of the servers requirements. A full CapabilityStatement is available via the [metadata](http://lb-fhir-validator-924628614.eu-west-2.elb.amazonaws.com/swagger-ui/index.html#/FHIR%20Package%20Queries/get_FHIR_R4_metadata) endpoint.
"""
* name = "FHIRValidation"
* status = #draft
* experimental = false
* date = "2025-01-10"
* kind = #requirements
* kind = #instance
* fhirVersion = #4.0.1
* format[+] = #application/fhir+xml
* format[+] = #application/fhir+json
* rest
* mode = #server

* insert Resource(#Questionnaire, Questionnaire)
* insert Resource(#CodeSystem, CodeSystem)
* rest.resource[=]
* documentation = """
TODO
"""
* documentation = "Allows querying of resources loaded into the validator from the implementation guides"
* operation[+]
* name = "$lookup"
* definition = "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"
* documentation = "[lookup](https://www.hl7.org/fhir/R4/operation-codesystem-lookup.html) uses NHS England Terminology Server"
* insert Interaction(#search-type)
* insert SearchParam(url, #uri)


* insert Resource(#ConceptMap, ConceptMap)
* rest.resource[=]
* documentation = "Allows querying of resources loaded into the validator from the implementation guides"
* insert Interaction(#search-type)
* insert SearchParam(url, #uri)


* insert Resource(#ValueSet, ValueSet)
* rest.resource[=]
* documentation = "Allows querying of resources loaded into the validator from the implementation guides"
* operation[+]
* name = "$validate-code"
* definition = "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
* documentation = "[validate-code](https://www.hl7.org/fhir/R4/operation-valueset-validate-code.html) uses NHS England Terminology Server"
* insert Interaction(#search-type)
* insert SearchParam(url, #uri)

* rest.operation[+]
* name = "$validate"
* definition = "http://hl7.org/fhir/OperationDefinition/Resource-validate"
* documentation = "[validate](https://www.hl7.org/fhir/R4/resource-operation-validate.html)"


6 changes: 3 additions & 3 deletions input/pagecontent/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
### FHIR Tools Application

- [FHIR Tools Skunkworks](https://nhsdigital.github.io/interoperability-standards-tools-skunkworks/)
- [Github Repository](https://github.com/NHSDigital/interoperability-standards-tools-skunkworks)
- [GitHub Repository](https://github.com/NHSDigital/interoperability-standards-tools-skunkworks)

This is a web based application which provides a user interface to backaned FHIR Servers. These provide:

Expand All @@ -21,8 +21,8 @@ The application is an [Angular application](https://angular.dev/overview) which

### 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)
- OAS (Swagger) Specification [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/).
Expand Down
2 changes: 1 addition & 1 deletion interoperability-standards-tools-skunkworks
Submodule interoperability-standards-tools-skunkworks updated 56 files
+14 −0 README.md
+11 −11 docs/404.html
+0 −1 docs/main.1d9442c33a0e2c1e.js
+1 −0 docs/main.971fc5f59fc40071.js
+1 −1 docs/styles.d48c690fbeb4f8dc.css
+27 −0 input/images-source/component-diagram.plantuml
+ input/images/component-diagram.png
+5 −4 src/app/api-documentation/api-documentation.component.html
+4 −2 src/app/app-routing.module.ts
+31 −4 src/app/app.module.ts
+2 −0 src/app/concept/concept-display/concept-display.component.html
+0 −0 src/app/concept/concept-display/concept-display.component.scss
+49 −0 src/app/concept/concept-display/concept-display.component.ts
+117 −0 src/app/concept/concept-popup/concept-popup.component.html
+3 −0 src/app/concept/concept-popup/concept-popup.component.scss
+249 −0 src/app/concept/concept-popup/concept-popup.component.ts
+1 −1 src/app/document/document-section/document-section.component.html
+3 −3 src/app/document/document.component.html
+1 −5 src/app/document/document.component.ts
+72 −0 src/app/ecl-builder/ecl-builder.component.html
+6 −0 src/app/ecl-builder/ecl-builder.component.scss
+383 −0 src/app/ecl-builder/ecl-builder.component.ts
+43 −0 src/app/ecl-builder/snomed-ecl-picker/snomed-ecl-picker.component.html
+0 −0 src/app/ecl-builder/snomed-ecl-picker/snomed-ecl-picker.component.scss
+215 −0 src/app/ecl-builder/snomed-ecl-picker/snomed-ecl-picker.component.ts
+9 −0 src/app/eclModel.ts
+5 −2 src/app/info-diaglog/info-diaglog.component.html
+1 −1 src/app/info-diaglog/info-diaglog.component.ts
+1 −1 src/app/markdown/markdown.component.html
+0 −431 src/app/questionnaire/Questionnaire/permission.json
+0 −116 src/app/questionnaire/Questionnaire/prescription-nomination.json
+0 −640 src/app/questionnaire/Questionnaire/vital-signs.json
+227 −0 ...onnaire/questionnaire-definition/questionnaire-definition-item/questionnaire-definition-item.component.html
+26 −0 ...onnaire/questionnaire-definition/questionnaire-definition-item/questionnaire-definition-item.component.scss
+256 −0 ...tionnaire/questionnaire-definition/questionnaire-definition-item/questionnaire-definition-item.component.ts
+20 −0 src/app/questionnaire/questionnaire-definition/questionnaire-definition.component.html
+0 −0 src/app/questionnaire/questionnaire-definition/questionnaire-definition.component.scss
+95 −0 src/app/questionnaire/questionnaire-definition/questionnaire-definition.component.ts
+9 −0 src/app/questionnaire/questionnaire-edit/questionnaire-edit.component.html
+1 −0 src/app/questionnaire/questionnaire-edit/questionnaire-edit.component.scss
+112 −0 src/app/questionnaire/questionnaire-edit/questionnaire-edit.component.ts
+26 −0 src/app/questionnaire/questionnaire-form-display/questionnaire-form.component.html
+0 −0 src/app/questionnaire/questionnaire-form-display/questionnaire-form.component.scss
+334 −0 src/app/questionnaire/questionnaire-form-display/questionnaire-form.component.ts
+99 −0 src/app/questionnaire/questionnaire-information/questionnaire-information.component.html
+3 −0 src/app/questionnaire/questionnaire-information/questionnaire-information.component.scss
+215 −0 src/app/questionnaire/questionnaire-information/questionnaire-information.component.ts
+59 −32 src/app/questionnaire/questionnaire.component.html
+3 −0 src/app/questionnaire/questionnaire.component.scss
+148 −119 src/app/questionnaire/questionnaire.component.ts
+1 −1 src/app/resource-dialog/resource-dialog.component.html
+16 −16 src/app/testing-main/testing-main.component.html
+6 −5 src/app/validate/validate.component.html
+1 −1 src/environments/environment.ts
+7 −7 src/index.html
+2 −2 src/theme.scss
2 changes: 2 additions & 0 deletions sushi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,7 @@ pages:

menu:
Home: index.html
Artefacts: artifacts.html



0 comments on commit 5ccce14

Please sign in to comment.