Location

Pencarian Data

Fungsi dari ReST API ini adalah untuk mencari data terkait resource Location 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-stg.dto.kemkes.go.id/fhir-r4/v1/Location

HTTP Verb/Method

GET

Header

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*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.

*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 Nomor Identifikasi Lokasi

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`?identifier`	`string`	Parameter ini WAJIB ada bila melakukan pencarian data dengan nomor identifikasi lokasi. Nilai yang dimasukkan harus mempunyai format: `http://sys-ids.kemkes.go.id/location/<id-lokasi-induk>\|<nomor-identifikasi-lokasi>` di mana `<id-lokasi-induk>` berisi ID dari lokasi induk yang akan dilakukan pencarian (seperti mencari lokasi Senen pada wilayah Jakarta Pusat, dengan ID wilayahnya), sedangkan `<nomor-identifikasi-lokasi>` berisi nomor identifikasi dari lokasi yang telah disesuaikan sebelumnya. Sebagai contoh, melakukan pencarian lokasi kamar `G-2-R-1A` pada lokasi induk `1000001`, sehingga nilai yang dimasukkan untuk parameter ini adalah: `http://sys-ids.kemkes.go.id/location/1000001\|G-2-R-1A`

?identifier

string

Parameter ini WAJIB ada bila melakukan pencarian data dengan nomor identifikasi lokasi. Nilai yang dimasukkan harus mempunyai format:

http://sys-ids.kemkes.go.id/location/<id-lokasi-induk>|<nomor-identifikasi-lokasi>

di mana <id-lokasi-induk> berisi ID dari lokasi induk yang akan dilakukan pencarian (seperti mencari lokasi Senen pada wilayah Jakarta Pusat, dengan ID wilayahnya), sedangkan <nomor-identifikasi-lokasi> berisi nomor identifikasi dari lokasi yang telah disesuaikan sebelumnya. Sebagai contoh, melakukan pencarian lokasi kamar G-2-R-1A pada lokasi induk 1000001, sehingga nilai yang dimasukkan untuk parameter ini adalah:

http://sys-ids.kemkes.go.id/location/1000001|G-2-R-1A

2. Pencarian Berdasarkan Nama Lokasi

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`?name`	`string`	Parameter ini WAJIB ada bila melakukan pencarian data dengan nama lokasi. Berisi nama, baik sebagian atau lengkap, dari lokasi yang akan dicari. Contoh: `ruang`.

?name

string

Parameter ini WAJIB ada bila melakukan pencarian data dengan nama lokasi. Berisi nama, baik sebagian atau lengkap, dari lokasi yang akan dicari.

Contoh: ruang.

3. Pencarian Berdasarkan ID dari Organisasi

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`?organization`	`uuid`	Parameter ini WAJIB ada bila melakukan pencarian data dengan ID organisasi. Berisi ID dari organisasi yang akan dicari lokasinya. Contoh: `54278fdf-57f9-4e6f-aca4-be97ac12a3f7`.

?organization

uuid

Parameter ini WAJIB ada bila melakukan pencarian data dengan ID organisasi. Berisi ID dari organisasi yang akan dicari lokasinya.

Contoh: 54278fdf-57f9-4e6f-aca4-be97ac12a3f7.

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 Location dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Location yang tersimpan di ekosistem SATUSEHAT.

Contoh Data

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "fullUrl": "https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b",
      "resource": {
        "resourceType": "Location",
        "id": "3362d984-af65-43ac-8e5c-7db2b3be3f8b",
        //data.terkait.resource.Location
      },
      "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-stg.dto.kemkes.go.id/fhir-r4/v1/Location?identifier=http://sys-ids.kemkes.go.id/location/1000001|G-2-R-1A"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location?identifier=http://sys-ids.kemkes.go.id/location/1000001|G-2-R-1A'

Postman

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

Masukkan request URL

https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location

Lalu pilih request method GET.
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.
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.
Klik tombol Send.
Hasil response akan ditampilkan di bagian Response.

Detail Data

Fungsi dari ReST API ini adalah untuk mendapatkan data terkait resource Location yang tersedia di ekosistem SATUSEHAT. Untuk mendapatkan data yang dimaksud, nilai ID dari resource Location 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-stg.dto.kemkes.go.id/fhir-r4/v1/Location/:id

HTTP Verb/Method

GET

Parameter Path URI

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*:id`	`uuid`	ID referensi dari resource Location yang akan dilihat detailnya.

*:id

uuid

ID referensi dari resource Location yang akan dilihat detailnya.

Header

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*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`.

*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 Location dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Location yang tersimpan di ekosistem SATUSEHAT.

Contoh Data

{
  "resourceType": "Location",
  "id": "3362d984-af65-43ac-8e5c-7db2b3be3f8b",
  //data.terkait.resource.Location
}

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-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --request GET \
  'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b'

Postman

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

Masukkan request URL

https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/:id

