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より参照すること。

RESTful Interactions

ModeClient
transactionMAY
batchMAY
search-systemMAY
history-systemMAY

Resource TypeCreateSearchTypeReadVreadUpdatePatchDeleteHistoryInstanceHistoryType
PatientMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
CoverageMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
EncounterMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
LocationMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
OrganizationMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
PractitionerMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
PractitionerRoleMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
MedicationMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
MedicationRequestMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
MedicationDispenseMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
MedicationAdministrationMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
ObservationMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
ImagingStudyMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
DiagnosticReportMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
AllergyIntoleranceMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
ConditionMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY
ProcedureMAYSHALLSHALLSHOULDMAYMAYMAYSHOULDMAY

Search Parameters per resource type

Patient

NameTypeDocumentationLevel
identifiertoken患者IDMAY
namestring氏名(名前全体)MAY
familystringMAY
givenstringMAY
birthdatedate生年月日MAY
gendertoken性別MAY
phonestring電話番号MAY
address-postalcodestring郵便番号MAY

Supported Reverse Includes:

  • Provenance:target

Coverage

NameTypeDocumentationLevel
beneficiaryreference保険受益者MAY
class-typetoken保険者が発行した特定の健康カード番号のラベルMAY
class-valuestring保険者が発行したラベルに関連付けられた英数字の文字列値MAY
dependentstring補償対象の被扶養者MAY
identifiertoken一意識別子MAY
patientreference患者MAY
payorreference保険の引受人または支払人MAY
policy-holderreference保険証券を「所有する」当事者MAY
statustokenステータスMAY
subscriberreference契約当事者MAY
typetoken補償の種類MAY

Supported Reverse Includes:

  • Provenance:target

Encounter

NameTypeDocumentationLevel
patientreference患者MAY
identifiertoken外来・入院(外部向け)識別子MAY
classtoken分類MAY
datedateイベント発生日MAY
statustoken状態MAY
typetoken具体的な外来・入院の事象MAY

Supported Reverse Includes:

  • Provenance:target

Location

NameTypeDocumentationLevel
namestring場所の名称MAY
addressstring住所MAY
address-citystring市区町村MAY
address-statestring場所のステータスMAY
address-postalcodestring場所の郵便番号MAY

Supported Reverse Includes:

  • Provenance:target

Organization

NameTypeDocumentationLevel
identifiertoken組織を識別するための識別子MAY
namestring組織名称MAY
addressstring組織の住所MAY

Supported Reverse Includes:

  • Provenance:target

Practitioner

NameTypeDocumentationLevel
identifiertoken医療従事者の識別子MAY
namestring医療従事者の名称MAY

Supported Reverse Includes:

  • Provenance:target

PractitionerRole

NameTypeDocumentationLevel
specialtytoken医療者の特定の専門性MAY
practitionerreference医療従事者MAY

Supported Reverse Includes:

  • Provenance:target

Medication

No search parameters are stated for this resource type

Supported Reverse Includes:

  • Provenance:target

MedicationRequest

NameTypeDocumentationLevel
identifiertoken外部向け識別子MAY
patientreference患者MAY
authoredondate処方発行が最初に行なわれた日MAY
datedate服用開始日MAY
categorytoken薬剤使用区分MAY
codetoken薬品コードMAY
requesterreference処方発行者MAY

Supported Reverse Includes:

  • Provenance:target

MedicationDispense

NameTypeDocumentationLevel
identifiertoken調剤払い出し識別子MAY
patientreference患者MAY
whenhandedoverdate払い出し日時MAY
whenprepareddate調剤日時MAY
codetoken薬品コードMAY
performerreference調剤実施者MAY
contextreference調剤イベントに関連する外来・入院およびケアエピソードMAY

Supported Reverse Includes:

  • Provenance:target

MedicationAdministration

NameTypeDocumentationLevel
identifiertoken薬品識別子(RP番号+薬剤番号)MAY
patientreference患者MAY
effective-timedate実施日時MAY
codetoken薬品コードMAY

Supported Reverse Includes:

  • Provenance:target

Observation

NameTypeDocumentationLevel
patientreference患者MAY
categorytoken種別(タイプ)の分類MAY
codetokenコードもしくはタイプMAY
datedate臨床に関連する時刻または時間MAY
encounterreference医療提供者と患者の接点MAY
value-quantityquantity検査値MAY
value-concepttoken検査コードMAY
based-onreferenceオーダー依頼科MAY

Supported Reverse Includes:

  • Provenance:target

ImagingStudy

NameTypeDocumentationLevel
patientreference患者MAY
modalitytoken装置MAY
bodysitetoken部位MAY
starteddate検査開始日時MAY
encounterreference外来・入院情報MAY

Supported Reverse Includes:

  • Provenance:target

DiagnosticReport

NameTypeDocumentationLevel
patientreference患者MAY
categorytoken臨床分野・部門・診断サービス(CT, US, MRIなど)を分類するコードMAY
codetokenレポートの種別MAY
datedateレポート作成日MAY
based-onreferenceオーダー依頼科MAY

Supported Reverse Includes:

  • Provenance:target

AllergyIntolerance

NameTypeDocumentationLevel
patientreference患者MAY
clinical-statustokenアレルギー・不耐性の臨床的なステータスMAY
datedate記載日時MAY
categorytoken特定された原因物質のカテゴリMAY
verification-statustoken特定された物質に対する反応の傾向や潜在的なリスクの確実性MAY
criticalitytoken特定された物質に対する反応や潜在的な臨床的危害または深刻さの推定MAY

Supported Reverse Includes:

  • Provenance:target

Condition

NameTypeDocumentationLevel
patientreference患者MAY
clinical-statustoken臨床的状態のステータスMAY
onset-datedate発症日時MAY
categorytokenカテゴリMAY
verification-statustokenclinicalStatusの確からしさMAY

Supported Reverse Includes:

  • Provenance:target

Procedure

NameTypeDocumentationLevel
patientreference患者MAY
datedate処置実施日時MAY

Supported Reverse Includes:

  • Provenance:target

Documents

Mode