all examples in one page, added more queries

input/fsh/examples/0000-flag-category-searchparameter.fsh

@@ -0,0 +1,13 @@
+Instance: 0000-flag-category-searchparameter
+InstanceOf: SearchParameter
+Usage: #definition
+* url = "http://localhost:8080/fhir/SearchParameter/FlagCategory"
+* version = "1"
+* name = "Search for Flag.category"
+* status = #active
+* description = "Search by category in the Flag resource"
+* code = #category
+* base = #Flag
+* type = #token
+* expression = "Flag.category"
+* xpathUsage = #normal

input/fsh/examples/0000-flag-code-searchparameter.fsh

@@ -0,0 +1,13 @@
+Instance: 0000-flag-code-searchparameter
+InstanceOf: SearchParameter
+Usage: #definition
+* url = "http://localhost:8080/fhir/SearchParameter/FlagCode"
+* version = "1"
+* name = "Search for Flag.code"
+* status = #active
+* description = "Search by code in the Flag resource"
+* code = #code
+* base = #Flag
+* type = #token
+* expression = "Flag.code"
+* xpathUsage = #normal

input/pagecontent/add-ra-record.md

@@ -36,7 +36,7 @@ The practioner decides to record a condition.  This could be done with individua
 #### Example 2  
 
 <p>
-<a href="server-example-add-ra-record.html#example-2">The first example</a> given here shows the use of a transaction to add all required resources to add a Consent, a Condition and associated adjustments (Flag) resources for a patient.  
+<a href="server-examples.html#example-2">The first example</a> given here shows the use of a transaction to add all required resources to add a Consent, a Condition and associated adjustments (Flag) resources for a patient.  
 
 The master Flag and condition Flag (and associated Condition) resources are included and have the Provence resource as contained resources.  This example could be modified to include a new condition just by adding the new Condition and Flag resource as this transaction is fully idempotent.  The next example will show this.
 </p>
@@ -48,7 +48,7 @@ The master Flag and condition Flag (and associated Condition) resources are incl
 </p>
 
 <p>
-<a href="server-example-add-ra-record.html#example-2">The second example</a> given here simply adds conditions to the previous transaction resource to demonstrate the ability to add new conditions to the same data structure and reply in an idempotent way.  The request entry in the transaction Bundle for the second condition uses the uuid from the fullUrl on the Bundle entry to use in the URL for the PUT method.  The first uses the patient uuid as a search parameter for the PUT.  A uuid would be the preferred method to construct the uuid for the fullUrl in the Bundle entry, so this should be a reasonable example.  This example is just to demonstrate ReSTful capabilities of the FHIR spec.
+<a href="server-examples.html#example-2">The second example</a> given here simply adds conditions to the previous transaction resource to demonstrate the ability to add new conditions to the same data structure and reply in an idempotent way.  The request entry in the transaction Bundle for the second condition uses the uuid from the fullUrl on the Bundle entry to use in the URL for the PUT method.  The first uses the patient uuid as a search parameter for the PUT.  A uuid would be the preferred method to construct the uuid for the fullUrl in the Bundle entry, so this should be a reasonable example.  This example is just to demonstrate ReSTful capabilities of the FHIR spec.
 </p>
 
 [Example Transaction: Additional condition and flag added to previous Transaction](Bundle-0001-add-condition-transaction-example.html).  

input/pagecontent/retrieve-condition.md → input/pagecontent/retrieve-ra-record.md

@@ -6,8 +6,8 @@
 
 A patient presents to be examined by a practitioner. The Practioner perofrms an examination and retrieve Patient's RA Record.
 
-##### Condition Retrieved
+##### Patients RA Record Retrieved
 
 <div>
-    <img style="max-width: 70%" alt="Activity created in draw.io!" src="Retrieve-Condition.drawio.png"/>
+    <img style="max-width: 70%" alt="Patients RA Record Retrieved" src="retrieve-condition.drawio.png"/>
 </div>Todo

input/pagecontent/server-examples.md