Lalu pilih request method GET.
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.
Pada tab Params, di bagian Path Variables:
1. Isi nilai parameter id dengan ID dari resource Location yang ingin didapatkan datanya.
Klik tombol Send.
Hasil response akan ditampilkan di bagian Response.

Penambahan Data

Fungsi dari ReST API ini adalah untuk melakukan penambahan data terkait resource Location ke dalam ekosistem SATUSEHAT.

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-stg.dto.kemkes.go.id/fhir-r4/v1/Location

HTTP Verb/Method

POST

Header

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*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`.

*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.

Body (`application/json`)

Terkait cara pengisian Body (application/json) dari format FHIR tersebut, silakan melihat contoh di Postman Collection dan dokumentasi pada menu Panduan Interoperabilitas sesuai dengan modul pelayanan dan/atau penerapan (use case) masing-masing.

Bentuk umum dari payload untuk penambahan data sebagai berikut:

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

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

Dari hasil response ini, PERLU disimpan nilai UUID yang didapat dari properti id, di mana nilai tersebut kemungkinan akan digunakan dalam proses lainnya yang terkait resource Location ini.

Contoh Data

{
  "resourceType": "Location",
  "id": "3362d984-af65-43ac-8e5c-7db2b3be3f8b",
  //data.terkait.resource.Location
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan data dengan format 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>" ^
  --header "Content-Type: application/json" ^
  --data-raw "{
    \"resourceType\": \"Location\",
    ...
  }" ^
  --request POST ^
  "https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "resourceType": "Location",
    ...
  }' \
  --request POST \
  'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location'

Postman

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

Masukkan request URL

https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location

Lalu pilih request method POST.
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.
Pada tab Body:
1. pilih raw,
2. kemudian di samping nilai tadi pilih JSON,
3. terakhir masukkan resource JSON dari Location yang akan diproses ke kotak masukkan di bawah pilihan tadi. Contoh:
  { "resourceType": "Location", //data.terkait.resource.Location }
Klik tombol Send.
Hasil response akan ditampilkan di bagian Response.

Pembaruan Data

Fungsi dari ReST API ini adalah untuk melakukan perubahan data terkait resource Location ke dalam ekosistem SATUSEHAT, yang sebelumnya sudah ditambahkan dan tersedia di dalam ekosistem SATUSEHAT. Untuk melakukan perubahan (update) data, PERLU ID dari resource Location yang akan diubah.

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-stg.dto.kemkes.go.id/fhir-r4/v1/Location/:id

HTTP Verb/Method

PUT

Parameter Path URI

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*:id`	`uuid`	ID referensi dari resource Location yang akan dilakukan proses pembaruan data (update).

*:id

uuid

ID referensi dari resource Location yang akan dilakukan proses pembaruan data (update).

Header

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*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`.

*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.

Body (`application/json`)

Di bagian body ini payload JSON dari resource Location sesuai standar FHIR dimasukkan. Terkait cara pengisian dari format FHIR tersebut di luar cakupan dari dokumentasi ini, silakan melihat pada dokumentasi terkait Petunjuk Teknis atau Playbook yang telah disediakan oleh tim SATUSEHAT dari Pusat Data dan Teknologi Informasi - Digital Transformation Office (DTO) Kementerian Kesehatan Republik Indonesia.

Bentuk umum dari payload untuk penambahan data sebagai berikut:

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

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 proses pembaruan data berhasil maka akan mengembalikan payload dari resource Location yang sebelumnya telah dikirim.

Contoh Data

{
  "resourceType": "Location",
  "id": "3362d984-af65-43ac-8e5c-7db2b3be3f8b",
  //data.terkait.resource.Location
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan 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>" ^
  --header "Content-Type: application/json" ^
  --data-raw "{
    \"resourceType\": \"Location\",
    ...
  }" ^
  --request PUT ^
  "https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "resourceType": "Location",
    ...
  }' \
  --request PUT \
  'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b'

Postman

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

Masukkan request URL

https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/:id

Lalu pilih request method PUT.
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.
Pada tab Params, di bagian Path Variables:
1. Isi nilai parameter id dengan ID dari resource Location yang akan diperbarui (update).
Pada tab Body:
1. pilih raw,
2. kemudian di samping nilai tadi pilih JSON,
3. terakhir masukkan resource JSON dari Location yang akan diproses ke kotak masukkan di bawah pilihan tadi. Contoh:
  { "resourceType": "Location", //data.terkait.resource.Location }
Klik tombol Send.
Hasil response akan ditampilkan di bagian Response.

Pembaruan Sebagian Data

Fungsi dari ReST API ini adalah untuk melakukan perubahan sebagian dari data terkait resource Location ke dalam ekosistem SATUSEHAT, yang sebelumnya sudah ditambahkan dan tersedia di dalam ekosistem SATUSEHAT. Untuk melakukan perubahan sebagian (patching) data, PERLU ID dari resource Location yang akan diubah dan juga nama/ID elemen dari Location yang akan dilakukan perubahan.

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-stg.dto.kemkes.go.id/fhir-r4/v1/Location/:id

HTTP Verb/Method

PATCH

Parameter Path URI

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*:id`	`uuid`	ID referensi dari resource Location yang akan dilakukan proses pembaruan data (update).

