1.1.0
Change Log
in BaRS 1.8.0
| Change | Description | Impact |
|---|---|---|
| The https://fhir.nhs.uk/Id/dos-service-id examples now correcly show as https. | correction | |
| The example deviceName element in NHSD-Requesting-Software now shows correctly as an Object as defined by the schema | correction | |
| Appointment and ServiceRequest Features corrected. | Additional Verbs have been correctly introduced to the 1.1.0 specificiation as a correction. | Addition |
Appointment
The following endpoints have been added to the 1.1.0 specification as a correction. These endpoints will be used in future use cases and future iterations of current use cases.
- POST /Appointment/[id]
- PUT /Appointment/[id]
- PATCH /Appointment/[id]
- DELETE /Appointment/[id]
ServiceRequest
The following endpoints have been added to the 1.1.0 specification as a correction. These endpoints will be used in future use cases and future iterations of current use cases.
- POST /ServiceRequest/[id]
- PUT /ServiceRequest/[id]
- PATCH /ServiceRequest/[id]
- DELETE /ServiceRequest/[id]
in BaRS 1.5.0
BaRS 1.5.0
| Change | Description | Impact |
|---|---|---|
| Improvement to DocumentReference Schema | the DocumentReference Schemas have been flattend for easier consumption | correction |
This Section will list all updates to the BaRS API Specification within the 1.1.0 minor release. Note this version is still in development
Initial release
| Change | Description | Impact |
|---|---|---|
| Publication of the 1.1.0 Specification along side 1.0.0 | 1.1.0 Specification (alpha) launched | Addition |
| Additions of DocumentReference Endpoints | Additional header item and requirement changes for existing headers | Addition |
| Additions of use cases to context parameter example for GET /MessageDefinition | New parameter additions | correction |
| Example MessageDefinitions now contain a context code for use case. | updated examples | correction |
| Guidance and QoL changes | Guidance updates and corrections | correction |
| General | Corrections and general changes. | correction |
Publication of the 1.1.0 API Specification (in development)
The API Spec page will now have a landing page to select the version of which you wish to view. At present this will present 1.0.0 and 1.1.0, with links to each specification.
DocumentReference
DocumentReference Endpoints have been added to the specification in preparation for future use cases.
The following endpoints are now available in the 1.1.0 specification. These endpoints will be used in future use cases and future iterations of current use cases.
- GET /DocumentReference
- POST /DocumentReference
- GET /DocumentReference/[id]
- PUT /DocumentReference/[id]
- DELETE /DocumentReference/[id]
Parameters
The context parameter for GET /MessageDefinition has been amended to accept a use case filter
The target service identifier, Allowing the ability to filter returned message definitions by the specified service id, In this example a DoS id, can now be coupled
/MessageDefinition?context=http://fhir.nhs.uk/Id/dos-service-id|2000099999&context=https://fhir.nhs.uk/CodeSystem/usecases-categories-bars|REFERRALTOPHARMACY
Guidance and QOL
Additional Guidance for the GET /Slot endpoint.
Further guidance surrounding the usage of the include query parameter for GET /Slot has been added.
General
Further Typos and/or spelling and grammar errors have been corrected