HL7 FHIR JP Core ImplementationGuide
1.1.2 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.2) 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.1.2
Name

JP_Client_CapabilityStatement

Title

JP Core Client CapabilityStatement

Status Active ( 2023-10-31 )
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

JP Core Client CapabilityStatement

  • Implementation Guide Version: 1.1.2
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2023-10-31
  • 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 CapabilityStatementJP 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-postalcodeProvenance:target
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
yyyyyyyyypatient, identifier, class, date, status, typeProvenance:target
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-startProvenance:target
MedicationDispenseSupported Profiles
  JP Core MedicationDispense Profile
  JP Core MedicationDispense Injection Profile
yyyyyyyyyidentifier, patient, whenhandedover, whenprepared, code, performer, contextProvenance:target
MedicationAdministrationSupported Profiles
  JP Core MedicationAdministration Profile
  JP Core MedicationAdministration Injection Profile
yyyyyyyyyidentifier, patient, effective-time, code, performer, requestProvenance:target
ImmunizationSupported Profiles
  JP Core Immunization Profile
yyyyyyyyyidentifier, patient, dateProvenance: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
yyyyyyyyyidentifier, patient, category, code, date, encounter, value-quantity, value-concept, value-string, based-onProvenance:target
ImagingStudySupported Profiles
  JP Core ImagingStudy Radiology Profile
  JP Core ImagingStudy Endoscopy Profile
yyyyyyyyyidentifier, patient, modality, bodysite, started, encounterProvenance: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
yyyyyyyyybased-on, category, code, conclusion, date, encounter, identifier, issued, media, patient, performer, result, results-interpreter, specimen, statusProvenance:target
AllergyIntoleranceSupported Profiles
  JP Core AllergyIntolerance Profile
yyyyyyyyyidentifier, patient, clinical-status, date, category, verification-status, criticality, typeProvenance:target
ConditionSupported Profiles
  JP Core Condition Profile
yyyyyyyyyidentifier, patient, clinical-status, onset-date, category, verification-statusProvenance:target
ProcedureSupported Profiles
  JP Core Procedure Profile
yyyyyyyyyidentifier, patient, dateProvenance:target
FamilyMemberHistorySupported Profiles
  JP Core FamilyMemberHistory Profile
yyyyyyyyyidentifier, patient, status, relationshipProvenance:target

Resource Conformance: supported Patient

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
SHALLfamilystring
SHALLgivenstring
SHALLbirthdatedate
SHALLgendertoken
SHALLphonetoken
SHALLaddress-postalcodestring
 

Resource Conformance: supported Coverage

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLbeneficiaryreference
SHALLclass-typetoken
SHALLclass-valuestring
SHALLdependentstring
SHALLidentifiertoken
SHALLpatientreference
SHALLpayorreference
SHALLpolicy-holderreference
SHALLstatustoken
SHALLsubscriberreference
SHALLtypetoken
 

Resource Conformance: supported Encounter

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLidentifiertoken
SHALLclasstoken
SHALLdatedate
SHALLstatustoken
SHALLtypetoken
 

Resource Conformance: supported Location

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
SHALLaddressstring
SHALLaddress-citystring
SHALLaddress-statestring
SHALLaddress-postalcodestring
 

Resource Conformance: supported 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
SHALLnamestring
SHALLaddressstring
 

Resource Conformance: supported 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: supported 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
SHALLspecialtytoken
SHALLpractitionerreference
 

Resource Conformance: supported Medication

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLauthoredondate
SHALLdatedate
SHALLcategorytoken
SHALLcodetoken
SHALLrequesterreference
SHALLjp-medication-startdate
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLwhenhandedoverdate
SHALLwhenprepareddate
SHALLcodetoken
SHALLperformerreference
SHALLcontextreference
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLeffective-timedate
SHALLcodetoken
SHALLperformerreference
SHALLrequestreference
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLdatedate
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLmodalitytoken
SHALLbodysitetoken
SHALLstarteddate
SHALLencounterreference
 

Resource Conformance: supported 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
SHALLbased-onreference
SHALLcategorytoken
SHALLcodetoken
SHALLconclusiontoken
SHALLdatedate
SHALLencounterreference
SHALLidentifiertoken
SHALLissueddate
SHALLmediareference
SHALLpatientreference
SHALLperformerreference
SHALLresultreference
SHALLresults-interpreterreference
SHALLspecimenreference
SHALLstatustoken
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLclinical-statustoken
SHALLdatedate
SHALLcategorytoken
SHALLverification-statustoken
SHALLcriticalitytoken
SHALLtypetoken
 

Resource Conformance: supported Condition

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLpatientreference
SHALLclinical-statustoken
SHALLonset-datedate
SHALLcategorytoken
SHALLverification-statustoken
 

Resource Conformance: supported Procedure

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLpatientreference
SHALLdatedate
 

Resource Conformance: supported 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
SHALLpatientreference
SHALLstatustoken
SHALLrelationshiptoken
 
本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。