Skip to main content

Part of Authoring FHIR terminology resources

Batch adding resources in FHIR Bundles

Previous Chapter

Using a post co-ordinated expression library

Current Chapter

Current chapter – Batch adding resources in FHIR Bundles

View all

Next Chapter

Using system-to-system account credentials

How to batch add resources in FHIR Bundles

Multiple resources can be added to the Terminology Server using the FHIR mechanism of packaging resources in a Bundle. A valid OAuth2 token is required to add resources to the FHIR server (see using system-to-system account credentials for details on obtaining tokens). 

Bundles are POSTed to https://ontology.nhs.uk/authoring/fhir with the Bundle in the body of the request and the authorization token included in a header. A client credentials token is necessary to obtain to authenticate with the Terminology Server. Client id bundle-input has been set up in the base authorization server configuration for this purpose but this may have been removed in your installation. A tool free tool like Postman can be used to obtain tokens and issue requests, or they can be issued on the command line like in these example:

Post bundle example

curl --location --request POST 'https://ontology.nhs.uk/authoring/fhir' \
--header 'Content-Type: application/fhir+xml' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer <!--TOKEN -->' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>Bundle xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir/fhir-single.xsd"><type value="collection"/><entry><resource><!-- ... --></resource></entry></Bundle>'

It is only possible to do this on the Authoring version of the Terminology Server, and not on the staging or production versions of the Terminology Server. 

Last edited: 17 August 2021 5:23 pm

Previous Chapter

Using a post co-ordinated expression library

Next Chapter

Using system-to-system account credentials

Chapters

  1. Authoring FHIR terminology resources
  2. Create a new code system
  3. How to create a new value set
  4. Make a value set that contains an entire code system
  5. Create a new concept map
  6. How to import your resource as a JSON file into Snapper
  7. How to delete a FHIR resource
  8. Modify an existing FHIR resource
  9. Securing a FHIR resource for a community
  10. Resource community permission strategies
  11. Removing community permissions from a resource
  12. Anonymous global read access to a resource
  13. Create a post co-ordinated expression library
  14. Using a post co-ordinated expression library
  15. Batch adding resources in FHIR Bundles
  16. Using system-to-system account credentials