20.5.9. api: read
プロデューサーとコンシューマーの両方がサポート対象
読み取り API は、以下のように 構文で定義されます。
fhir:read/methodName?[parameters]
fhir:read/methodName?[parameters]
以下の表に 2 つのメソッドをリストし、その後に各メソッドの詳細な構文を示します。(API メソッドには、名前の代わりに構文で使用できる省略形の別名を付けることができます)
| メソッド | 説明 |
|---|---|
| サーバー上の IBaseResource を ID で読み取ります | |
| url でサーバーの IBaseResource を読み取る |
20.5.9.1. resourceById メソッド リンクのコピーリンクがクリップボードにコピーされました!
署名:
- org.hl7.fhir.instance.model.api.IBaseResource resourceById (Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
- org.hl7.fhir.instance.model.api.IBaseResource resourceById (Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
- org.hl7.fhir.instance.model.api.IBaseResource resourceById (Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
- org.hl7.fhir.instance.model.api.IBaseResource resourceById (String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
- org.hl7.fhir.instance.model.api.IBaseResource resourceById (String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
- org.hl7.fhir.instance.model.api.IBaseResource resourceById (String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
fhir/resourceById API メソッドには、以下の表に記載されているパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| extraParameters | 渡すことができるパラメーターの完全なリストについては、ExtraParameters を参照してください。NULL の場合があります。 | マップ |
| id | リソースを参照する IIdType | IIdType |
| ifVersionMatches | サーバーの最新バージョンと照合するバージョン | 文字列 |
| longId | リソース ID | Long |
| resource | 読み取るリソース (Patient など) | クラス |
| resourceClass | 読み取るリソース (Patient など) | 文字列 |
| returnNull | バージョンが一致する場合は null を返します。 | ブール値 |
| returnResource | バージョンが一致する場合はリソースを返します | IBaseResource |
| stringId | リソース ID | 文字列 |
| throwError | バージョンが一致するとエラーが発生します。 | ブール値 |
| version | リソースのバージョン | 文字列 |