FHIR API kirjeldus

SPD - Service Provider Directory, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-spd/ and changes regularly. See the Directory of published versions

API kirjeldus

API kirjeldus

Käesolevas juhendis kirjeldatakse SPD teenuse poolt toetatud FHIR otspunktid ja operatsioonid. Toodud näidispäringud ja näidisvastused ei kajasta reaalseid andmeid aga vastavad oodatud/toetatud ressursi struktuurile.

PractitionerRole ehk töötaja rolli pärimine

Süsteem võtab vastu töötaja rolli päringu ja tagastab isiku ja töösuhte andmed koos kontaktandmetega. Kui isiku andmed puuduvad SPD-s, siis tehakse taustas päringud MEDRE-sse ja TÖR-i.

Päring id alusel

URL: GET [base]/fhir/PractitionerRole/[practitionerIdCode]-[organizationCode]

practitionerIdCode: arsti isikukood
organizationCode: arsti asutuse kood

Vastus

HTTP status: 200 OK

HTTP/1.1 200 OK

{
    "resourceType": "PractitionerRole",
    "id": "11111111111-70009770",
    "meta": {
        "versionId": "1",
        "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-practitioner-role"
        ]
    },
    "practitioner": {
        "reference": "Practitioner/11111111111/_history/1"
    },
    "organization": {
        "reference": "Organization/70009770/_history/1"
    }
}

Päring identifikaatori alusel

Identifier on kujul url|kood, aga püstkriips peab olema URL kodeeritud, seega %7C.

URL: GET [base]/fhir/PractitionerRole?identifier=https://fhir.ee/sid/pid/est/ni%7C[practitionerIdCode]&organization=Organization/[organizationCode]

practitionerIdCode: arsti isikukood
organizationCode: arsti asutuse kood

Vastus

HTTP status: 200 OK

HTTP/1.1 200 OK

{
    "resourceType": "PractitionerRole",
    "id": "11111111111-70009770",
    "meta": {
        "versionId": "1",
        "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-practitioner-role"
        ]
    },
    "practitioner": {
        "reference": "Practitioner/11111111111/_history/1"
    },
    "organization": {
        "reference": "Organization/70009770/_history/1"
    }
}

Päring arsti koodi alusel

Identifier on kujul url|kood, aga püstkriips peab olema URL kodeeritud, seega %7C.

URL: GET [base]/fhir/PractitionerRole?identifier=https://fhir.ee/sid/pro/est/pho%7C[practitionerCode]

practitionerCode: arsti TAM kood, nt. D00001

Vastus

HTTP status: 200 OK

HTTP/1.1 200 OK

{
    "resourceType": "PractitionerRole",
    "id": "11111111111-70009770",
    "meta": {
        "versionId": "1",
        "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-practitioner-role"
        ]
    },
    "practitioner": {
        "reference": "Practitioner/11111111111/_history/1"
    },
    "organization": {
        "reference": "Organization/70009770/_history/1"
    }
}

$lookup filtering operation

The operation allows querying practitioner roles using filters. Each filter can be used once.

URL: GET [base]/fhir/PractitionerRole/$lookup?identifier=[identifier]&organization=[organization]&role=[role]

identifier: practitioner identifier (personal code or THT code) used as a filter.
organization: organization reference or code.
role: role code.

Response

HTTP status: 200 OK
Response type: Bundle containing PractitionerRole resources.

HTTP/1.1 200 OK

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "fullUrl": "https://fhir.ee/fhir/PractitionerRole/11111111111-70009770",
      "resource": {
        "resourceType": "PractitionerRole",
        "id": "11111111111-70009770",
        "meta": {
          "versionId": "1",
          "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-practitioner-role"
          ]
        },
        "practitioner": {
          "reference": "Practitioner/11111111111"
        },
        "organization": {
          "reference": "Organization/70009770"
        }
      }
    }
  ]
}

Ajaloo päring

practitionerIdCode: arsti isikukood
organizationCode: arsti asutuse kood
version: ressursi versioon

