Practitioner Terakhir disunting pada 16 November 2023

Pencarian Data

Fungsi dari ReST API ini adalah untuk mencari data terkait resource Practitioner yang tersedia di ekosistem SATUSEHAT dengan parameter-parameter tertentu.

Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB , harus ada, atau pasti selalu ada, contoh: *variabel.
Setiap terdapat simbol tanya ? sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut WAJIB ada bila memenuhi kondisi tertentu, contoh: ?variabel.

Request

URL

https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner

HTTP Verb/Method

GET

Header

Nama ParameterTipe DataKeterangan

*Authorization

string

Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi.

Query String

1. Pencarian Berdasarkan NIK Praktisi kesehatan
Nama ParameterTipe DataKeterangan

?identifier

string

Parameter ini WAJIB ada bila melakukan pencarian data dengan NIK praktisi kesehatan. Nilai yang dimasukkan harus mempunyai format:

https://fhir.kemkes.go.id/id/nik|<nilai-nik>

di mana <nilai-nik> berisi NIK dari praktisi kesehatan yang akan dicari. Sebagai contoh, diketahui NIK praktisi kesehatan ################, sehingga nilai yang dimasukkan untuk parameter ini adalah:

https://fhir.kemkes.go.id/id/nik|################
2. Pencarian Berdasarkan Nama, Tanggal Lahir, dan Jenis Kelamin Praktisi kesehatan
Nama ParameterTipe DataKeterangan

?name

string

Parameter ini WAJIB ada bila melakukan pencarian data dengan nama, tanggal lahir, dan jenis kelamin praktisi kesehatan. Berisi nama, baik sebagian atau lengkap, dari praktisi kesehatan yang akan dicari.

Contoh: Voigt.

?birthdate

date

Parameter ini WAJIB ada bila melakukan pencarian data dengan nama, tanggal lahir, dan jenis kelamin praktisi kesehatan. Berisi tanggal dengan format salah satu dari YYYY, YYYY-MM, atau YYYY-MM-DD.

Contoh: 1945.

?gender

string

Parameter ini WAJIB ada bila melakukan pencarian data dengan nama, tanggal lahir, dan jenis kelamin praktisi kesehatan. Berisi nama jenis kelamin dari praktisi kesehatan, yaitu male atau female.

Response

Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.

2xx Success

Bila resource Practitioner dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Practitioner yang tersimpan di ekosistem SATUSEHAT.

Contoh Data

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "fullUrl": "https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner/N10000001",
      "resource": {
        "resourceType": "Practitioner",
        "id": "N10000001",
        //data.terkait.resource.Practitioner
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau meminta data dengan format, parameter, atau ketentuan lainnya yang tidak sesuai atau tidak dimengerti oleh sistem.

Contoh Data

{
  "resourceType": "OperationOutcome",
  //data.terkait.resource.OperationOutcome
}

5xx Server Error (Content-Type: text/plain)

Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.

Contoh Data

Gateway Timeout

Contoh Penggunaan/Kode

Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.

cURL (Windows)

curl --insecure --location ^
  --header "Authorization: Bearer <access-token>" ^
  --request GET ^
  "https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner?identifier=https://fhir.kemkes.go.id/id/nik|################"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --request GET \
  'https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner?identifier=https://fhir.kemkes.go.id/id/nik|################'

Postman

  1. Buat request baru menggunakan New  HTTP Request, atau klik + untuk buat tab request baru.

  2. Masukkan request URL

    https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner

  3. Lalu pilih request method GET.

  4. Pada tab Auth:

    1. pada pilihan Type, pilih Bearer Token,

    2. lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.

  5. Pada tab Params, di bagian Query Params:

    1. silakan masukkan parameter untuk melakukan pencarian sesuai dengan yang sudah dijelaskan pada bagian query string terkait ReST API ini,

    2. masukkan satu atau lebih nama dari parameter tersebut pada kotak masukkan pada kolom KEY,

    3. sedangkan untuk nilainya, masukkan pada kotak masukkan pada kolom VALUE.

  6. Klik tombol Send.

  7. Hasil response akan ditampilkan di bagian Response.

Detail Data

Fungsi dari ReST API ini adalah untuk mendapatkan data terkait resource Practitioner yang tersedia di ekosistem SATUSEHAT. Untuk mendapatkan data yang dimaksud, nilai ID dari resource Practitioner tersebut PERLU diketahui dan disediakan sebagai parameternya.

Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB , harus ada, atau pasti selalu ada, contoh: *variabel.

Request

URL

https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner:id

HTTP Verb/Method

GET
Parameter Path URI
Nama ParameterTipe DataKeterangan

*:id

uuid

ID referensi dari resource Practitioner yang akan dilihat detailnya.

Header

Nama ParameterTipe DataKeterangan

*Authorization

string

Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi.

*Content-Type

string

Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan application/json.

Response

Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.

2xx Success

Bila resource Practitioner dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Practitioner yang tersimpan di ekosistem SATUSEHAT.

Contoh Data

{
  "resourceType": "Practitioner",
  "id": "N10000001",
  //data.terkait.resource.Practitioner
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau meminta data dengan format, parameter, atau ketentuan lainnya yang tidak sesuai atau tidak dimengerti oleh sistem.

Contoh Data

{
  "resourceType": "OperationOutcome",
  //data.terkait.resource.OperationOutcome
}

5xx Server Error (Content-Type: text/plain)

Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.

Contoh Data

Gateway Timeout

Contoh Penggunaan/Kode

Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.

cURL (Windows)

curl --insecure --location ^
  --header "Authorization: Bearer <access-token>" ^
  --request GET ^
  "https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner/N10000001"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --request GET \
  'https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner/N10000001'

Postman

  1. Buat request baru menggunakan New  HTTP Request, atau klik + untuk buat tab request baru.

  2. Masukkan request URL

    https://api-satusehat-dev.dto.kemkes.go.id/fhir-r4/v1/Practitioner:id

  3. Lalu pilih request method GET.

  4. Pada tab Auth:

    1. pada pilihan Type, pilih Bearer Token,

    2. lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.

  5. Pada tab Params, di bagian Path Variables:

    1. Isi nilai parameter id dengan ID dari resource Practitioner yang ingin didapatkan datanya.

  6. Klik tombol Send.

  7. Hasil response akan ditampilkan di bagian Response.