HL7 FHIR JP Core ImplementationGuide
1.2.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.2.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: JP Core Client CapabilityStatement

項目内容
定義URL http://jpfhir.jp/fhir/core/CapabilityStatement/JP_Client_CapabilityStatement
Version 1.2.0-dev
Name

JP_Client_CapabilityStatement

Title

JP Core Client CapabilityStatement

Status Active ( 2024-11-18 )
Copyright

Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

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

この章ではJP Core Clientの期待される機能について説明する。 JP Core Serverによってサポートされる FHIR プロファイル・RESTful操作・検索パラメータの完全なリストを定義する。
JP Core Clientは個別のユースケースや意味的な要請に応じてこれらのリストを通じて必要なデータにアクセスすることができる。

RESTful Capabilities by Resource/Profile:

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement jp-client-capabilitystatement

JP Core Client CapabilityStatement

  • Implementation Guide Version: 1.2.0-dev
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2024-11-18
  • 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.

This CapabilityStatement instantiates the CapabilityStatement JP Core Client CapabilityStatement

FHIR RESTful Capabilities

Mode: client

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the batchinteraction.
  • Supports the search-systeminteraction.
  • Supports the history-systeminteraction.

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 TypeProfileRV-RSUPCDH-IH-TSearches_include_revincludeOperations
PatientSupported Profiles
  JP Core Patient Profile
yyyyyyyyyidentifier, name, family, given, birthdate, gender, phone, address-postalcode, birthdate+name, birthdate+gender, birthdate+name+gender, name+phone, name+address-postalcode, family+given+birthdate+gender+phone+address-postalcodeProvenance:target$everything
CoverageSupported Profiles
  JP Core Coverage Profile
yyyyyyyyybeneficiary, class-type, class-value, dependent, identifier, patient, payor, policy-holder, status, subscriber, typeProvenance:target
EncounterSupported Profiles
  JP Core Encounter Profile
yyyyyyyyyidentifier, patient, class, date, status, type, date+patient, class+patient, patient+type, patient+statusProvenance:target$everything
LocationSupported Profiles
  JP Core Location Profile
yyyyyyyyyidentifier, name, address, address-city, address-state, address-postalcodeProvenance:target
OrganizationSupported Profiles
  JP Core Organization Profile
yyyyyyyyyidentifier, name, addressProvenance:target
PractitionerSupported Profiles
  JP Core Practitioner Profile
yyyyyyyyyidentifier, nameProvenance:target
PractitionerRoleSupported Profiles
  JP Core PractitionerRole Profile
yyyyyyyyyidentifier, specialty, practitionerProvenance:target
MedicationSupported Profiles
  JP Core Medication Profile
yyyyyyyyyidentifierProvenance:target
MedicationRequestSupported Profiles
  JP Core MedicationRequest Profile
  JP Core MedicationRequest Injection Profile
yyyyyyyyyidentifier, patient, authoredon, date, category, code, requester, jp-medication-start, patient+date, patient+authoredon, patient+jp-medication-start, date+authoredon+category+code+requesterProvenance:target
MedicationDispenseSupported Profiles
  JP Core MedicationDispense Profile
  JP Core MedicationDispense Injection Profile
yyyyyyyyyidentifier, patient, whenhandedover, whenprepared, code, performer, context, patient+whenhandedover, whenhandedover+whenprepared+context+code+performerProvenance:target
MedicationAdministrationSupported Profiles
  JP Core MedicationAdministration Profile
  JP Core MedicationAdministration Injection Profile
yyyyyyyyyidentifier, patient, effective-time, code, performer, request, patient+effective-time, effective-time+code+performer+requestProvenance:target
MedicationStatementSupported Profiles
  JP Core MedicationStatement Profile
  JP Core MedicationStatement Injection Profile
yyyyyyyyyidentifier, patientProvenance:target
ImmunizationSupported Profiles
  JP Core Immunization Profile