URL: GET [base]/fhir/PractitionerRole/[practitionerIdCode]-[organizationCode]/_history/[version]

Vastus

HTTP status: 200 OK

HTTP/1.1 200 OK

{
    "resourceType": "PractitionerRole",
    "id": "11111111111-70009770",
    "meta": {
        "versionId": "1",
        "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-practitioner-role"
        ]
    },
    "practitioner": {
        "reference": "Practitioner/11111111111/_history/1"
    },
    "organization": {
        "reference": "Organization/70009770/_history/1"
    }
}

Practitioner ehk teenusosutaja isiku päring

Võtab vastu teenuseosutaja isiku päringu ja tagastab isiku andmed koos eriala ja/või ameti andmetega. Kui isiku andmed puuduvad SPD-s, siis tehakse taustas päringud MEDRE-sse ja TÖR-i.

Päring

URL: GET [base]/fhir/Practitioner/[practitionerIdCode]

Ajaloo päring

On võimalik pärida varajasemat versiooni ressursist kasutades ajaloo päringut.

practitionerIdCode: arsti isikukood
version: ressursi versioon

URL: GET [base]/fhir/Practitioner/[practitionerIdCode]/_history/[version]

Vastus

HTTP/1.1 200 OK

{
    "resourceType": "Practitioner",
    "id": "37907242744",
    "meta": {
        "versionId": "34",
        "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-practitioner"
        ]
    },
    "identifier": [
        {
            "system": "https://fhir.ee/sid/pid/est/ni",
            "value": "37907242744"
        },
        {
            "system": "https://fhir.ee/sid/pro/est/pho",
            "value": "D09869"
        },
        {
            "system": "https://fhir.ee/sid/pro/est/pho",
            "value": "N15979"
        },
        {
            "system": "https://fhir.ee/sid/pro/est/pho",
            "value": "P01686"
        }
    ],
    "name": [
        {
            "family": "6d765688Pnimi",
            "given": [
                "6d765688Enimi"
            ]
        }
    ],
    "qualification": [
        {
            "code": {
                "coding": [
                    {
                        "system": "urn:oppeoigus",
                        "code": "S210"
                    }
                ]
            }
        },
        {
            "code": {
                "coding": [
                    {
                        "system": "urn:kutse",
                        "code": "K11"
                    }
                ]
            }
        },
        {
            "code": {
                "coding": [
                    {
                        "system": "urn:kutse",
                        "code": "K15"
                    }
                ]
            }
        },
        {
            "code": {
                "coding": [
                    {
                        "system": "urn:kutse",
                        "code": "K19"
                    }
                ]
            }
        }
    ]
}

Organization ehk asutuse päring

Süsteem võtab vastu asutuse päringu ja tagastab päringu vastuses asutuse ja tegevuslubade andmed. Kui asutuse andmed puuduvad SPD-s, siis tehakse taustas asutuse päring MEDRE-sse ja Ravimikäitlejate andmekogusse.

Päring

organizationCode: asutuse kood

URL: GET [base]/fhir/Organization/[organizationCode]

Ajaloo päring

organizationCode: asutuse kood
version: ressursi versioon

URL: GET [base]/fhir/Organization/[organizationCode]/_history/[version]

Vastus

HTTP status: 200 OK

HTTP/1.1 200 OK

{
    "resourceType": "Organization",
    "id": "90006399",
    "meta": {
        "versionId": "71",
        "profile": [
            "https://fhir.ee/base/StructureDefinition/ee-organization"
        ]
    },
    "identifier": [
        {
            "system": "https://fhir.ee/sid/org/est/br",
            "value": "90006399"
        }
    ],
    "active": true,
    "type": [
        {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                    "code": "prov"
                }
            ]
        }
    ],
    "name": "sihtasutus Põhja-Eesti Regionaalhaigla",
    "contact": [
        {
            "telecom": [
                {
                    "system": "phone",
                    "value": "+372 6171300"
                },
                {
                    "system": "email",
                    "value": "info@regionaalhaigla.ee"
                }
            ]
        }
    ]
}