Skip to content

Commit

Permalink
remove ci
Browse files Browse the repository at this point in the history
  • Loading branch information
declankieran committed Mar 27, 2024
1 parent e457060 commit f32dd14
Show file tree
Hide file tree
Showing 31 changed files with 1 addition and 217 deletions.
1 change: 0 additions & 1 deletion input/ci/queries/0005-add-ra-record-transaction-example.md

This file was deleted.

1 change: 0 additions & 1 deletion input/ci/queries/0006-add-ra-record-transaction-example.md

This file was deleted.

1 change: 0 additions & 1 deletion input/ci/queries/0007-add-ra-record-transaction-example.md

This file was deleted.

1 change: 0 additions & 1 deletion input/ci/queries/0008-get-all-flags.md

This file was deleted.

1 change: 0 additions & 1 deletion input/ci/queries/0009-get-flag-by-category.md

This file was deleted.

1 change: 0 additions & 1 deletion input/ci/queries/0010-get-flag-by-category-and-code.md

This file was deleted.

1 change: 0 additions & 1 deletion input/ci/queries/0011-delete-flag-by-id.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
136 changes: 1 addition & 135 deletions input/pagecontent/server-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,140 +24,6 @@ The HAPI starter project provides an OAS interface to the supported FHIR API. A
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-reasonable-adjustment-record.html).

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-reasonable-adjustment-record.html).

##### Example 1

TODO

##### Example 2

The first example [Bundle transaction](Bundle-AddRARecordTransactionExample1.html) adds an RA record consisting of

* a Patient resource
* a Consent resource
* a (patient) 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-AddRARecordTransactionExample2.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-reasonable-adjustment-record.html).

##### Example 1

For each transaction example provided in the previous section, the following query will performed (dynamically during the IG build)

```
GET /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-AddRARecordTransactionExample1.html)
* [Query output](Bundle-QUERY-OUTPUT--0005-add-ra-record-transaction-example.html)

Second Bundle example:

* [Bundle transaction](Bundle-AddRARecordTransactionExample2.html)
* [Query output](Bundle-QUERY-OUTPUT--0006-add-ra-record-transaction-example.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 /Flag
```

* [Query output](Bundle-QUERY-OUTPUT--0008-get-all-flags.html)

#### Get Flag by Category

**Note:** this requires a [custom SearchParameter](SearchParameter-FlagCategory.html)

Query:
```
GET /Flag?category=NRAF
```

* [Query output](Bundle-QUERY-OUTPUT--0009-get-flag-by-category.html)

#### Get Flag by Category and Code

**Note:** this requires a [custom SearchParameter](SearchParameter-FlagCode.html)

Query:
```
GET /Flag?category=NRAF&code=001
```

* [Query output](Bundle-QUERY-OUTPUT--0010-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](todo.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 /Flag/04adcb5b-3de7-4f67-97f0-b2fdf941ba85
```

* [Query output](OperationOutcome-QUERY-OUTPUT--0011-delete-flag-by-id.html)

#### POST to /Resource

TODO

#### Delete supporting resource

<span style="background-color: #FFFF00">will be covered by remove RA record</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>
All examples and some queries are available in a [Postman collection](assets/postman/postman_collection.json).
75 changes: 0 additions & 75 deletions scripts/run-examples.sh

This file was deleted.

0 comments on commit f32dd14

Please sign in to comment.