2.5.2. JP Core Client ClientCapabilityStatements
2.5.2.1. 概要
この章ではJP Core Clientの期待される機能について説明する。
JP Core Serverによってサポートされる FHIR プロファイル・RESTful操作・検索パラメータの完全なリストを定義する。
JP Core Clientは個別のユースケースや意味的な要請に応じてこれらのリストを通じて必要なデータにアクセスすることができる。
項目 | 内容 |
---|---|
定義URL | http://jpfhir.jp/fhir/core/CapabilityStatement/StructureDefinition/jpcoreclientcapabilitystatement |
バージョン | 1.0.0 |
名前 | JPCoreClientCapabilityStatement |
タイトル | JP Core Client Capability Statement |
ステータス | アクティブ(2021-12-01) |
定義 | JP Core Clientの期待される機能について説明する。JP Core Clientは、ローカルなユースケースやその他の文脈上の要件に基づいて、必要なデータにアクセスするために、このリストから選択することができます。 |
公開者 | FHIR® Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) |
Copyright | FHIR® Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) |
ソースリソース | https://simplifier.net/jp-core-draftv1/jpcoreclientcapabilitystatement |
2.5.2.2. FHIR RESTful Capabilities
JP Coreは以下の要件を必須とする(SHALL)
- FHIR仕様に基づくRESTfulなふるまいの実装
以下のレスポンスクラスを返すこと
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
- (Status 410): deleted resource.
全てのJP Core interactionにおいてjson記述をサポートすること(SHOULD)
JP Coreは以下の要件を満たすべきである(SHOULD)
- 各インスタンス を、FHIR meta.profile 属性の一部としてサポートされる JP Core profileとして認識すること
JP Coreでは以下の要件を実装しても良い(MAY)。
- 全てのJP Core interactionにおいてXML記述をサポートすること
セキュリティ
- See the General Security Considerations section for requirements and recommendations.
- サーバーはunauthorizedなリクエストに対してはHTTP 401を返さなければならない。(SHALL)
2.5.2.3. 検索条件サマリ
Resource Type | Supported Profiles | Supported Searches |
---|---|---|
Patient | JP_Patient | [SHALL] identifier [SHOULD] name [SHOULD] birthdate + name [SHOULD] birthdate + gender [SHOULD] birthdate + name + gender [SHOULD] name + phone [SHOULD] name + address + postalcode [MAY] family + given + birthdate + gender + phone + address-postalcode |
Coverage | JP_Coverage | [SHOULD] beneficiary [SHOULD] class-type [SHOULD] class-value [SHOULD] dependent [SHOULD] identifier [SHOULD] patient [SHOULD] payor [SHOULD] policy-holder [SHOULD] status [SHOULD] subscriber [SHOULD] type |
Encounter | JP_Encounter | [SHALL] patient [SHALL] date + patient [SHOULD] identifier [SHOULD] class + patient [SHOULD] patient + type [SHOULD] patient + status |
Location | JP_Location | [SHOULD] name [SHOULD] address [SHOULD] address-city [SHOULD] address-state [SHOULD] address-postalcode |
Organization | JP_Organization | [SHOULD] identifier [SHOULD] name [SHOULD] address |
Practitioner | JP_Practitioner | [SHALL] identifier [SHALL] name |
PractitionerRole | JP_PractitionerRole | [SHALL] specialty [SHALL] practitioner |
Medication | JP_Medication | |
MedicationRequest | JP_MedicationRequest | [SHALL] identifier [SHOULD] patient [SHOULD] patient + date [SHOULD] patient + authoredon [MAY] date + authoredon + category + code + requester |
- | JP_MedicationRequest_Injection | - |
MedicationDispense | JP_MedicationDispense | [SHALL] identifier [SHOULD] patient [SHOULD] patient + whenhandedover [MAY] whenhandedover + whenprepared + context + code + performer |
- | JP_MedicationDispense_Injection | - |
MedicationAdministration | JP_MedicationAdministration | [SHALL] identifier [SHOULD] patient [SHOULD] patient + effective-time [MAY]code |
- | JP_MedicationAdministration_Injection | - |
Observation | JP_Observation_Common | [SHOULD] subject + code + date + based-on [SHOULD] subject + code + date + value-quantity + based-on [SHOULD] subject + code + date + value-concept + based-on [SHOULD] subject + code + date + value-string + based-on [SHOULD] code + value-quantity + subject [SHOULD] code + value-concept + subject [SHOULD] code + value-string + subject [MAY] patient + category + code + value-quantity [MAY] patient + category + code + value-quantity + date [MAY] patient + category + code + value-quantity + encounter |
- | JP_Observation_LabResult | - |
- | JP_Observation_VitalSigns | - |
- | JP_Observation_BodyMeasurement | - |
- | JP_Observation_PhysicalExam | - |
- | JP_Observation_SocialHistory | - |
ImagingStudy | JP_ImagingStudy_Radiology | [SHOULD] subject + modality [SHOULD] subject + bodysite [SHOULD] subject + started [SHOULD] subject + started + modality + bodysite [SHOULD]encounter |
DiagnosticReport | JP_DiagnosticReport_Common | [SHOULD] subject + category [SHOULD] subject + category + based-on [SHOULD] subject + category + date [MAY]based-on + category + code + conclusion + date + encounter + identifier + issued + media + performer + result + results-interpreter + status + subject |
- | JP_DiagnosticReport_LabResult | - |
- | JP_DiagnosticReport_Radiology | - |
AllergyIntolerance | JP_AllergyIntolerance | [SHALL] patient [SHALL] patient + date [SHOULD] patient + clinicalstatus [SHOULD] patient + verificationstatus [SHOULD] patient + type [SHOULD] patient + category [SHOULD] patient + criticality |
Condition | JP_Condition | [SHALL] patient [SHALL] patient + date [SHOULD] patient + clinicalstatus [SHOULD] patient + verificationstatus [SHOULD] patient + category |
Procedure | JP_Procedure | [SHALL] patient [SHALL] patient + date |
2.5.2.4. RESTful Capabilities by Resource/Profile:
Capablity StatementリソースはJPCoreClientCapabilityStatementより参照すること。
REST Capabilities
Mode | Client |
transaction | MAY |
batch | MAY |
search-system | MAY |
history-system | MAY |
Resource Interactions
Resource Type | Supported Profiles | Create | SearchType | Read | Vread | Update | Patch | Delete | HistoryInstance | HistoryType |
---|---|---|---|---|---|---|---|---|---|---|
Patient | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Coverage | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Encounter | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Location | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Organization | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Practitioner | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
PractitionerRole | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Medication | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
MedicationRequest | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
MedicationDispense | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
MedicationAdministration | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Observation | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
ImagingStudy | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
DiagnosticReport | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
AllergyIntolerance | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Condition | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY | |
Procedure | MAY | SHALL | SHALL | SHOULD | MAY | MAY | MAY | SHOULD | MAY |
Search Parameters per resource type
Patient
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | 患者ID | MAY |
name | string | 氏名(名前全体) | MAY |
family | string | 姓 | MAY |
given | string | 名 | MAY |
birthdate | date | 生年月日 | MAY |
gender | token | 性別 | MAY |
phone | string | 電話番号 | MAY |
address-postalcode | string | 郵便番号 | MAY |
Supported Reverse Includes:
- Provenance:target
Coverage
Name | Type | Documentation | Level |
---|---|---|---|
beneficiary | reference | 保険受益者 | MAY |
class-type | token | 保険者が発行した特定の健康カード番号のラベル | MAY |
class-value | string | 保険者が発行したラベルに関連付けられた英数字の文字列値 | MAY |
dependent | string | 補償対象の被扶養者 | MAY |
identifier | token | 一意識別子 | MAY |
patient | reference | 患者 | MAY |
payor | reference | 保険の引受人または支払人 | MAY |
policy-holder | reference | 保険証券を「所有する」当事者 | MAY |
status | token | ステータス | MAY |
subscriber | reference | 契約当事者 | MAY |
type | token | 補償の種類 | MAY |
Supported Reverse Includes:
- Provenance:target
Encounter
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | 患者 | MAY |
identifier | token | 外来・入院(外部向け)識別子 | MAY |
class | token | 分類 | MAY |
date | date | イベント発生日 | MAY |
status | token | 状態 | MAY |
type | token | 具体的な外来・入院の事象 | MAY |
Supported Reverse Includes:
- Provenance:target
Location
Name | Type | Documentation | Level |
---|---|---|---|
name | string | 場所の名称 | MAY |
address | string | 住所 | MAY |
address-city | string | 市区町村 | MAY |
address-state | string | 場所のステータス | MAY |
address-postalcode | string | 場所の郵便番号 | MAY |
Supported Reverse Includes:
- Provenance:target
Organization
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | 組織を識別するための識別子 | MAY |
name | string | 組織名称 | MAY |
address | string | 組織の住所 | MAY |
Supported Reverse Includes:
- Provenance:target
Practitioner
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | 医療従事者の識別子 | MAY |
name | string | 医療従事者の名称 | MAY |
Supported Reverse Includes:
- Provenance:target
PractitionerRole
Name | Type | Documentation | Level |
---|---|---|---|
specialty | token | 医療者の特定の専門性 | MAY |
practitioner | reference | 医療従事者 | MAY |
Supported Reverse Includes:
- Provenance:target
Medication
No search parameters are stated for this resource type
Supported Reverse Includes:
- Provenance:target
MedicationRequest
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | 外部向け識別子 | MAY |
patient | reference | 患者 | MAY |
authoredon | date | 処方発行が最初に行なわれた日 | MAY |
date | date | 服用開始日 | MAY |
category | token | 薬剤使用区分 | MAY |
code | token | 薬品コード | MAY |
requester | reference | 処方発行者 | MAY |
Supported Reverse Includes:
- Provenance:target
MedicationDispense
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | 調剤払い出し識別子 | MAY |
patient | reference | 患者 | MAY |
whenhandedover | date | 払い出し日時 | MAY |
whenprepared | date | 調剤日時 | MAY |
code | token | 薬品コード | MAY |
performer | reference | 調剤実施者 | MAY |
context | reference | 調剤イベントに関連する外来・入院およびケアエピソード | MAY |
Supported Reverse Includes:
- Provenance:target
MedicationAdministration
Name | Type | Documentation | Level |
---|---|---|---|
identifier | token | 薬品識別子(RP番号+薬剤番号) | MAY |
patient | reference | 患者 | MAY |
effective-time | date | 実施日時 | MAY |
code | token | 薬品コード | MAY |
Supported Reverse Includes:
- Provenance:target
Observation
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | 患者 | MAY |
subject | reference | 検査の対象 | MAY |
category | token | 種別(タイプ)の分類 | MAY |
code | token | コードもしくはタイプ | MAY |
date | date | 臨床に関連する時刻または時間 | MAY |
encounter | reference | 医療提供者と患者の接点 | MAY |
value-quantity | quantity | 検査値 | MAY |
value-concept | token | 検査コード | MAY |
value-string | token | 検査値 | MAY |
based-on | reference | オーダー依頼科 | MAY |
Supported Reverse Includes:
- Provenance:target
ImagingStudy
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | 患者 | MAY |
subject | reference | 検査の対象 | MAY |
modality | token | 装置 | MAY |
bodysite | token | 部位 | MAY |
started | date | 検査開始日時 | MAY |
encounter | reference | 外来・入院情報 | MAY |
Supported Reverse Includes:
- Provenance:target
DiagnosticReport
Name | Type | Documentation | Level |
---|---|---|---|
based-on | reference | 依頼情報 | MAY |
category | token | 臨床分野・部門・診断サービス(CT, US, MRIなど)を分類するコード | MAY |
code | token | レポートの種別 | MAY |
conclusion | token | レポート本文 | MAY |
date | date | レポート作成日 | MAY |
encounter | reference | 外来・入院情報 | MAY |
identifier | token | 一意識別子 | MAY |
issued | date | 発行日時 | MAY |
media | reference | 画像情報 | MAY |
patient | reference | 対象の患者 | MAY |
performer | reference | レポート記載者 | MAY |
result | reference | 診断レポートの一部 | MAY |
results-interpreter | reference | レポートの結論や読影に関わる医師や組織 | MAY |
status | token | レポート進捗 | MAY |
subject | reference | レポート対象 | MAY |
Supported Reverse Includes:
- Provenance:target
AllergyIntolerance
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | 患者 | MAY |
clinical-status | token | アレルギー・不耐性の臨床的なステータス | MAY |
date | date | 記載日時 | MAY |
category | token | 特定された原因物質のカテゴリ | MAY |
verification-status | token | 特定された物質に対する反応の傾向や潜在的なリスクの確実性 | MAY |
criticality | token | 特定された物質に対する反応や潜在的な臨床的危害または深刻さの推定 | MAY |
Supported Reverse Includes:
- Provenance:target
Condition
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | 患者 | MAY |
clinical-status | token | 臨床的状態のステータス | MAY |
onset-date | date | 発症日時 | MAY |
category | token | カテゴリ | MAY |
verification-status | token | clinicalStatusの確からしさ | MAY |
Supported Reverse Includes:
- Provenance:target
Procedure
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | 患者 | MAY |
date | date | 処置実施日時 | MAY |
Supported Reverse Includes:
- Provenance:target