Encounter
Pencarian Data
Fungsi dari ReST API ini adalah untuk mencari data terkait resource Encounter 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 . |
Request
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 Encounter dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Encounter 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/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f",
"resource": {
"resourceType": "Encounter",
"id": "4f735a03-128b-464d-bf91-e6eacdf1c38f",
//data.terkait.resource.Encounter
},
"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
}
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/Encounter?subject=100000000001"
cURL (Linux)
curl --insecure --location \
--header 'Authorization: Bearer <access-token>' \
--request GET \
'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter?subject=100000000001'
Postman
Buat request baru menggunakan
, atau klik tombol + untuk buat tab request baru.Masukkan request URL
https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter
Lalu pilih request method
GET
.Pada tab Auth:
pada pilihan Type, pilih
Bearer Token
,lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
Pada tab Params, di bagian Query Params:
silakan masukkan parameter untuk melakukan pencarian sesuai dengan yang sudah dijelaskan pada bagian query string terkait ReST API ini,
masukkan satu atau lebih nama dari parameter tersebut pada kotak masukkan pada kolom KEY,
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 Encounter yang tersedia di ekosistem SATUSEHAT. Untuk mendapatkan data yang dimaksud, nilai ID dari resource Encounter 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
Header
Nama Parameter | Tipe Data | Keterangan |
---|---|---|
|
| Header ini WAJIB diisi dengan nilai sesuai format: |
|
| Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan |
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 Encounter dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Encounter yang tersimpan di ekosistem SATUSEHAT.
Contoh Data
{
"resourceType": "Encounter",
"id": "4f735a03-128b-464d-bf91-e6eacdf1c38f",
//data.terkait.resource.Encounter
}
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
}
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/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f"
cURL (Linux)
curl --insecure --location \
--header 'Authorization: Bearer <access-token>' \
--request GET \
'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f'
Postman
Buat request baru menggunakan
, atau klik tombol + untuk buat tab request baru.Masukkan request URL
https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter/:id
Lalu pilih request method
GET
.Pada tab Auth:
pada pilihan Type, pilih
Bearer Token
,lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
Pada tab Params, di bagian Path Variables:
Isi nilai parameter
id
dengan ID dari resource Encounter 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 Encounter 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
Header
Nama Parameter | Tipe Data | Keterangan |
---|---|---|
|
| Header ini WAJIB diisi dengan nilai sesuai format: |
|
| Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan |
Body (application/json
)
Terkait cara pengisian Body (application/json
) dari format FHIR tersebut, silakan lihat contoh di Postman SATUSEHAT 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": "Encounter",
//data.terkait.resource.Encounter
}
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 Encounter ini.
Contoh Data
{
"resourceType": "Encounter",
"id": "4f735a03-128b-464d-bf91-e6eacdf1c38f",
//data.terkait.resource.Encounter
}
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
}
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\": \"Encounter\",
...
}" ^
--request POST ^
"https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter"
cURL (Linux)
curl --insecure --location \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"resourceType": "Encounter",
...
}' \
--request POST \
'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter'
Postman
Buat request baru menggunakan
, atau klik tombol + untuk buat tab request baru.Masukkan request URL
https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter
Lalu pilih request method
POST
.Pada tab Auth:
pada pilihan Type, pilih
Bearer Token
,lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
Pada tab Body:
pilih raw,
kemudian di samping nilai tadi pilih JSON,
terakhir masukkan resource JSON dari Encounter yang akan diproses ke kotak masukkan di bawah pilihan tadi. Contoh:
{ "resourceType": "Encounter", //data.terkait.resource.Encounter }
Klik tombol Send.
Hasil response akan ditampilkan di bagian Response.
Pembaruan Data
Fungsi dari ReST API ini adalah untuk melakukan perubahan data terkait resource Encounter ke dalam ekosistem SATUSEHAT, yang sebelumnya sudah ditambahkan dan tersedia di dalam ekosistem SATUSEHAT. Untuk melakukan perubahan (update) data, PERLU ID dari resource Encounter 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
Header
Nama Parameter | Tipe Data | Keterangan |
---|---|---|
|
| Header ini WAJIB diisi dengan nilai sesuai format: |
|
| Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan |
Body (application/json
)
Di bagian body ini payload JSON dari resource Encounter sesuai standar FHIR dimasukkan. Terkait cara pengisian dari format FHIR tersebut di luar cakupan dari dokumentasi ini, silakan lihat dokumentasi terkait FHIR atau Panduan Interoperabilitas 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": "Encounter",
//data.terkait.resource.Encounter
}
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 Encounter yang sebelumnya telah dikirim.
Contoh Data
{
"resourceType": "Encounter",
"id": "4f735a03-128b-464d-bf91-e6eacdf1c38f",
//data.terkait.resource.Encounter
}
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
}
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\": \"Encounter\",
...
}" ^
--request PUT ^
"https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f"
cURL (Linux)
curl --insecure --location \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"resourceType": "Encounter",
...
}' \
--request PUT \
'https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f'
Postman
Buat request baru menggunakan
, atau klik tombol + untuk buat tab request baru.Masukkan request URL
https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter/:id
Lalu pilih request method
PUT
.Pada tab Auth:
pada pilihan Type, pilih
Bearer Token
,lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
Pada tab Params, di bagian Path Variables:
Isi nilai parameter
id
dengan ID dari resource Encounter yang akan diperbarui (update).
Pada tab Body:
pilih raw,
kemudian di samping nilai tadi pilih JSON,
terakhir masukkan resource JSON dari Encounter yang akan diproses ke kotak masukkan di bawah pilihan tadi. Contoh:
{ "resourceType": "Encounter", //data.terkait.resource.Encounter }
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 Encounter ke dalam ekosistem SATUSEHAT, yang sebelumnya sudah ditambahkan dan tersedia di dalam ekosistem SATUSEHAT. Untuk melakukan perubahan sebagian (patching) data, PERLU ID dari resource Encounter yang akan diubah dan juga nama/ID elemen dari Encounter 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
Header
Nama Parameter | Tipe Data | Keterangan |
---|---|---|
|
| Header ini WAJIB diisi dengan nilai sesuai format: |
|
| Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan |
Body (application/json
)
Di bagian body ini payload JSON dari resource Encounter sesuai standar FHIR dimasukkan. Terkait cara pengisian dari format FHIR tersebut di luar cakupan dari dokumentasi ini, silakan lihat dokumentasi terkait FHIR atau Panduan Interoperabilitas 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 operasireplace
saja, yaitu untuk menganti nilai properti/elemen dari resource Encounter dengan ID terkait.<element-path>
, nama properti/element dari resource Encounter 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 Encounter ini ada properti/element dengan nama
language
, yang dalam bentuk path FHIREncounter.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 Encounter yang sebelumnya telah dikirim.
Contoh Data
{
"resourceType": "Encounter",
"id": "4f735a03-128b-464d-bf91-e6eacdf1c38f",
//data.terkait.resource.Encounter
}
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
}
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/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f"
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/Encounter/4f735a03-128b-464d-bf91-e6eacdf1c38f'
Postman
Buat request baru menggunakan
, atau klik tombol + untuk buat tab request baru.Masukkan request URL
https://api-satusehat-stg.dto.kemkes.go.id/fhir-r4/v1/Encounter/:id
Lalu pilih request method
PATCH
.Pada tab Auth:
pada pilihan Type, pilih
Bearer Token
,lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
Pada tab Params, di bagian Path Variables:
Isi nilai parameter
id
dengan ID dari resource Encounter yang akan diperbarui (update).
Pada tab Body:
pilih raw,
kemudian di samping nilai tadi pilih JSON,
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.