Server CapabilityStatement

Publication Build: This will be filled in by the publication tooling

CapabilityStatement: JP Core Server CapabilityStatement

項目	内容
定義URL	http://jpfhir.jp/fhir/core/CapabilityStatement/JP_Server_CapabilityStatement
Version	1.1.1
Name	JP_Server_CapabilityStatement
Title	JP Core Server CapabilityStatement
Status	Active ( 2022-10-24 )
Copyright	Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

JP Core実装ガイドを利用したサイトを作成する際にサーバ側で規定するCapablityStatementのOperationsおよびSearch Parametersのリスト例を提示する。JP Core ServerがサポートするFHIRプロファイルに限定しているため、FHIR Baseのプロファイルを利用する際などは必要な項目を追記すること。

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

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として認識すること
セキュリティ
- See the General Security Considerations section for requirements and recommendations.
- サーバはunauthorizedなリクエストに対してはHTTP 401を返さなければならない。(SHALL)

RESTful Capabilities by Resource/Profile:

Raw OpenAPI-Swagger Definition file | Download

JP Core Server CapabilityStatement

Implementation Guide Version: 1.1.1
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats:
Published on: Mon Oct 24 00:00:00 UTC 2022
Published by: FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI)

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: `server`

Summary of System-wide Interactions

Supports the transaction interaction.
Supports the batch interaction.
Supports the search-system interaction.
Supports the history-system interaction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	V-R	S	U	P	C	D	H-I	H-T	Searches	`_revinclude`
Patient	Supported profiles: JP Core Patient Profile	y	y	y	y	y	y	y	y	y	identifier, name, family, given, birthdate, gender, phone, address-postalcode	`Provenance:target`
Coverage	Supported profiles: JP Core Coverage Profile	y	y	y	y	y	y	y	y	y	beneficiary, class-type, class-value, dependent, identifier, patient, payor, policy-holder, status, subscriber, type	`Provenance:target`
Encounter	Supported profiles: JP Core Encounter Profile	y	y	y	y	y	y	y	y	y	patient, identifier, class, date, status, type	`Provenance:target`
Location	Supported profiles: JP Core Location Profile	y	y	y	y	y	y	y	y	y	identifier, name, address, address-city, address-state, address-postalcode	`Provenance:target`
Organization	Supported profiles: JP Core Organization Profile	y	y	y	y	y	y	y	y	y	identifier, name, address	`Provenance:target`
Practitioner	Supported profiles: JP Core Practitioner Profile	y	y	y	y	y	y	y	y	y	identifier, name	`Provenance:target`
PractitionerRole	Supported profiles: JP Core PractitionerRole Profile	y	y	y	y	y	y	y	y	y	identifier, specialty, practitioner	`Provenance:target`
Medication	Supported profiles: JP Core Medication Profile	y	y	y	y	y	y	y	y	y	identifier	`Provenance:target`
MedicationRequest	Supported profiles: JP Core MedicationRequest Profile JP Core MedicationRequest Injection Profile	y	y	y	y	y	y	y	y	y	identifier, patient, authoredon, date, category, code, requester, jp-medication-start	`Provenance:target`
MedicationDispense	Supported profiles: JP Core MedicationDispense Profile JP Core MedicationDispense Injection Profile	y	y	y	y	y	y	y	y	y	identifier, patient, whenhandedover, whenprepared, code, performer, context	`Provenance:target`
MedicationAdministration	Supported profiles: JP Core MedicationAdministration Profile JP Core MedicationAdministration Injection Profile	y	y	y	y	y	y	y	y	y	identifier, patient, effective-time, code, performer, request	`Provenance:target`
Immunization	Supported profiles: JP Core Immunization Profile	y	y	y	y	y	y	y	y	y	identifier, patient, date	`Provenance:target`
Observation	Supported profiles: JP Core Observation Common Profile JP Core Observation LabResult Profile JP Core Observation VitalSigns Profile JP Core Observation BodyMeasurement Profile JP Core Observation PhysicalExam Profile JP Core Observation SocialHistory Profile	y	y	y	y	y	y	y	y	y	identifier, patient, category, code, date, encounter, value-quantity, value-concept, value-string, based-on	`Provenance:target`
ImagingStudy	Supported profiles: JP Core ImagingStudy Radiology Profile	y	y	y	y	y	y	y	y	y	identifier, patient, modality, bodysite, started, encounter	`Provenance:target`
DiagnosticReport	Supported profiles: JP Core DiagnosticReport Common Profile JP Core DiagnosticReport LabResult Profile JP Core DiagnosticReport Radiology Profile	y	y	y	y	y	y	y	y	y	based-on, category, code, conclusion, date, encounter, identifier, issued, media, patient, performer, result, results-interpreter, specimen, status	`Provenance:target`
AllergyIntolerance	Supported profiles: JP Core AllergyIntolerance Profile	y	y	y	y	y	y	y	y	y	identifier, patient, clinical-status, date, category, verification-status, criticality, type	`Provenance:target`
Condition	Supported profiles: JP Core Condition Profile	y	y	y	y	y	y	y	y	y	identifier, patient, clinical-status, onset-date, category, verification-status	`Provenance:target`
Procedure	Supported profiles: JP Core Procedure Profile	y	y	y	y	y	y	y	y	y	identifier, patient, date	`Provenance:target`
FamilyMemberHistory	Supported profiles: JP Core FamilyMemberHistory Profile	y	y	y	y	y	y	y	y	y	identifier, patient, status, relationship	`Provenance:target`

