Metode GET

Galapunkta GET metodei ir pieejamas vairākas operācijas, kuras savā starpā atšķirās ar pieprasījuma izveides struktūru.

• Metode "/id" - Metodes ietvaros pieprasījumu struktūrā ir sagaidāms norādīt izsaucamā resursa tipu un LAB IS ieraksta identifikatoru, veidojot izsaukumu atbilstoši formātam: "/api/(resourceType)/(id)". Atgieztā datu struktūra satur datus par izsaukto sistēmas ierakstu.
• Metode "/_history" - Metodes ietvaros pieprasījumu struktūrā ir sagaidāms norādīt izsaucamā restursa tipu un LAB IS ieraksta identifikatoru, veidojot izsaukumu atbilstoši formātam: "/api/(resourceType)/(id)/_history". Atgieztā datu struktūra saturēs datus par izsaukto sistēmas ierakstu un visām vēsturiskajām ieraksta datu kopām.
  • Metode "/_history/(version)" - Metodes ietvaros pieprasījumu struktūrā ir sagaidāms norādīt izsaucamā restursa tipu, LAB IS ieraksta identifikatoru un versiju, par kuru jāatgriež aktuālais vēsturiskais ieraksts, veidojot izsaukumu atbilstoši formātam: "/api/(resourceType)/(id)/_history/(date)". Atgieztā datu struktūra saturēs datus ieraksta datu kopu atbilstoši norādītajai versijai.
• Metode "/_search" - pieprasījumā tiek norādīts atļautais FHIR path lauks kā meklēšanas parametrs

Metode PUT

Galapunkta PUT metodei ir izmantojama datu labošanas/aizvietošanas vajadzībām.

• Metode "/id" - Metodes ietvaros pieprasījumu struktūrā ir sagaidāms norādīt izsaucamā restursa tipu un LAB IS ieraksta identifikatoru veidojot izsaukumu atbilstoši formātam: "/api/(resourceType)/(id)". Papildus metodē ir iespējams norādīt callback header parametru, kurā var norādīt adresi, uz kuru FHIR API nosūta transakcijas statusu. PUT metodes body struktūra ir atkarīga no resursa tipa definētā profila.

Metode POST

Galapunkta POST metodei ir izmantojama datu izveidei.

• Pieprasījumu struktūrā ir sagaidāms norādīt izsaucamā restursa tipu,veidojot izsaukumu atbilstoši formātam: "/api/(resourceType)". Papildus metodē ir iespējams norādīt callback header parametru, kurā var norādīt adresi, uz kuru FHIR API nosūta tranzakcijas statusu. POST metodes body struktūra ir atkarīga no resursa tipa definētā profila.

Metode POST

Galapunkta POST metodei ir pieejamas vairākas operācijas, kuras savā starpā atšķirās ar pieprasijuma izveides struktūru.

• Metode "/id" - Metodes ietvaros pieprasījumu struktūrā ir sagaidāms norādīt izsaucamā restursa tipu, veidojot izsaukumu atbilstoši formātam: "/api/search/(resourceType)/by-identity". Izsaukuma body struktūra vienmēr saturēs sekojošos laukus: "{ "value": "string", - Meklējamā vērtība "system": "string", - meklējamās vērtības sistēmas identifikators "resourceType": "string" - Sagaidāmā atbildes resursa tipa nosaukums. }"Atgieztā datu struktūra saturēs datus par izsaukto sistēmas ierakstu.

Operācijā izmantojamie resursi

Meklēšanas operācija ir izmantojama sekojošajiem FHIR resursiem:

Resursiem piesaistītie vērtību filtra lauki

Lapošanas izmantošana operācijas izsaukumos

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

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ē.
• Veicot iepriekšējās lapas datu pieprasījumu dati tiek kārtoti dilstōša secībā pēc ieraksta identifikatoriem.
• Veicot nākamās lapas datu pieprasījumu dati tiek kārtoti augošā secībā pēc ieraksta identifikatoriem.

Piemērs lapošanas masīvam

    "link": [
        {
            "relation": "previous",
            "url": "{DOMAIN}/fhir/api/Organization/_search?active=true&identifier[].system=1.3.6.1.4.1.38760.2.23&search_previous=01H0JKDZ1F010MXYSJF6JBYJW0"
        },
        {
            "relation": "self",
            "url": "{DOMAIN}/fhir/api/Organization/_search?active=true&identifier[].system=1.3.6.1.4.1.38760.2.23&search_next=01H0JKDZ1F01XHMXW69XCCX4CW"
        },
        {
            "relation": "next",
            "url": "{DOMAIN}/fhir/api/Organization/_search?active=true&identifier[].system=1.3.6.1.4.1.38760.2.23&search_next=01H0JKDZ1F035PXAZHXVEX641E"
        }
    ]

Piezīme: piemera nolūkos host saite aizvietota ar DOMAIN!