Operation $reindex
In FHIR Search Parameters are dynamic. That means that in addition to the standard Search Parameters custom ones can be added. To support this functionality Kodjin uses index tables. After the new Search Parameter is added, the indexes should be rebuilt for previously created resources.
The $reindex operation rebuilds the indexes for all FHIR resources, except terminology resources like CodeSystem, ValueSet, ConceptMap, and NamingSystem.
This method requires the following Reindex scopes:
- system/kodjin/$reindex
- user/kodjin/$reindex
You can read more about smart-on-FHIR scopes on SMART on FHIR Authorization page
$reindex operation is a resource-consuming operation that might affect the performance of Kodjin. Therefore you should take this fact into account while starting the reindex operation.
Endpoints
POST [fhir_base]/fhir/$reindex
GET [fhir_base]/fhir/reindex/[id]
Query parameters
| In Parameters: | |||
|---|---|---|---|
| Name | Cardinality | Type | Documentation |
| resourceType | 0..* | string | Type of the FHIR resource (Patient, Observation etc.) or * (wildcard) could be used for all resource types |
| resourceId | 0..* | string | ID of the FHIR resource |
| searchParameter | 0..* | string | ID of the SearchParameter |
| Response: | |||
|---|---|---|---|
| Name | Cardinality | Type | Documentation |
| id | 1..1 | string | ID of the reindex. By this ID it is possible to get reindex to check the status of the reindex process. |
| insertedAt | 1..1 | valueDateTime | a timestamp when reindex was inserted to the DB |
| updatedAt | 1..1 | valueDateTime | a timestamp when reindex was updated. During the reindex process this resource is continiously updating, so that the owner of the process could know the status, state of reindex and see the number of updated resources |
| status | 1..1 | valueCode | Status of the reindex process. new, processing, failed, completed |
| request | backboneElement | the whole request which created current reindex process | |
| request.resourceType | 0..* | string | resourceType from the request |
| request.resourceId | 0..* | string | resourceID from the request |
| request.searchParameter | 0..* | string | searchParameter from the request |
| state | backboneElement | the state of reindexing parameters | |
| state.stateByResourceType.resourceType | 1..* | string | the FHIR resource type |
| state.stateByResourceType.resourceId | 1..* | string | the FHIR resource ID |
| state.stateByResourceType.count | 1..1 | valueInteger | the number of reindexed resources in DB type. |
| state.stateByResourceType.error | 0..1 | string | error in reindexing process |
POST interaction starts the reindex process. Reindexing is asynchronous, and the response will include the process ID. You can use this ID to check the status of the process.
GET interaction retrieves the status and all additional information of the reindex process using its ID. The response for both POST and GET interactions are the same.
Statuses of reindex operation:
| Status | Description |
|---|---|
| new | Reindex is just created and is waiting to be processed. |
| processing | Reindex is being processed. During this status state of reindex is being updated continiously. If reindex process failed it will be automatically restarted by the service from the failed point. |
| completed | Reindex was completed. The count shows the total number of reindexed resources, error shows if there were errors during reindex, id is for reindex resources by ID |
| error | In case reindex process is failed and will not be started again, then status will be set to Error. In the "state" there will be an error message(s) and number of reindexed resources if any were reindexed. Depending on error message(s) you should fix an error or repeat reindex process |
In case status of reindex process is Error, reindexer service will try to process this reindex again. The number of reprocessing attempts is a configurable value.
Examples
You can choose resources for reindexing by next filters:
- By resource type
- By resource logical ID
- By SearchParameter ID
Processing each distinct resource type during reindex incurs overhead in terms of database load. It is recommended to avoid including resource types which are not necessary for the reindex, even if those resource types hold a small amount of data.
Here are some examples of running reindex and result of this process:
- Example to reindex all Patient in Kodjin DB.
As a result of this example all Patient resources will be reindexed
Example - reindex all Patient
{
"parameter": [
{
"name": "id",
"valueString": "38955c06-3496-441b-8731-c2827b3a2f2f"
},
{
"name": "insertedAt",
"valueString": "2025-04-01T11:46:02.735482335+00:00"
},
{
"name": "updatedAt",
"valueString": "2025-04-01T11:46:02.735482335+00:00"
},
{
"name": "status",
"valueString": "new"
},
{
"name": "request",
"part": [
{
"name": "resourceType",
"valueString": "Patient"
}
]
},
{
"name": "state",
"part": [
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "Patient"
},
{
"name": "count",
"valueInteger": 0
}
]
}
]
}
],
"resourceType": "Parameters"
}
{
"parameter": [
{
"name": "id",
"valueString": "38955c06-3496-441b-8731-c2827b3a2f2f"
},
{
"name": "insertedAt",
"valueString": "2025-04-01T11:46:02.735+00:00"
},
{
"name": "updatedAt",
"valueString": "2025-04-01T11:46:14.718+00:00"
},
{
"name": "status",
"valueString": "completed"
},
{
"name": "request",
"part": [
{
"name": "resourceType",
"valueString": "Patient"
}
]
},
{
"name": "state",
"part": [
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "Patient"
},
{
"name": "count",
"valueInteger": 121
}
]
}
]
}
],
"resourceType": "Parameters"
}
- Example for parameters for reindex all resourceTypes
Example - reindex all resources
{
"parameter": [
{
"name": "id",
"valueString": "77240e00-205c-483e-9815-5b99ded67c3a"
},
{
"name": "insertedAt",
"valueString": "2025-04-01T11:49:12.804278205+00:00"
},
{
"name": "updatedAt",
"valueString": "2025-04-01T11:49:12.804278205+00:00"
},
{
"name": "status",
"valueString": "new"
},
{
"name": "request",
"part": [
{
"name": "resourceType",
"valueString": "*"
}
]
},
{
"name": "state",
"part": [
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "*"
},
{
"name": "count",
"valueInteger": 0
}
]
}
]
}
],
"resourceType": "Parameters"
}
{
"parameter": [
{
"name": "id",
"valueString": "77240e00-205c-483e-9815-5b99ded67c3a"
},
{
"name": "workerId",
"valueString": "91af2cea-33af-40ac-b54c-03b66c6929b6"
},
{
"name": "insertedAt",
"valueString": "2025-04-01T11:49:12.804+00:00"
},
{
"name": "updatedAt",
"valueString": "2025-04-01T11:49:21.597+00:00"
},
{
"name": "status",
"valueString": "processing"
},
{
"name": "request",
"part": [
{
"name": "resourceType",
"valueString": "*"
}
]
},
{
"name": "state",
"part": [
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "*"
},
{
"name": "count",
"valueInteger": 0
}
]
}
]
}
],
"resourceType": "Parameters"
}
{
"parameter": [
{
"name": "id",
"valueString": "77240e00-205c-483e-9815-5b99ded67c3a"
},
{
"name": "insertedAt",
"valueString": "2025-04-01T11:49:12.804+00:00"
},
{
"name": "updatedAt",
"valueString": "2025-04-01T11:53:29.688+00:00"
},
{
"name": "status",
"valueString": "completed"
},
{
"name": "request",
"part": [
{
"name": "resourceType",
"valueString": "*"
}
]
},
{
"name": "state",
"part": [
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "Account"
},
{
"name": "count",
"valueInteger": 35
}
]
},
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "ActivityDefinition"
},
{
"name": "count",
"valueInteger": 32
}
]
},
...
{
"name": "stateByResourceType",
"part": [
{
"name": "resourceType",
"valueString": "VisionPrescription"
},
{
"name": "count",
"valueInteger": 0
}
]
}
]
}
],
"resourceType": "Parameters"
}