CTS2-LE EXCEL/CSV Services: Import Value Set Catalog
Zur Navigation springen
Zur Suche springen
This service is used to import a catalog of (translated) value sets as described in Scenario 3 in the CEF User Guide.
Operation Syntax
POST /WebCts2LE/service/crud/excel/valuesetcatalog
- Imports a value set catalog defined in EXCEL/CSV format
- Parameters
- agreementDate (type:
a date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03, occurence:mandatory) - Post Body a valid EXCEL/CSV file (xlsx), comprising an info sheet (hereinafter referred to as <INFO_SHEET> and at least one sheet describing a value set version (hereinafter referred to as <VSV_SHEET>)
- the <INFO_SHEET> defines the following fields:
- the Value Set Catalog UID in cell B3 (mandatory)
- the Value Set Catalog Name in cell B4 (mandatory)
- the Value Set Catalog Description in cell B5 (optional)
- the <VSV_SHEET> defines the following fields:
- the Value Set ID in cell B1 (mandatory)
- the Value Set Name in cell B2 (mandatory)
- the Value Set Version ID in cell B4 (mandatory)
- one or more language codes in cells E+6 (optional)
- Code System IDs in cells A7+ (mandatory)
- Code System Versions in cells B7+ (mandatory)
- Concept Codes in cells C7+ (mandatory)
- Description (FSN) in cells D7+ (optional)
- Language Equivalences wrt. the defined language code in cells E+7+ (optional)
- the <INFO_SHEET> defines the following fields:
- Responses
application/json200no errors409errors specified in JSON
Further notes
- Concurrent usage is not possible at the moment.
- A value set catalog is identified by its agreementDate only. If a catalog with the given agreementDate already exists, it will be replaced with the new catalog. Previously imported value set versions will not be removed even if they are no longer referenced by the new catalog.
- If a catalog defines a value set version which has already been loaded by another catalog, the value set version will be updated.