Klasifikatora ierakstu asociēto konceptu ieguve
Terminoloģijas API nodrošina lapotu kodēšanas sistēmu un vērtibu kopu sarakstu ieguvi uz norādīto datumumu.
Galapunkta apraksts
Metode | URL | Autorizēts pieprasījums |
---|---|---|
GET | {Host}/terminology/{ResourceType}? | Jā |
Atļautie resursu tipi
ResourceType |
---|
ConceptMap |
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ā, ja nav norādīts filtra lauks "Version" nav norādīts |
ReturnedDataScope | Nosaka atgriežamo datu struktūru un tipu, lai iegūtu klasifikatora ierakstus vienmēr jānorāda "mapping" | jā |
Version | Vērtības kopas versija, par kuru tiek atgriezti dati | jā, ja nav norādīts filtra lauks "EffectiveDate" nav norādīts |
PageType | Pieļaujamās vērtības ["self","next","previous"] Self norādā 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/conceptmap?ReturnedDataScope=mapping&PageType=next&PageSize=2&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=00-0245-03
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/conceptmap?ReturnedDataScope=mapping&PageType=self&PageSize=2&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=00-0245-03" }, { "relation": "previous", "url": "\{HOST\}/terminology/conceptmap?ReturnedDataScope=mapping&PageType=previous&PageSize=2&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchPrevious=00-0245-03" }, { "relation": "next", "url": "\{HOST\}/terminology/conceptmap?ReturnedDataScope=mapping&PageType=next&PageSize=2&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=00-0245-04" } ], "entry": [ { "resource": { "resourceType": "ConceptMap", "status": "active", "group": [ { "source": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.144", "target": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.136", "element": [ { "code": "00-0245-03", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "00-0245", "display": "Advantan 1 mg/g cream" } ] }, { "code": "00-0245-05", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "00-0245", "display": "Advantan 1 mg/g cream" } ] } ] }, { "source": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.144", "target": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.143", "element": [ { "code": "00-0245-05", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "40", "display": "Lietošanai uz ādas" }, { "code": "40", "display": "lietošanai uz ādas" } ] }, { "code": "00-0245-03", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "40", "display": "Lietošanai uz ādas" }, { "code": "40", "display": "lietošanai uz ādas" } ] } ] }, { "source": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.144", "target": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.145", "element": [ { "code": "00-0245-03", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "14", "display": "mg/g" } ] }, { "code": "00-0245-05", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "14", "display": "mg/g" } ] } ] }, { "source": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.144", "target": "https://vvis.gov.lv/fhir/CodeSystem/1.3.6.1.4.1.38760.2.146", "element": [ { "code": "00-0245-05", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "1296", "display": "Alumīnija tūbiņa" } ] }, { "code": "00-0245-03", "display": "Advantan 1 mg/g krēms", "target": [ { "code": "1296", "display": "Alumīnija tūbiņa" } ] } ] } ] } } ] }
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ā lapa eksistē.
- Iepriekšejās lapas saite tiek uzrādīta tikai gadījumā, ja ja iepriekšējā lapa eksistē.
Piemērs lapošanas masīvam
"link": [ { "relation": "self", "url": "\{HOST\}/terminology/conceptmap?ReturnedDataScope=mapping&PageType=self&PageSize=200&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=00-0352-02" }, { "relation": "previous", "url": "\{HOST\}/terminology/conceptmap?ReturnedDataScope=mapping&PageType=previous&PageSize=200&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchPrevious=00-0352-02" }, { "relation": "next", "url": "\{HOST\}/terminology/conceptmap?ReturnedDataScope=mapping&PageType=next&PageSize=200&Name=1.3.6.1.4.1.38760.2.144&EffectiveDate=2023-12-27T07%3A54%3A58.0000000Z&SearchNext=00-0335-01" } ]
Piezīme: piemera nolūkos host saite aizvietota ar {HOST}!