*:id

uuid

ID referensi dari resource Location yang akan dilakukan proses pembaruan data (update).

Header

Nama Parameter Tipe Data Keterangan

Nama Parameter	Tipe Data	Keterangan
`*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`.

*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.

Body (`application/json`)

Di bagian body ini payload JSON dari resource Location sesuai standar FHIR dimasukkan. Terkait cara pengisian dari format FHIR tersebut di luar cakupan dari dokumentasi ini, silakan melihat pada dokumentasi terkait Petunjuk Teknis atau Playbook yang telah disediakan oleh tim SATUSEHAT dari Pusat Data dan Teknologi Informasi - Digital Transformation Office (DTO) Kementerian Kesehatan Republik Indonesia.

Bentuk umum dari payload untuk patching sebagai berikut:

[
  {
    "op": "<operasi>",
    "path": "<element-path>",
    "value": "<nilai-baru>"
  }
]

Dari bentuk umum tersebut, nilai:

<operasi>, saat ini hanya tersedia operasi replace saja, yaitu untuk menganti nilai properti/elemen dari resource Location dengan ID terkait.
<element-path>, nama properti/element dari resource Location dengan ID terkait yang akan diganti nilainya, dengan format /<path>/<to>/<element>. Simbol / sebagai pemisah dari nama properti/element yang dimaksud.
Contoh, misalkan pada resource Location ini ada properti/element dengan nama language, yang dalam bentuk path FHIR Location.language, maka penulisan nilai <element-path> ini adalah /language.
<nilai-baru>, diisi dengan nilai pengantinya.

Sehingga contoh payload-nya sebagai berikut:

[
  {
    "op": "replace",
    "path": "/language",
    "value": "id"
  }
]

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 proses pembaruan data berhasil maka akan mengembalikan payload dari resource Location yang sebelumnya telah dikirim.

Contoh Data

{
  "resourceType": "Location",
  "id": "3362d984-af65-43ac-8e5c-7db2b3be3f8b",
  //data.terkait.resource.Location
}

4xx Client Error

Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan 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>" ^
  --header "Content-Type: application/json" ^
  --data-raw "[
      {
          \"op\" : \"<operasi>\",
          \"path\" : \"<element-path>\",
          \"value\" : \"<nilai-baru>\"
      }
  ]" ^
  --request PATCH ^
  "https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b"

cURL (Linux)

curl --insecure --location \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-raw '[
    {
      "op": "<operasi>",
      "path": "<element-path>",
      "value": "<nilai-baru>"
    }
  ]' \
  --request PATCH \
  'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/3362d984-af65-43ac-8e5c-7db2b3be3f8b'

Postman

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

Masukkan request URL

https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Location/:id

Lalu pilih request method PATCH.
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.
Pada tab Params, di bagian Path Variables:
1. Isi nilai parameter id dengan ID dari resource Location yang akan diperbarui (update).
Pada tab Body:
1. pilih raw,
2. kemudian di samping nilai tadi pilih JSON,
3. terakhir masukkan payload JSON untuk melakukan perubahan ke kotak masukkan di bawah pilihan tadi. Contoh:
  [ { "op": "replace", "path": "/language", "value": "id" } ]
Klik tombol Send.
Hasil response akan ditampilkan di bagian Response.

Pencarian Data

Request

URL

HTTP Verb/Method

Header

Query String

1. Pencarian Berdasarkan Nomor Identifikasi Lokasi

2. Pencarian Berdasarkan Nama Lokasi

3. Pencarian Berdasarkan ID dari Organisasi

Response

2xx Success

4xx Client Error

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

Contoh Penggunaan/Kode

cURL (Windows)

cURL (Linux)

Postman

Detail Data

Request

URL

HTTP Verb/Method

Parameter Path URI

Header

Response

2xx Success

4xx Client Error

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

Contoh Penggunaan/Kode

cURL (Windows)

cURL (Linux)

Postman

Penambahan Data

Request

URL

HTTP Verb/Method

Header

Body (application/json)

Response

2xx Success

4xx Client Error

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

Contoh Penggunaan/Kode

cURL (Windows)

cURL (Linux)

Postman

Pembaruan Data

Request

URL

HTTP Verb/Method

Parameter Path URI

Header

Body (application/json)

Response

2xx Success

4xx Client Error

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

Contoh Penggunaan/Kode

cURL (Windows)

cURL (Linux)

Postman

Pembaruan Sebagian Data

Request

URL

HTTP Verb/Method

Parameter Path URI

Header

Body (application/json)

Response

2xx Success

4xx Client Error

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

Contoh Penggunaan/Kode

cURL (Windows)

cURL (Linux)

Postman

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

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

Body (`application/json`)

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

Body (`application/json`)

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

Body (`application/json`)

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