yyyyyyyyyidentifier, patient, date, lot-number, patient+date, date+lot-numberProvenance:target
ObservationSupported Profiles
  JP Core Observation Common Profile
  JP Core Observation LabResult Profile
  JP Core Observation Microbiology Profile
  JP Core Observation VitalSigns Profile
  JP Core Observation BodyMeasurement Profile
  JP Core Observation PhysicalExam Profile
  JP Core Observation SocialHistory Profile
  JP Core Observation Electrocardiogram Profile
  JP Core Observation Radiology Findings Profile
  JP Core Observation Radiology Impression Profile
  JP Core Observation Endoscopy Profile
yyyyyyyyyidentifier, patient, category, code, date, encounter, value-quantity, value-concept, value-string, based-on, code-value-concept, patient+code+date, patient+code+date+based-on, patient+code+date+value-quantity+based-on, patient+code+date+value-concept+based-on, patient+code+date+value-string+based-on, code+value-quantity+patient, code+value-concept+patient, code+value-string+patient, patient+category+code, patient+category+code+date, patient+code-value-concept, patient+code-value-concept+date, code-value-concept+date, patient+category+code+value-quantity, patient+category+code+value-quantity+date, patient+category+code+value-quantity+encounterProvenance:target$lastn
SpecimenSupported Profiles
  JP_Specimen_Common
yyyyyyyyyidentifierProvenance:target
MediaSupported Profiles
  JP Core media Endoscopy Profile
yyyyyyyyyidentifier, patient, modality, created, patient+modality, patient+created, patient+modality+createdProvenance:target
ImagingStudySupported Profiles
  JP Core ImagingStudy Radiology Profile
  JP Core ImagingStudy Endoscopy Profile
yyyyyyyyyidentifier, status, patient, encounter, modality, bodysite, started, patient+modality, patient+bodysite, patient+started, patient+started+modality, patient+started+modality+bodysiteProvenance:target
DiagnosticReportSupported Profiles
  JP Core DiagnosticReport Common Profile
  JP Core DiagnosticReport LabResult Profile
  JP Core DiagnosticReport Microbiology Profile
  JP Core DiagnosticReport Radiology Profile
  JP Core DiagnosticReport Endoscopy Profile
yyyyyyyyyidentifier, category, code, date, issued, patient, performer, status, based-on, conclusion, encounter, media, result, results-interpreter, specimen, patient+category, patient+category+based-on, patient+category+dateProvenance:target
AllergyIntoleranceSupported Profiles
  JP Core AllergyIntolerance Profile
yyyyyyyyyidentifier, patient, clinical-status, date, category, verification-status, criticality, type, patient+date, patient+clinical-status, patient+verification-status, patient+type, patient+category, patient+criticalityProvenance:target
ConditionSupported Profiles
  JP Core Condition Profile
yyyyyyyyyidentifier, patient, clinical-status, onset-date, category, verification-status, patient+onset-date, patient+clinical-status, patient+verification-status, patient+categoryProvenance:target
ProcedureSupported Profiles
  JP Core Procedure Profile
yyyyyyyyyidentifier, patient, date, patient+dateProvenance:target
FamilyMemberHistorySupported Profiles
  JP Core FamilyMemberHistory Profile
yyyyyyyyyidentifier, patient, status, relationship, patient+relationship, patient+statusProvenance:target
ServiceRequestSupported Profiles
  JP Core ServiceRequest Common Profile
yyyyyyyyyidentifier, intent, subject, status, performer, occurrence, patient, requester, authored, based-on, body-site, category, code, encounter, instantiates-canonical, instantiates-uri, performer-type, priority, replaces, requisition, specimenProvenance:target

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Patient Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDnamestring
MAYfamilystring
MAYgivenstring
MAYbirthdatedate
MAYgendertoken
MAYphonetoken
MAYaddress-postalcodestring
Combined Search Parameters
ConformanceParametersTypes
SHOULDbirthdate+namedate+string
SHOULDbirthdate+genderdate+token
SHOULDbirthdate+name+genderdate+string+token
SHOULDname+phonestring+token
SHOULDname+address-postalcodestring+string
MAYfamily+given+birthdate+gender+phone+address-postalcodestring+string+date+token+token+string
Extended Operations
ConformanceOperationDocumentation
MAY$everything