Resource Conformance: supportedPatient

Core FHIR Resource
Patient

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Patient

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	name	`string`
SHALL	family	`string`
SHALL	given	`string`
SHALL	birthdate	`date`
SHALL	gender	`token`
SHALL	phone	`token`
SHALL	address-postalcode	`string`

Resource Conformance: supportedCoverage

Core FHIR Resource
Coverage

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Coverage

Search Parameters

Conformance	Parameter	Type
SHALL	beneficiary	`reference`
SHALL	class-type	`token`
SHALL	class-value	`string`
SHALL	dependent	`string`
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	payor	`reference`
SHALL	policy-holder	`reference`
SHALL	status	`token`
SHALL	subscriber	`reference`
SHALL	type	`token`

Resource Conformance: supportedEncounter

Core FHIR Resource
Encounter

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Encounter

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`reference`
SHALL	identifier	`token`
SHALL	class	`token`
SHALL	date	`date`
SHALL	status	`token`
SHALL	type	`token`

Resource Conformance: supportedLocation

Core FHIR Resource
Location

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Location

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	name	`string`
SHALL	address	`string`
SHALL	address-city	`string`
SHALL	address-state	`string`
SHALL	address-postalcode	`string`

Resource Conformance: supportedOrganization

Core FHIR Resource
Organization

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Organization

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	name	`string`
SHALL	address	`string`

Resource Conformance: supportedPractitioner

Core FHIR Resource
Practitioner

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Practitioner

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`
SHALL	name	`string`

Resource Conformance: supportedPractitionerRole

Core FHIR Resource
PractitionerRole

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_PractitionerRole

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	specialty	`token`
SHALL	practitioner	`reference`

Resource Conformance: supportedMedication

Core FHIR Resource
Medication

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Medication

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`

Resource Conformance: supportedMedicationRequest

Core FHIR Resource
MedicationRequest

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest
http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRequest_Injection

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	authoredon	`date`
SHALL	date	`date`
SHALL	category	`token`
SHALL	code	`token`
SHALL	requester	`reference`
SHALL	jp-medication-start	`date`

Resource Conformance: supportedMedicationDispense

Core FHIR Resource
MedicationDispense

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationDispense
http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationDispense_Injection

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	whenhandedover	`date`
SHALL	whenprepared	`date`
SHALL	code	`token`
SHALL	performer	`reference`
SHALL	context	`reference`

Resource Conformance: supportedMedicationAdministration

