Type operation reindex

Must be executed asynchronously

Re-index the resources with OpenSearch

Applies to: Account, AllergyIntolerance, Appointment, Basic, CarePlan, CareTeam, ChargeItem, ConceptMap, Condition, Consent, Coverage, Device, DiagnosticReport, DocumentReference, Encounter, Endpoint, EpisodeOfCare, ExplanationOfBenefit, FamilyMemberHistory, Goal, Group, HealthcareService, Immunization, InsurancePlan, Location, MedicationAdministration, MedicationDispense, MedicationRequest, Observation, Organization, OrganizationAffiliation, Patient, Practitioner, PractitionerRole, Procedure, Provenance, QuestionnaireResponse, RelatedPerson, ServiceRequest, Specimen, Task

Requires the CanManageIndexes user permission.

Requires the orcs/index-management scope.

In parameters

Name Cardinality Type Documentation
batch-size 0..1 PositiveInt

Number of resources to be processed in a single batch. If not specified the system uses the default value set via environment variables. Used only when {Parameters.Mode} is '{Mode.Start}'.

concurrent 0..1 PositiveInt

How many concurrent processes to use. Optional, defaults to 1, maximum value 4096. Used only when mode is 'Start'.

index 0..* String

Names of the search parameters to re-index. If not specified all defined search parameters are re-indexed. If specified all resources must already be indexed and the data for the specified parameters update the existing indexed data. Used only when mode is 'Start'.

mode 0..1 Code

What to do: 'Start' the re-indexing from scratch, 'Check' the status of an already started re-indexing, or 'Continue' a re-indexing that stopped for some kind of error (typically time-outs). Defaults to 'Start'

since 0..1 Instant

Re-index only resources that have changed after the supplied time. If not specified all resources are re-indexed. Used only when {Parameters.Mode} is '{Mode.Start}'.

Out parameters

Name Cardinality Type Documentation
count 1..1 Decimal

Number of resources that have been re-indexed

end 1..1 Instant

When the processing completed

estimate-count 1..1 Decimal

Initial estimate of the number of resources to be re-indexed

requested 1..1 Instant

When the operation execution was requested

skipped-count 1..1 Decimal

Number of resources that have been skipped (not re-indexed)

start 1..1 Instant

When the actual processing started