KR Core Implementation Guide
1.0.1 - STU1 Korea, Republic of flag

This page is part of the KR Core (v1.0.1 - STU1) based on FHIR R4. This is an authorized publication. For a full list of available versions, see the Directory of published versions

CapabilityStatement: KR Core Server CapabilityStatement

Official URL: http://www.hl7korea.or.kr/fhir/krcore/CapabilityStatement/krcore-capabilitystatement-server Version: 1.0.1
Active as of 2023-06-30 Computable Name: KRCoreServerCapabilityStatement

KR Core Client가 요청한 쿼리에 대한 응답을 제공할 책임이 있는 KR Core Server의 예상 기능을 설명. KR Core Server에서 지원하는 FHIR Profiles, RESTful Operations, Search Parameters의 전체 목록을 정의함. KR Core Client는 이 목록에서 사용 사례 및 기타 상황별 요구 사항에 따라 필요한 데이터에 접근할 수 있음.

Raw OpenAPI-Swagger Definition file | Download

KRCoreServerCapabilityStatement

KR Core Client가 요청한 쿼리에 대한 응답을 제공할 책임이 있는 KR Core Server의 예상 기능을 설명. KR Core Server에서 지원하는 FHIR Profiles, RESTful Operations, Search Parameters의 전체 목록을 정의함. KR Core Client는 이 목록에서 사용 사례 및 기타 상황별 요구 사항에 따라 필요한 데이터에 접근할 수 있음.

ModeSERVER
Description

KR Core Server는 다음 사항을 반드시(SHALL) 준수:

  1. FHIR specification을 따라 RESTful operation을 구현.

  2. 다음 응답을 반환.

    • (Status 400): invalid parameter (=잘못된 매개변수)

    • (Status 401/4xx): unauthorized request (=승인되지 않은 요청)

    • (Status 403): insufficient scopes (=권한 범위 부족)

    • (Status 404): unknown resource (=알 수 없는 리소스)

  3. 모든 KR Core 상호 작용에 대해 JSON 형식을 지원.

KR Core Server는 다음 사항을 가능한 한(SHOULD) 준수:

  1. 모든 KR Core 상호작용에 대해 XML 형식을 지원.

  2. 각 인스턴스의 FHIR 'meta.profile' 속성의 일부로 지원되는 KR Core Profile을 식별.

Table 1은 KR Core Client에 요구되는 Resources, Profiles, RESTful operatioins 지원 기대치를 보인다.

Table 1은 다음과 같이 해석한다.

  • KR Core Server는 SHALL로 표기된 Resources, Profiles, RESTful operations는 반드시 지원해야 한다.
    • 예를 들면, KR Core Server는 Patient 리소스와 KR Core Patient Profile, 그리고 이에 대한 read operation은 반드시 지원해야 한다.
  • KR Core Server는 SHOULD로 표기된 Resources, Profiles, RESTful operations는 가능한 한 지원해야 한다.
    • 예를 들면, KR Core Server는 Patient 리소스와 KR Core Patient Profile은 반드시 지원해야 하고, 이에 대한 vread operation은 가능한 한 지원해야 한다.
  • KR Core Server는 MAY로 표기된 Resources, Profiles, RESTful operations는 선택적으로 지원할 수 있다.
    • 예를 들면, KR Core Server는 Patient 리소스와 KR Core Patient Profile은 반드시 지원해야 하고, 이에 대한 patch operation은 선택적으로 지원할 수 있다.
  • 그 외 정의되지 않은 Resources, Profiles, RESTful operations을 선택적으로 지원하는 것을 권장한다.

Table 1: KR Core Server의 기능별 지원 기대치

Resource Type Profile Operation
create search
-type
read vread update patch delete history
-instance
history
-type
AllergyIntolerance SHALL KR Core AllergyIntolerance Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Condition SHALL KR Core Condition Profile for Cheife Complaint SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Condition Profile for Encounter Diagnosis SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
DiagnosticReport SHALL KR Core DiagnosticReport Profile for Diagnostic Imaging SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core DiagnosticReport Profile for Function Tests SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core DiagnosticReport Profile for Laboratory Results SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core DiagnosticReport Profile for Pathology Results SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Encounter SHALL KR Core Encounter Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Organization SHALL KR Core Healthcare Organization Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
ImaginStudy SHALL KR Core ImagingStudy Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Immunization SHALL KR Core Immunization Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Medication SHALL KR Core Medication Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
MedicationRequest SHALL KR Core MedicationRequest Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Observation SHALL KR Core Observation Profile for Function Test SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Laboratory Result SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Blood Pressure
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Body Height
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Body Temperature
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Body Weight
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Heart Rate
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Pulse Oximetry
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
KR Core Observation Profile for Vital Signs:
Respiratory Rate
SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Patient SHALL KR Core Patient Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Practitioner SHALL KR Core Practitioner Profile for Medical Doctor SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
PractitionerRole SHALL KR Core PractitionerRole Profile for Medical Doctor SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY
Procedure SHALL KR Core Procedure Profile SHALL MAY SHALL SHALL SHOULD MAY MAY MAY SHOULD MAY