Core FHIR Resource
MedicationAdministration

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationAdministration
http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationAdministration_Injection

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	effective-time	`date`
SHALL	code	`token`
SHALL	performer	`reference`
SHALL	request	`reference`

Resource Conformance: supportedImmunization

Core FHIR Resource
Immunization

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Immunization

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	date	`date`

Resource Conformance: supportedObservation

Core FHIR Resource
Observation

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_Common
http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_LabResult
http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_VitalSigns
http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_BodyMeasurement
http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_PhysicalExam
http://jpfhir.jp/fhir/core/StructureDefinition/JP_Observation_SocialHistory

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	category	`token`
SHALL	code	`token`
SHALL	date	`date`
SHALL	encounter	`reference`
SHALL	value-quantity	`quantity`
SHALL	value-concept	`token`
SHALL	value-string	`string`
SHALL	based-on	`reference`

Resource Conformance: supportedImagingStudy

Core FHIR Resource
ImagingStudy

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_ImagingStudy_Radiology

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	modality	`token`
SHALL	bodysite	`token`
SHALL	started	`date`
SHALL	encounter	`reference`

Resource Conformance: supportedDiagnosticReport

Core FHIR Resource
DiagnosticReport

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_DiagnosticReport_Common
http://jpfhir.jp/fhir/core/StructureDefinition/JP_DiagnosticReport_LabResult
http://jpfhir.jp/fhir/core/StructureDefinition/JP_DiagnosticReport_Radiology

Search Parameters

Conformance	Parameter	Type
SHALL	based-on	`reference`
SHALL	category	`token`
SHALL	code	`token`
SHALL	conclusion	`token`
SHALL	date	`date`
SHALL	encounter	`reference`
SHALL	identifier	`token`
SHALL	issued	`date`
SHALL	media	`reference`
SHALL	patient	`reference`
SHALL	performer	`reference`
SHALL	result	`reference`
SHALL	results-interpreter	`reference`
SHALL	specimen	`reference`
SHALL	status	`token`

Resource Conformance: supportedAllergyIntolerance

Core FHIR Resource
AllergyIntolerance

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_AllergyIntolerance

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	clinical-status	`token`
SHALL	date	`date`
SHALL	category	`token`
SHALL	verification-status	`token`
SHALL	criticality	`token`
SHALL	type	`token`

Resource Conformance: supportedCondition

Core FHIR Resource
Condition

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Condition

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	clinical-status	`token`
SHALL	onset-date	`date`
SHALL	category	`token`
SHALL	verification-status	`token`

Resource Conformance: supportedProcedure

Core FHIR Resource
Procedure

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_Procedure

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	date	`date`

Resource Conformance: supportedFamilyMemberHistory

Core FHIR Resource
FamilyMemberHistory

Reference Policy
resolves

Interaction summary

Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

http://jpfhir.jp/fhir/core/StructureDefinition/JP_FamilyMemberHistory

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	patient	`reference`
SHALL	status	`token`
SHALL	relationship	`token`

CapabilityStatement: JP Core Server CapabilityStatement

FHIR RESTful Capabilities

RESTful Capabilities by Resource/Profile:

JP Core Server CapabilityStatement

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: supportedPatient

Resource Conformance: supportedCoverage

Resource Conformance: supportedEncounter

Resource Conformance: supportedLocation

Resource Conformance: supportedOrganization

Resource Conformance: supportedPractitioner

Resource Conformance: supportedPractitionerRole

Resource Conformance: supportedMedication

Resource Conformance: supportedMedicationRequest

Resource Conformance: supportedMedicationDispense

Resource Conformance: supportedMedicationAdministration

Resource Conformance: supportedImmunization

Resource Conformance: supportedObservation

Resource Conformance: supportedImagingStudy

Resource Conformance: supportedDiagnosticReport

Resource Conformance: supportedAllergyIntolerance

Resource Conformance: supportedCondition

Resource Conformance: supportedProcedure

Resource Conformance: supportedFamilyMemberHistory

Mode: `server`