API 一覧
RESTful インタラクション
- インタラクション例の [type] にはリソースを指定します。表中のインタラクション例は Patient リソースを使用して記載しています。
特定のインタラクションと関係しないエラー
No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
---|---|---|---|---|---|---|
1 | - (対応されていないインタラクション) | リクエストが不正である | 対応されていないインタラクションを実行する | 400 Bad Request | - | |
2 | - (インタラクションは無関係) | サーバエラー | ※500 Internal Server Error を起こす場合 AP サーバの異常時にインタラクションを実行する | 5XX | - |
read
GET [base]/[type]/[id] {?_format=[mime-type]}
※ 取得されるのは最新バージョンのリソース
No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
---|---|---|---|---|---|---|
1 | GET [base]/Patient/[id] | 基本形 オプションパラメータ無し | [id]に存在するリソースの id を指定する | 200 OK | 指定した id のリソース | |
2 | GET [base]/Patient/[id]?_format=application/fhir+json | _format 指定 | [id]に存在するリソースの id を指定する | 200 OK | 指定した id のリソース | |
3 | GET [base]/Patient/[id]?_format=application/json | _format 指定 一般的な mime type | [id]に存在するリソースの id を指定する | 200 OK | 指定した id のリソース | |
4 | GET [base]/Patient/[id]?_pretty=true | _pretty 指定 プリティプリント形式による応答 | [id]に存在するリソースの id を指定する | 200 OK | 指定した id のリソース | |
5 | GET [base]/Patient/[id]?_pretty=false | _pretty 指定 プリティプリント形式による応答 | [id]に存在するリソースの id を指定する | 200 OK | 指定した id のリソース | |
6 | GET [base]/Patient/[id]?name=value ※検索パラメータは例 | リクエスト不正 | [id]と検索パラメータを共に指定する | 400 Bad Request | OperationOutcome | |
7 | GET [base]/Patient/[id] | 未検出 | [id]に存在しないリソースの id を指定する または、HTTP ヘッダー Accept にサーバでサポートされていない FHIR バージョンを指定する | 404 Not Found | OperationOutcome | |
8 | GET [base]/Patient/[id] | 受理できない | HTTP ヘッダー Accept にサーバでサポートされていないフォーマット(MIME タイプ)を指定する | 406 Not Acceptable | なし | |
9 | GET [base]/Patient/[id] | 消滅した | [id]に DELETE インタラクションで削除したリソースの id を指定する | 410 Gone | OperationOutcome | |
10 | GET [base]/Patient/[id]Http request HEADER ETag= | Conditional read ※未確認 | ||||
11 | GET [base]/Patient/[id]Http request HEADER If-Modified-Since=date-time | Conditional read | id と date-time を指定し、id で指定したリソースが date-time より未来に更新された(=対象リソースの lastUpdated より古い)場合のみ当該リソースを取得する | 200 OK or 304 Not Modified | 指定した id のリソース or なし | |
12 | GET [base]/Patient/[id]Http request HEADER If-None-Match=ETag | Conditional read | id と ETag を指定し、 ETag が対象リソースの versionId と異なる場合のみ当該リソースを取得する | 200 OK or 304 Not Modified | 指定した id のリソース or なし |
vread
GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]}
No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
---|---|---|---|---|---|---|
1 | GET [base]/Patient/[id]/_history/[vid] | 基本形 オプションパラメータ無し | [id]に存在するリソースの id を、[vid]に存在するバージョンの vid を指定する | 200 OK | 指定した id、vid のリソース | |
2 | GET [base]/Patient/[id]/_history/[vid]?_format=application/fhir+json | _format 指定 | [id]に存在するリソースの id を、[vid]に存在するバージョンの vid を指定する | 200 OK | 指定した id、vid のリソース | |
3 | GET [base]/Patient/[id]/_history/[vid]?_format=application/json | _format 指定 一般的な mime type | [id]に存在するリソースの id、[vid]に存在するバージョンの vid を指定する | 200 OK | 指定した id、vid のリソース | |
4 | GET [base]/Patient/[id]/_history/[vid]?_pretty=true | _pretty 指定 プリティプリント形式による応答 | [id]に存在するリソースの id を、[vid]に存在するバージョンの vid を指定する | 200 OK |