@@ -0,0 +1,153 @@
+### Summary
+
+The [HAPI FHIR Starter Server](https://github.com/hapifhir/hapi-fhir-jpaserver-starter) is used to demostrate some basic REST capabilities in FHIR using examples within this implementation guide.
+
+#### Docker invocation of the HAPI Starter Project
+
+This command starts the server on port 8080 and use UUID (as opposed to sequential numbers) for resource ID's.
+
+```
+docker run -p 8080:8080 -e hapi.fhir.daoconfig_client_id_strategy=UUID -e hapi.fhir.client_id_strategy=ANY hapiproject/hapi:latest
+```
+
+To pull the latest image, run
+
+```
+docker pull hapiproject/hapi:latest
+```
+
+#### Swagger
+
+The HAPI starter project provides an OAS interface to the supported FHIR API.  Assuming the above docker command is used, this would be available at
+
+```
+http://localhost:8080/fhir/swagger-ui/index.html
+```
+
+#### CI Build
+
+These examples are loaded into a running FHIR server during the IG build.  Some resources (queries) are dynamically generated and added to the IG at build time.  (TODO add a list of dynamically generated resources somewhere).
+
+#### Postman
+
+All examples are available in a [Postman collection](assets/postman/postman_collection.json).
+
+### Examples
+
+The examples here describe the API options related to the workflow given in the use case [Add RA Record](add-ra-record.html#workflow).
+
+See the [Data Model](data-model.html) for details on the relationships between the resources.  
+
+#### Add RA Record
+
+This section provides examples for those given in the use case [Add RA Record](add-ra-record.html#workflow).
+
+##### Example 1
+
+TODO
+
+##### Example 2
+
+The first example [Bundle transaction](Bundle-0001-add-condition-transaction-example.html) adds an RA record consisting of 
+* a Patient resource
+* a Consent resource 
+* a (master) Flag resource (<span style="background-color: #FFFF00">is this really needed?</span>) 
+* a Condition resource (associated with the following Flag)
+* a Flag resource (associated with the Condition)
+These resources are contained in a transaction Bundle, which provides atomicity as well as a more network efficent call.  
+
+Each Flag resource (<span style="background-color: #FFFF00">TODO embed in all or make separate</>)has a Provenance resource embedded in it.  (<span style="background-color: #FFFF00">TODO maybe a futher discussion section somewhere on options for provenance, i.e. linking to versions, _history and transaction considerations, options to use etag or X-provenance</span>).  
+
+Another example [Bundle transaction](Bundle-0002-add-condition-transaction-example.html) modifies the first transaction by adding additional resources for another Condition and adjustment (Flag).  
+
+The transactions are using PUT's to provide (upsert)[https://hl7.org/fhir/http.html#upsert] functionality.  The HAPI Starter Server (provided via docker) supports this part of the specification.
+
+#### Retrieve RA Record
+
+This section provides examples for those given in the use case [Retrieve RA Record](retrieve-ra-record.html#workflow).
+
+##### Example 1
+
+For each transaction example provided in the previous section, the following query will performed (dynamically during the IG build)  
+
+```
+<base>/Patient?identifier=9912003888&_revinclude=Consent:patient&_revinclude=Flag:patient&_revinclude=Condition:patient  
+```
+
+This query will return the Patient resource using the patients NHS number (<span style="background-color: #FFFF00">TODO will be profiled to check for this, reference this later</span>).  The assocaited resources that make up the RA are also returned, such as  
+* Consent resources (<span style="background-color: #FFFF00">maybe link to profiles here</span>)  
+* Flag resources  
+* Condition resources  
+which are all returned using default Patient SearchParameters (defined in the base specification).   
+
+First Bundle example:  
+* [Bundle transaction](Bundle-0001-add-condition-transaction-example.html)  
+* [Query output](Bundle-QUERY-OUTPUT--0001-add-condition-transaction-example.1.html)  
+
+Second Bundle example:  
+* [Bundle transaction](Bundle-0002-add-condition-transaction-example.html)  
+* [Query output](Bundle-QUERY-OUTPUT--0002-add-condition-transaction-example.2.html)  
+
+#### Remove RA Record
+
+This section provides examples for those given in the use case [Remove RA Record](todo.html).
+
+##### Example 1
+
+TODO (@vickyjaiswal0308)
+
+### Other Query Examples
+
+These queries are ran after all other write (Create, Update) examples and corresponding queries have been ran.
+
+#### Read all Flags
+
+Query:
+```
+GET <base>/Flag
+```
+
+* [Query output](Bundle-QUERY-OUTPUT--READ-0001-get-all-flags.html)
+
+#### Get Flag by Category
+
+**Note:** this requires a [custom SearchParameter](0000-flag-category.searchparameter.html)
+
+Query:
+```
+GET <base>/Flag?category=NRAF
+```
+* [Query output](Bundle-QUERY-OUTPUT--READ-0002-get-flag-by-category.html)
+
+#### Get Flag by Category and Code
+
+**Note:** this requires a [custom SearchParameter](0000-flag-category.searchparameter.html)
+
+Query:
+```
+GET <base>/Flag?category=NRAF&code=001
+```
+* [Query output](Bundle-QUERY-OUTPUT--READ-0002-get-flag-by-category-and-code.html)
+
+#### Get Flag by Category and Code and supporting resources
+
+**Note:** this requires [an extension] to link to the supporting resources and a [custom SearchParameter](0000-flag-category.searchparameter.html) to allow for the use of [_include parameters](https://www.hl7.org/fhir/search.html#include)
+
+* [Query output](todo.html)
+
+#### Delete Flag by ID
+
+Query:
+```
+GET <base>/Flag/04adcb5b-3de7-4f67-97f0-b2fdf941ba85
+```
+
+* [Query output](OperationOutcome-QUERY-OUTPUT--DELETE-0008-delete-flag-by-id.html)
+
+#### POST to /Resource Delete supporting resource
+
+<span style="background-color: #FFFF00">Not sure what this mean, is this beyond a transaction, i.e. use a post to delete, its not defined in FHIR and not really considered valid in REST either...</span>
+
+#### Delete a resource using it's ID
+
+<span style="background-color: #FFFF00">This seems to be covered in section 'Delete Flag by ID'?</span>

input/queries/DELETE-0008-delete-flag-by-id.md

@@ -0,0 +1 @@
+Flag/04adcb5b-3de7-4f67-97f0-b2fdf941ba85

input/queries/READ-0001-get-all-flags.md

@@ -0,0 +1 @@
+Flag/

input/queries/READ-0002-get-flag-by-category.md

@@ -0,0 +1 @@
+Flag?category=NRAF

input/queries/READ-0003-get-flag-by-category-and-code.md

@@ -0,0 +1 @@
+Flag?category=NRAF&code=001