この操作が呼び出された場合、すべての患者の、あるいは指定された特定の[id]をもつPatientに関連した全てのリソースを返す。

Resource Conformance: SHALL Coverage

Core FHIR Resource
Coverage
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Coverage Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLbeneficiaryreference
SHOULDclass-typetoken
SHOULDclass-valuestring
SHOULDdependentstring
SHOULDidentifiertoken
SHOULDpatientreference
SHOULDpayorreference
SHOULDpolicy-holderreference
SHOULDstatustoken
SHOULDsubscriberreference
SHOULDtypetoken
 

Resource Conformance: SHALL Encounter

Core FHIR Resource
Encounter
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Encounter Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYclasstoken
MAYdatedate
MAYstatustoken
MAYtypetoken
Combined Search Parameters
ConformanceParametersTypes
SHOULDdate+patientdate+reference
SHOULDclass+patienttoken+reference
SHOULDpatient+typereference+token
SHOULDpatient+statusreference+token
Extended Operations
ConformanceOperationDocumentation
MAY$everything

この操作は、この操作が呼び出された特定のEncounterリソースに関連する全ての情報を返す。

Resource Conformance: SHALL Location

Core FHIR Resource
Location
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Location Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
SHOULDaddressstring
SHOULDaddress-citystring
SHOULDaddress-statestring
SHOULDaddress-postalcodestring
 

Resource Conformance: SHALL Organization

Core FHIR Resource
Organization
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDnamestring
SHOULDaddressstring
 

Resource Conformance: SHALL Practitioner

Core FHIR Resource
Practitioner
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
 

Resource Conformance: SHALL PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDspecialtytoken
SHOULDpractitionerreference
 

Resource Conformance: SHALL Medication

Core FHIR Resource
Medication
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Medication Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
 

Resource Conformance: SHALL MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYauthoredondate
MAYdatedate
MAYcategorytoken
MAYcodetoken
MAYrequesterreference
MAYjp-medication-startdate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+datereference+date
SHOULDpatient+authoredonreference+date
SHOULDpatient+jp-medication-startreference+date
MAYdate+authoredon+category+code+requesterdate+date+token+token+reference

Resource Conformance: SHALL MedicationDispense

Core FHIR Resource
MedicationDispense
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYwhenhandedoverdate
MAYwhenprepareddate
MAYcodetoken
MAYperformerreference
MAYcontextreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+whenhandedoverreference+date
MAYwhenhandedover+whenprepared+context+code+performerdate+date+reference+token+reference

Resource Conformance: SHALL MedicationAdministration

Core FHIR Resource
MedicationAdministration
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYeffective-timedate
MAYcodetoken
MAYperformerreference
MAYrequestreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+effective-timereference+date
MAYeffective-time+code+performer+requestdate+token+reference+reference

Resource Conformance: SHALL MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
 

Resource Conformance: SHALL Immunization

Core FHIR Resource
Immunization
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYdatedate
MAYlot-numberstring
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+datereference+date
MAYdate+lot-numberdate+string

Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
MAYpatientreference
MAYcategorytoken
MAYcodetoken
MAYdatedate
MAYencounterreference
MAYvalue-quantityquantity
MAYvalue-concepttoken
MAYvalue-stringstring
MAYbased-onreference
MAYcode-value-conceptcomposite
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+code+datereference+token+date
SHOULDpatient+code+date+based-onreference+token+date+reference
SHOULDpatient+code+date+value-quantity+based-onreference+token+date+quantity+reference
SHOULDpatient+code+date+value-concept+based-onreference+token+date+token+reference
SHOULDpatient+code+date+value-string+based-onreference+token+date+string+reference
SHOULDcode+value-quantity+patienttoken+quantity+reference
SHOULDcode+value-concept+patienttoken+token+reference
SHOULDcode+value-string+patienttoken+string+reference
SHOULDpatient+category+codereference+token+token
SHOULDpatient+category+code+datereference+token+token+date
SHOULDpatient+code-value-conceptreference+composite
SHOULDpatient+code-value-concept+datereference+composite+date
SHOULDcode-value-concept+datecomposite+date
MAYpatient+category+code+value-quantityreference+token+token+quantity
MAYpatient+category+code+value-quantity+datereference+token+token+quantity+date
MAYpatient+category+code+value-quantity+encounterreference+token+token+quantity+reference
Extended Operations
ConformanceOperationDocumentation
MAY$lastn

