このドキュメントはHL7 FHIR実装ワーキンググループで作業中有の実装ガイドです。日本HL7協会が承認するものではありませんので、実装や利用は全て自己責任で行ってください。

2.5. Capability Statements

2.5.1. Server CapabilityStatement

この章ではJp Core Requestor[クライアント]から発行される問い合わせに対して応答する責務のある、Jp Core Serverに要求される機能(expected capabilities)について記載する。
Jp Core Serverによってサポートされる FHIR プロファイル・RESTful操作・検索パラメータの完全なリストを定義する。
本要件の実装は
~~(準拠すべき日本国内用仕様を列挙)~~
に準拠しなければならない。
Jp Core Clientは個別のユースケースや意味的な要請に応じてこれらのリストを通じて必要なデータにアクセスすることができる。

■2.5.1.1. JP Core Server Server CapabilityStatement

  • Implementation Guide Version: ..*
  • FHIR Version: 4.0.1
  • Supported formats: xml, json
  • Published by: HL7 FHIR JP WG

■2.5.1.2. FHIR RESTful Capabilities

  • Jp Coreは以下の要件を必須とする(SHALL)

    • 患者(Patient)プロファイルのサポート
    • Jp Core プロファイルから少なくとも1つの追加リソースプロファイルのサポート
    • 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)
  • システムは以下のインタラクションをサポートしても良い(MAY)。

    • transaction interaction.
    • batch interaction.
    • search-system interaction.
    • history-system interaction.

■2.5.1.3. RESTful Capabilities by Resource/Profile:

Resource Type Supported Profiles Supported Searches SWG
AllergyIntolerance JP_AllergyIntolerance_v400 SWG4
Appointment JP_Appointment SWG4
AppointmentResponse JP_AppointmentResponse SWG4
CarePlan SWG4
CareTeam SWG4
Condition JP_Condition
Coverage JP_Coverage
Device
DiagnosticReport
DocumentReference
Encounter JP_Encounter SWG3
Goal
Immunization JP_Immunization
Location JP_Location SWG3
MedicationDispense JP_MedicationAdministration patient+status SWG5
MedicationRequest JP_MedicationRequest patient+medication SWG5
Observation JP_Observation,
JP_Observation_BodyMeasurement,
JP_Observation_LabResult,
JP_Observation_Microbiology,
JP_Observation_PhysicalExam,
JP_Observation_SocialHistory,
JP_Observation_VitalSigns
SWG2
Organization JP_Organization SWG3
Patient JP_Patient identifier, name, birthdate+name, birthdate+gender, birthdate+name+gender, name+phone, name+address-postalcode, family+given+birthdate+gender+phone+address-postalcode SWG3
Practitioner JP_Practitioner SWG3
PractitionerRole JP_PractitionerRole SWG3
Procedure JP_Procedure
Provenance
Schedule JP_Schedule SWG3
Slot JP_Slot SWG3
ValueSet
■2.5.1.3.X Patient

Conformance Expectation: SHALL

Supported Profiles: JP_Patient Profile

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread, history-instance.
  • MAY support create, update, patch, delete, history-type.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Patient resource using:
    GET [base]/Patient/[id]
  • A Server SHALL be capable of supporting the following _revincludes:
    Provenance:target - GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target

Search Parameter Summary:

Conformance Parameter Type Example
SHALL identifier token GET [base]/Patient?identifier=[identifier]
SHOULD name string GET [base]/Patient?name=[name]

Search Parameter Combination Summary:

Conformance Parameter Combination Type Example
SHOULD birthdate+name date+string GET [base]/Patient?birthdate=[birthdate]&name=[name]
SHOULD birthdate+gender date+token GET [base]/Patient?birthdate=[birthdate]&gender=[system]|[code]
SHOULD birthdate+name+gender date+string+token GET [base]/Patient?birthdate=[birthdate]&name=[name]&gender=[system]|[code]
SHOULD name+phone string+token GET [base]/Patient?name=[name]&phone=[system]|[code]
SHOULD name+address-postalcode string+string GET [base]/Patient?name=[name]&address-postalcode=[address-postalcode]
MAY family+given+birthdate+gender+phone+address-postalcode string+string+date+token+token+string

2.5.2. ClientCapabilityStatements

(作成中)