7.2.1Partition Mapping Operations

Several operations exist that can be used to manage the existence of partitions. These operations are supplied by a plain provider called PartitionManagementProvider.

Before a partition can be used, it must be registered using these methods.

7.2.2Creating a Partition

The $partition-management-create-partition operation can be used to create a new partition. This operation takes the following parameters:

7.2.2.1Example

Note that once multitenancy is enabled, all requests to the FHIR server must contain a tenant. These operations are no exception. If you fail to include a tenant identifier in the request, an error will be returned.

An HTTP POST to the following URL would be used to invoke this operation. Notice that we use the DEFAULT partition, as it always exists by default. http://example.com/DEFAULT/$partition-management-create-partition

The following request body could be used:

{
  "resourceType": "Parameters",
  "parameter": [ {
    "name": "id",
    "valueInteger": 123
  }, {
    "name": "name",
    "valueCode": "PARTITION-123"
  }, {
    "name": "description",
    "valueString": "a description"
  } ]
}

7.2.3Updating a Partition

The $partition-management-update-partition operation can be used to update an existing partition. This operation takes the following parameters:

7.2.3.1Example

An HTTP POST to the following URL would be used to invoke this operation: http://example.com/DEFAULT/$partition-management-update-partition

The following request body could be used:

{
  "resourceType": "Parameters",
  "parameter": [ {
    "name": "id",
    "valueInteger": 123
  }, {
    "name": "name",
    "valueCode": "PARTITION-123"
  }, {
    "name": "description",
    "valueString": "a description"
  } ]
}

7.2.4Deleting a Partition

The $partition-management-delete-partition operation can be used to delete an existing partition. This operation takes the following parameters:

7.2.4.1Example

An HTTP POST to the following URL would be used to invoke this operation: http://example.com/DEFAULT/$partition-management-delete-partition

The following request body could be used:

{
  "resourceType": "Parameters",
  "parameter": [ {
    "name": "id",
    "valueInteger": 123
  } ]
}

7.2.5Reading a Partition

The $partition-management-read-partition operation can be used to read an existing partition. This operation takes the following parameters:

7.2.5.1Example

An HTTP POST to the following URL would be used to invoke this operation: http://example.com/DEFAULT/$partition-management-read-partition

The following request body could be used:

{
  "resourceType": "Parameters",
  "parameter": [ {
    "name": "id",
    "valueInteger": 123
  } ]
}

7.2.6Listing all Partitions

The $partition-management-list-partitions operation can be used to list all existing partitions.

7.2.6.1Example

An HTTP POST to the following URL would be used to invoke this operation: http://example.com/DEFAULT/$partition-management-list-partitions

This operation returns a Parameters resource that looks like the following:

{
    "resourceType": "Parameters",
    "parameter": [ {
       "name": "partition",
       "part": [ {
          "name": "id",
          "valueInteger": 1
        }, {
          "name": "name",
          "valueCode": "PARTITION-1"
        }, {
          "name": "description",
          "valueString": "a description1"
        } ]
      }, {
       "name": "partition",
       "part": [ {
          "name": "id",
          "valueInteger": 2
       }, {
          "name": "name",
          "valueCode": "PARTITION-2"
       }, {
          "name": "description",
          "valueString": "a description2"
       } ]
    } ]
}