HL7 FHIR JP Core ImplementationGuide
1.2.0-dev - ci-build
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
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/core/CapabilityStatement/JP_Server_CapabilityStatement |
Version | 1.2.0-dev |
Name | JP_Server_CapabilityStatement |
Title | JP Core Server 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 Requestor[クライアント]から発行される問い合わせに対して応答する責務のある、JP Core Serverに要求される機能(expected capabilities)について記載する。
JP Core Serverによってサポートされる FHIR プロファイル・RESTful操作・検索パラメータの完全なリストを定義する。
JP Core Clientは個別のユースケースや意味的な要請に応じてこれらのリストを通じて必要なデータにアクセスすることができる。
全てのJP Core interactionにおいてjson記述をサポートすること(SHOULD)
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement jp-server-capabilitystatement
json
, xml
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 Server CapabilityStatement
server
transaction
interaction.batch
interaction.search-system
interaction.history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | P | C | D | H-I | H-T | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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, birthdate+name, birthdate+gender, birthdate+name+gender, name+phone, name+address-postalcode, family+given+birthdate+gender+phone+address-postalcode | Provenance:target | $everything | |
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 | identifier, patient, class, date, status, type, date+patient, class+patient, patient+type, patient+status | Provenance:target | $everything | |
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, patient+date, patient+authoredon, patient+jp-medication-start, date+authoredon+category+code+requester | 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, patient+whenhandedover, whenhandedover+whenprepared+context+code+performer | 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, patient+effective-time, effective-time+code+performer+request | Provenance:target | ||
MedicationStatement | Supported Profiles JP Core MedicationStatement Profile JP Core MedicationStatement Injection Profile | y | y | y | y | y | y | y | y | y | identifier, patient | Provenance:target | ||
Immunization | Supported Profiles JP Core Immunization Profile | y | y | y | y | y | y | y | y | y | identifier, patient, date, lot-number, patient+date, date+lot-number | Provenance:target | ||
Observation | Supported 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 | y | y | y | y | y | y | y | y | y | identifier, 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+encounter | Provenance:target | $lastn | |
Specimen | Supported Profiles JP_Specimen_Common | y | y | y | y | y | y | y | y | y | identifier | Provenance:target | ||
Media | Supported Profiles JP Core media Endoscopy Profile | y | y | y | y | y | y | y | y | y | identifier, patient, modality, created, patient+modality, patient+created, patient+modality+created | Provenance:target | ||
ImagingStudy | Supported Profiles JP Core ImagingStudy Radiology Profile JP Core ImagingStudy Endoscopy Profile | y | y | y | y | y | y | y | y | y | identifier, status, patient, encounter, modality, bodysite, started, patient+modality, patient+bodysite, patient+started, patient+started+modality, patient+started+modality+bodysite | Provenance:target | ||
DiagnosticReport | Supported 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 | y | y | y | y | y | y | y | y | y | identifier, category, code, date, issued, patient, performer, status, based-on, conclusion, encounter, media, result, results-interpreter, specimen, patient+category, patient+category+based-on, patient+category+date | 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, patient+date, patient+clinical-status, patient+verification-status, patient+type, patient+category, patient+criticality | 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, patient+onset-date, patient+clinical-status, patient+verification-status, patient+category | Provenance:target | ||
Procedure | Supported Profiles JP Core Procedure Profile | y | y | y | y | y | y | y | y | y | identifier, patient, date, patient+date | Provenance:target | ||
FamilyMemberHistory | Supported Profiles JP Core FamilyMemberHistory Profile | y | y | y | y | y | y | y | y | y | identifier, patient, status, relationship, patient+relationship, patient+status | Provenance:target | ||
ServiceRequest | Supported Profiles JP Core ServiceRequest Common Profile | y | y | y | y | y | y | y | y | y | identifier, intent, subject, status, performer, occurrence, patient, requester, authored, based-on, body-site, category, code, encounter, instantiates-canonical, instantiates-uri, performer-type, priority, replaces, requisition, specimen | Provenance:target |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | name | string | |
MAY | family | string | |
MAY | given | string | |
MAY | birthdate | date | |
MAY | gender | token | |
MAY | phone | token | |
MAY | address-postalcode | string |
Conformance | Parameters | Types |
---|---|---|
SHOULD | birthdate+name | date +string |
SHOULD | birthdate+gender | date +token |
SHOULD | birthdate+name+gender | date +string +token |
SHOULD | name+phone | string +token |
SHOULD | name+address-postalcode | string +string |
MAY | family+given+birthdate+gender+phone+address-postalcode | string +string +date +token +token +string |
Conformance | Operation | Documentation |
---|---|---|
MAY | $everything | この操作が呼び出された場合、すべての患者の、あるいは指定された特定の[id]をもつPatientに関連した全てのリソースを返す。 |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | beneficiary | reference | |
SHOULD | class-type | token | |
SHOULD | class-value | string | |
SHOULD | dependent | string | |
SHOULD | identifier | token | |
SHOULD | patient | reference | |
SHOULD | payor | reference | |
SHOULD | policy-holder | reference | |
SHOULD | status | token | |
SHOULD | subscriber | reference | |
SHOULD | type | token |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Operation | Documentation |
---|---|---|
MAY | $everything | この操作は、この操作が呼び出された特定のEncounterリソースに関連する全ての情報を返す。 |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHALL | name | string | |
SHOULD | address | string | |
SHOULD | address-city | string | |
SHOULD | address-state | string | |
SHOULD | address-postalcode | string |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | name | string | |
SHOULD | address | string |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHALL | name | string |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | specialty | token | |
SHOULD | practitioner | reference |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | authoredon | date | |
MAY | date | date | |
MAY | category | token | |
MAY | code | token | |
MAY | requester | reference | |
MAY | jp-medication-start | date |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+date | reference +date |
SHOULD | patient+authoredon | reference +date |
SHOULD | patient+jp-medication-start | reference +date |
MAY | date+authoredon+category+code+requester | date +date +token +token +reference |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | whenhandedover | date | |
MAY | whenprepared | date | |
MAY | code | token | |
MAY | performer | reference | |
MAY | context | reference |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+whenhandedover | reference +date |
MAY | whenhandedover+whenprepared+context+code+performer | date +date +reference +token +reference |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | effective-time | date | |
MAY | code | token | |
MAY | performer | reference | |
MAY | request | reference |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+effective-time | reference +date |
MAY | effective-time+code+performer+request | date +token +reference +reference |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | date | date | |
MAY | lot-number | string |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+date | reference +date |
MAY | date+lot-number | date +string |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.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
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
MAY | patient | reference | |
MAY | category | token | |
MAY | code | token | |
MAY | date | date | |
MAY | encounter | reference | |
MAY | value-quantity | quantity | |
MAY | value-concept | token | |
MAY | value-string | string | |
MAY | based-on | reference | |
MAY | code-value-concept | composite |
Conformance | Parameters | Types |
---|---|---|
SHOULD | patient+code+date | reference +token +date |
SHOULD | patient+code+date+based-on | reference +token +date +reference |
SHOULD | patient+code+date+value-quantity+based-on | reference +token +date +quantity +reference |
SHOULD | patient+code+date+value-concept+based-on | reference +token +date +token +reference |
SHOULD | patient+code+date+value-string+based-on | reference +token +date +string +reference |
SHOULD | code+value-quantity+patient | token +quantity +reference |
SHOULD | code+value-concept+patient | token +token +reference |
SHOULD | code+value-string+patient | token +string +reference |
SHOULD | patient+category+code | reference +token +token |
SHOULD | patient+category+code+date | reference +token +token +date |
SHOULD | patient+code-value-concept | reference +composite |
SHOULD | patient+code-value-concept+date | reference +composite +date |
SHOULD | code-value-concept+date | composite +date |
MAY | patient+category+code+value-quantity | reference +token +token +quantity |
MAY | patient+category+code+value-quantity+date | reference +token +token +quantity +date |
MAY | patient+category+code+value-quantity+encounter | reference +token +token +quantity +reference |
Conformance | Operation | Documentation |
---|---|---|
MAY | $lastn | オペレーションはある条件に基づく最新、または最新からn件の検査結果/測定結果等を取得するという一般的なニーズを満たすためのオペレーションである。 |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | category | token | |
SHOULD | code | token | |
SHOULD | date | date | |
SHOULD | issued | date | |
SHOULD | patient | reference | |
SHOULD | performer | reference | |
SHOULD | status | token | |
MAY | based-on | reference | |
MAY | conclusion | token | |
MAY | encounter | reference | |
MAY | media | reference | |
MAY | result | reference | |
MAY | results-interpreter | reference | |
MAY | specimen | reference |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | clinical-status | token | |
MAY | date | date | |
MAY | category | token | |
MAY | verification-status | token | |
MAY | criticality | token | |
MAY | type | token |
Conformance | Parameters | Types |
---|---|---|
MAY | patient+date | reference +date |
MAY | patient+clinical-status | reference +token |
MAY | patient+verification-status | reference +token |
MAY | patient+type | reference +token |
MAY | patient+category | reference +token |
MAY | patient+criticality | reference +token |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | clinical-status | token | |
MAY | onset-date | date | |
MAY | category | token | |
MAY | verification-status | token |
Conformance | Parameters | Types |
---|---|---|
MAY | patient+onset-date | reference +date |
MAY | patient+clinical-status | reference +token |
MAY | patient+verification-status | reference +token |
MAY | patient+category | reference +token |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | date | date |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHOULD | patient | reference | |
MAY | status | token | |
MAY | relationship | token |
Conformance | Parameters | Types |
---|---|---|
MAY | patient+relationship | reference +token |
MAY | patient+status | reference +token |
resolves
create
, search-type
, read
, vread
, update
, patch
, delete
, history-instance
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHALL | intent | token | |
SHALL | subject | reference | |
SHALL | status | token | |
SHOULD | performer | reference | |
SHOULD | occurrence | date | |
SHOULD | patient | reference | |
SHOULD | requester | reference | |
MAY | authored | date | |
MAY | based-on | reference | |
MAY | body-site | token | |
MAY | category | token | |
MAY | code | token | |
MAY | encounter | reference | |
MAY | instantiates-canonical | reference | |
MAY | instantiates-uri | uri | |
MAY | performer-type | token | |
MAY | priority | token | |
MAY | replaces | reference | |
MAY | requisition | token | |
MAY | specimen | reference |