NVD FHIR API SASKARNES LIETOŠANAS INSTRUKCIJA
Šis dokuments apraksta NVD (LR Veselības ministrijas Nacionālais veselības dienests) FHIR (Fast Healthcare Interoperability Resources) saskarni Laboratorijas un Onkoloģijas datu iesūtīšanai.
Par saskarni
FHIR API saskarne ir paredzēta FHIR formāta datu ziņojumu iesūtīšanai un saņemšananai
Piekļuve un autorizācija
Lai lietotu NVD FHIR saskarni, lietotājiem ir jāsaņem atbilstošas piekļuves tiesības. Piekļuves tiesības tiek nodrošinātas
Saskarnes resursu nodrošināšanas principi FHIR sarkarnei
Piedāvātā saskarne ir universāla FHIR REST saskarne, kas nodrošina darbu ar dažādiem FHIR objektiem. Pieejamie FHIR objekti ir atkarīgi no tā cik FHIR profili ir pieejami validācijas sistēmai.
Visiem datu pievienošanas un labošanas izsaukumiem ir pieejama callback opcija, kurā Integrators var nodot atpakaļ URL uz savu endpoint, kuru LAB IS izsauks, kad būs beigusi iesūtīto datu apstrādi.
Pieejamie izsaukumu tipi un to vispāreji apraksti ir sniegti pievienotajā sarakstā:
POST / ResourceType
Jauna objekta pievienošana, kas atbilst resourceType definīcijā noteiktajam un, kura datu saturs var tikt validēts ar atbilstošā resursa tipa FHIR profilu.
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| callback | norāde uz URL, uz kuru atbildēt LAB IS sistēmai, kad ir pabeigta iesūtīto datu apstrāde |
PUT / resourceType/ id
Esoša objekta labošana, norādot objekta identifikatoru. Objekta saturam jāspēj validēties atbilstoši resursa FHIR profilam
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| id | Resursa identifikators, kas tiek apstrādāts |
| callback | norāde uz URL, uz kuru atbildēt LAB IS sistēmai, kad ir pabeigta iesūtīto datu apstrāde |
DELETE / resourceType/ id
Esoša objekta dzēšana, mainot objekta statusu uz "dzēsts".
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| id | Resursa identifikators, kas tiek apstrādāts |
GET / resourceType/ id
Esoša objekta izgūšana pēc tā identifikatora
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| id | Resursa identifikators, kas tiek apstrādāts |
POST / resourceType/search-by-identity
Resursu saraksta meklēšana resursiem, kas atbilst noteiktam identifkatoram
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
GET / resourceType/ id/_history
Noteikta objekta vēsturisko vērtību saraksta (versiju) izgūšana pēc identifikatora
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| id | Resursa identifikators, kas tiek apstrādāts |
GET / resourceType/ id/_history/ version
Objekta konkrētas vēsturiskās vērtības izgūšana pēc tā versijas
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| id | Resursa identifikators, kas tiek apstrādāts |
| version | norāde uz versiju, kurai tiek izgūti dati |
GET / resourceType/ id/_history/ date
Objekta konkrētas vēsturiskās vērtības izgūšana pēc datuma (norādot datumu, uz kuru nepieciešama objekta versija)
| Parametra nosaukums | Parametra skaidrojums |
|---|---|
| resourceType | Resursa veida nosaukums (piemēram: Observation, DiagnosticReport, utt) |
| id | Resursa identifikators, kas tiek apstrādāts |
| date | datums, uz kuru tiek izgūta konkrētā objekta versija (aktuālā norādītajā datumā) |
Saskarnes resursu nodrošināšanas principi TRANSACTION saskarnei
Transaction sasakrnes uzdevums ir nodrošināt informāciju par Integratora iesūtītā pieprasījuma statusu
Saskarnes nodrošinātie resursi
NVD FHIR saskarne nodrošina atbalstu šādiem resursiem (atkarībā no pieejamajiem publicētajiem profiliem):
- Observation
- DiagnosticReport
- Specimen
- ServiceRequest
- Patient
- Practitioner
- PractitionerRole
- ValueSet
- Organization