Response format

These rules apply to the REST data endpoints (/api/v1/* and /api/v2/*). The FHIR endpoints return FHIR resources; see FHIR R4 endpoints.

Response Envelope

By default (no versioned=true, no since-version), all endpoints return the unversioned shape — no currentVersion/version/lastChanged/isDeleted fields. Add versioned=true (or since-version, which always implies the versioned shape) to get the versioned envelope documented below. See Versioning and diff queries for details.

// GET /api/v1&v2/reimbursement-group — unversioned (default)
{
  entries: Array<{
    reimbursementGroup: T;    // The reimbursement group data object
  }>;
}

// GET /api/v1&v2/reimbursement-group/{id} — unversioned (default)
{
  reimbursementGroup: T;      // The reimbursement group data object
}

// GET /api/v1&v2/reimbursement-group and GET /api/v1&v2/reimbursement-group/{id} — versioned (versioned=true or since-version)
{
  currentVersion: number;     // The server's current data version (list endpoint only)
  entries: Array<{
    reimbursementGroup: T;    // The reimbursement group data object
    version: number;          // Version when this entry last changed
    lastChanged: string;      // ISO-8601 timestamp of last change
    isDeleted: boolean;       // Whether this entry has been removed
  }>;
}

// GET /api/v1&v2/treatment-group — unversioned (default)
{
  entries: Array<{
    treatmentGroup: T;        // The treatment group data object
  }>;
}

// GET /api/v1&v2/treatment-group/{id} — unversioned (default)
{
  treatmentGroup: T;          // The treatment group data object
}

// GET /api/v1&v2/treatment-group and GET /api/v1&v2/treatment-group/{id} — versioned (versioned=true or since-version)
{
  currentVersion: number;     // The server's current data version (list endpoint only)
  entries: Array<{
    treatmentGroup: T;        // The treatment group data object
    version: number;          // Version when this entry last changed
    lastChanged: string;      // ISO-8601 timestamp of last change
    isDeleted: boolean;       // Whether this entry has been removed
  }>;
}

FEST identifier changes can update the owning group's version and lastChanged. Replaying unchanged SHI data after that refresh does not itself count as another group change. currentVersion can still advance because each SHI run allocates a global version.

FEST validation (isInFest)

For both API versions, isInFest is omitted from products by default. It is present as a boolean only when the request includes ignore-fest-validation=true:

{
  "identifiers": [
    {
      "type": "FEST/LegemiddelPakning/Varenummer",
      "value": "166028"
    }
  ],
  "isInFest": false
}

When there is no resolved FEST match (as above), no display is present on the identifiers.