オペレーションはある条件に基づく最新、または最新からn件の検査結果/測定結果等を取得するという一般的なニーズを満たすためのオペレーションである。

Resource Conformance: SHALL Specimen

Core FHIR Resource
Specimen
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP_Specimen_Common

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
 

Resource Conformance: SHALL Media

Core FHIR Resource
Media
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
MAYpatientreference
MAYmodalitytoken
MAYcreateddate
Combined Search Parameters
ConformanceParametersTypes
MAYpatient+modalityreference+token
MAYpatient+createdreference+date
MAYpatient+modality+createdreference+token+date

Resource Conformance: SHALL ImagingStudy

Core FHIR Resource
ImagingStudy
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLstatustoken
SHOULDpatientreference
SHOULDencounterreference
MAYmodalitytoken
MAYbodysitetoken
MAYstarteddate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+modalityreference+token
SHOULDpatient+bodysitereference+token
SHOULDpatient+startedreference+date
SHOULDpatient+started+modalityreference+date+token
SHOULDpatient+started+modality+bodysitereference+date+token+token

Resource Conformance: SHALL DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDcategorytoken
SHOULDcodetoken
SHOULDdatedate
SHOULDissueddate
SHOULDpatientreference
SHOULDperformerreference
SHOULDstatustoken
MAYbased-onreference
MAYconclusiontoken
MAYencounterreference
MAYmediareference
MAYresultreference
MAYresults-interpreterreference
MAYspecimenreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+categoryreference+token
SHOULDpatient+category+based-onreference+token+reference
SHOULDpatient+category+datereference+token+date

Resource Conformance: SHALL AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYclinical-statustoken
MAYdatedate
MAYcategorytoken
MAYverification-statustoken
MAYcriticalitytoken
MAYtypetoken
Combined Search Parameters
ConformanceParametersTypes
MAYpatient+datereference+date
MAYpatient+clinical-statusreference+token
MAYpatient+verification-statusreference+token
MAYpatient+typereference+token
MAYpatient+categoryreference+token
MAYpatient+criticalityreference+token

Resource Conformance: SHALL Condition

Core FHIR Resource
Condition
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Condition Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYclinical-statustoken
MAYonset-datedate
MAYcategorytoken
MAYverification-statustoken
Combined Search Parameters
ConformanceParametersTypes
MAYpatient+onset-datereference+date
MAYpatient+clinical-statusreference+token
MAYpatient+verification-statusreference+token
MAYpatient+categoryreference+token

Resource Conformance: SHALL Procedure

Core FHIR Resource
Procedure
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Supported Profiles

JP Core Procedure Profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYdatedate
Combined Search Parameters
ConformanceParametersTypes
MAYpatient+datereference+date

Resource Conformance: SHALL FamilyMemberHistory

Core FHIR Resource
FamilyMemberHistory
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULDpatientreference
MAYstatustoken
MAYrelationshiptoken
Combined Search Parameters
ConformanceParametersTypes
MAYpatient+relationshipreference+token
MAYpatient+statusreference+token

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
resolves
Interaction summary
  • Supports create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLintenttoken
SHALLsubjectreference
SHALLstatustoken
SHOULDperformerreference
SHOULDoccurrencedate
SHOULDpatientreference
SHOULDrequesterreference
MAYauthoreddate
MAYbased-onreference
MAYbody-sitetoken
MAYcategorytoken
MAYcodetoken
MAYencounterreference
MAYinstantiates-canonicalreference
MAYinstantiates-uriuri
MAYperformer-typetoken
MAYprioritytoken
MAYreplacesreference
MAYrequisitiontoken
MAYspecimenreference
 
本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けている。