Pieejamo klasifikatoru saraksta ieguve

Terminoloģijas API nodrošina lapotu kodēšanas sistēmu un vērtību kopu sarakstu ieguvi uz norādīto datumu.

Galapunkta apraksts

Metode URL Autorizēts pieprasījums
GET {Host}/terminology/{ResourceType}? Jā

Atļautie resursu tipi

ResourceType
CodeSystem
ValueSet

Atļautie filtra parametri

Filtra lauks Apraksts Obligātums
PageSize Skaitliska vērtība, kas nosaka atgriezto ierakstu skaitu izsaukumā (1-500), nenorādot parametru noklusējuma ierakstu skaits atbildē ir 200 nē
EffectiveDate Datums, kurā visi atgrieztie ieraksti būs spēkā esoši. Datums ISO 8601 formātā ar url escaping piemērs: 2023-12-27T07%3A54%3A58%2B00%3A00 jā
ReturnedDataScope Nosaka atgriežamo datu struktūru un tipu, lai iegūtu kodēšanas sistēmu vai vērtību kopu sarakstu vienmēr jānorāda "availableClassifiers" jā
PageType Pieļaujamās vērtības ["self","next","previous"] Self norada pašreizējo lapu, next norāda nākamo lapu un previous norāda iepriekšējo lapu jā, ja SearchNext vai SearchPrevious ir norādīts
SearchNext Norāda nākamās lapas identifikatoru jā, ja PageType = "self" vai "next"
SearchPrevious Norāda iepriekšējās lapas identifikatoru jā, ja PageType = "previous"

Izsakuma veikšana

Resursu izsaukumus vienmēr ir jāveic ar JWT tokena autorizāciju. Informāciju par autorizāciju sk. nodaļā Autorizācija.

Izsaukuma piemērs

Galapunkts: {Host}/terminology/CodeSystem?pageSize=5&effectiveDate=2023-12-27T07%3A54%3A58%2B00%3A00&returnedDataScope=availableClassifiers

Metode: GET

Autorizācijas talons: NVD STS izsaukumā iegūtais JWT talons izmantojot terminology audience

Pieprasījuma atbildes struktūra:


{
    "resourceType": "Bundle",
    "type": "searchset",
    "link": [
        {
            "relation": "self",
            "url": "\{HOST\}/terminology/codesystem?ReturnedDataScope=availableclassifiers&PageType=self&PageSize=5&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=1.3.6.1.4.1.38760.2.104"
        },
        {
            "relation": "previous",
            "url": "\{HOST\}/terminology/codesystem?ReturnedDataScope=availableclassifiers&PageType=previous&PageSize=5&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchPrevious=1.3.6.1.4.1.38760.2.104"
        },
        {
            "relation": "next",
            "url": "\{HOST\}/terminology/codesystem?ReturnedDataScope=availableclassifiers&PageType=next&PageSize=5&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=1.3.6.1.4.1.38760.2.111"
        }
    ],
    "entry": [
        {
            "resource": {
                "resourceType": "CodeSystem",
                "url": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.104",
                "version": "2",
                "name": "1.3.6.1.4.1.38760.2.104",
                "title": "Pārraudzības iestādes lēmumu tipu klasifikators"
            }
        },
        {
            "resource": {
                "resourceType": "CodeSystem",
                "url": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.105",
                "version": "5",
                "name": "1.3.6.1.4.1.38760.2.105",
                "title": "Veselības aprūpes pakalpojumi"
            }
        },
        {
            "resource": {
                "resourceType": "CodeSystem",
                "url": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.106",
                "version": "12",
                "name": "1.3.6.1.4.1.38760.2.106",
                "title": "Veselības aprūpes pakalpojumu grupas"
            }
        },
        {
            "resource": {
                "resourceType": "CodeSystem",
                "url": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.107",
                "version": "1",
                "name": "1.3.6.1.4.1.38760.2.107",
                "title": "Veselības aprūpes pakalpojumu komponentes"
            }
        },
        {
            "resource": {
                "resourceType": "CodeSystem",
                "url": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.108",
                "version": "1",
                "name": "1.3.6.1.4.1.38760.2.108",
                "title": "Komponentes veids"
            }
        }
    ]
}

Lapošanas izmantošana izsaukumos

Ja meklēšanas atrasto ierakstu skaits pārsniedz sistēmā definēto vienas lapas izmēru, tad izsaukuma atbildes struktūra tiek papildināta ar "link" objektu masīvu, kur masīva objekts satur laukus "relation" un "url"

JSON lauks Apraksts
link Satur lappušu navigācijas datus
link.relation Norāde uz objekta link.url pielietojumu. Iespējamās vērtības "self" - norāda pašreizējās lapas datu izsaukuma saiti; "next" - norādā nākamās lapas datu izsaukuma saiti; "previous" - norāda iepriekšējās lapas datu izsaukuma saiti
link.url Lapas datu izsaukuma saiti

Piezīme:

  • Pašreizējās lapas saite tiek uzrādīta tikai gadījumā, ja "link" masīvs satur vienu vai abus JSON objektus ar references lauka vērtībām "next" vai/un "previous".
  • Nākamās lapas saite tiek uzrādīta tikai gadījumā, ja nākamā lappa eksistē.
  • Iepriekšejās lapas saite tiek uzrādīta tikai gadījumā, ja ja iepriekšējā lappa eksistē.

Piemērs lapošanas masīvam

[
        {
            "relation": "self",
            "url": "\{HOST\}/terminology/codesystem?ReturnedDataScope=availableclassifiers&PageType=self&PageSize=5&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=1.3.6.1.4.1.38760.2.104"
        },
        {
            "relation": "previous",
            "url": "\{HOST\}/terminology/codesystem?ReturnedDataScope=availableclassifiers&PageType=previous&PageSize=5&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchPrevious=1.3.6.1.4.1.38760.2.104"
        },
        {
            "relation": "next",
            "url": "\{HOST\}/terminology/codesystem?ReturnedDataScope=availableclassifiers&PageType=next&PageSize=5&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=1.3.6.1.4.1.38760.2.111"
        }
    ]

Piezīme: piemera nolūkos host saite aizvietota ar {HOST}!