KR Core Implementation Guide
3.0.0-ballot - STU 3
This page is part of the KR Core Implementation Guide (v3.0.0-ballot: STU 3 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://www.hl7korea.or.kr/fhir/krcore/CapabilityStatement/krcore-capabilitystatement-client | Version: 3.0.0-ballot | |||
| Standards status: Trial-use | Computable Name: KRCoreClientCapabilityStatement | |||
이 CapabilityStatement는 보건의료데이터 생성(create), 수정(update), 읽기(read), 검색(search) 요청을 시작하는 역할을 담당하는 KR Core Client에 대한 기본 규칙을 설명한다. KR Core Client가 지원해야 하는 KR Core Profile, RESTful API, 검색 인자(Search Parameter)의 전체 목록은 이 CapabilityStatement에 정의되어 있다.
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml, SHALL support application/fhir+jsonapplication/fhir+jsonNote 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 http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-capabilitystatement-client
clientKR Core Client는 다음 사항을 반드시(SHALL) 준수:
KR Core Server CapabilityStatement에 정의된 RESTful Operations, Search Parameters를 활용하여, 하나 이상의 KR Core Profile에 대하여 리소스 등록 및 쿼리 지원.
KR Core IG의 General Requirements 및 Element Support and Responsibilities 준수.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincluderesolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHOULD | code | token | KR Core Client는 적어도 |
| MAY | category | token | KR Core Client는 적어도 |
| MAY | clinical-status | token | KR Core Client는 적어도 |
| MAY | manifestation | token | KR Core Client는 적어도 |
| MAY | onset | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | KR Core Client는 적어도 |
| SHALL | patient | reference | KR Core Client는 적어도 |
| MAY | category | token | KR Core Client는 적어도 |
| MAY | clinical-status | token | KR Core Client는 적어도 |
| MAY | encounter | reference | KR Core Client는 적어도 |
| MAY | onset-date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | recorded-date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | KR Core Client는 적어도 |
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHOULD | category | token | KR Core Client는 적어도 |
| SHOULD | result | reference | KR Core Client는 적어도 |
| MAY | issued | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | performer | reference | KR Core Client는 적어도 |
| MAY | request-date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | specimen | reference | KR Core Client는 적어도 |
| MAY | status | token | KR Core Client는 적어도 |
| MAY | study | reference | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| MAY | class | token | KR Core Client는 적어도 |
| MAY | date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | insurance-type | token | KR Core Client는 적어도 |
| MAY | participant | reference | KR Core Client는 적어도 |
| MAY | service-provider | reference | KR Core Client는 적어도 |
| MAY | status | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| MAY | modality | token | KR Core Client는 적어도 |
| MAY | series | token | KR Core Client는 적어도 |
| MAY | started | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | status | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHALL | vaccine-code | token | KR Core Client는 적어도 |
| SHOULD | date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | dose-number | number | KR Core Client는 반드시(SHALL) 양의 정수값을 제공해야 한다. KR Core Server는 반드시(SHALL) 양의 정수값을 지원해야 하며, 그 외의 값은 반드시(SHALL) 오류로 처리하거나 무시해야 한다. |
| MAY | status | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | KR Core Client는 적어도 |
| SHOULD | ingredient-code | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHOULD | code | token | KR Core Client는 적어도 |
| SHOULD | ingredient-code | token | KR Core Client는 적어도 |
| SHOULD | intent | token | KR Core Client는 적어도 |
| SHOULD | medication | reference | KR Core Client는 적어도 |
| MAY | authoredon | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | status | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.KR Core Observation Profile for Functional Test
KR Core Observation Profile for Laboratory Result
KR Core Observation Profile for Life Sustaining Treatment Preference
KR Core Observation Profile for Social History
KR Core Observation Profile for Social History: Alcohol Use Status
KR Core Observation Profile for Social History: Smoking Status
KR Core Observation Profile for Vital Signs
KR Core Observation Profile for Vital Signs: Blood Pressure
KR Core Observation Profile for Vital Signs: Body Height
KR Core Observation Profile for Vital Signs: Body Temperature
KR Core Observation Profile for Vital Signs: Body Weight
KR Core Observation Profile for Vital Signs: Heart Rate
KR Core Observation Profile for Vital Signs: Pulse Oximetry
KR Core Observation Profile for Vital Signs: Respiratory Rate
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHOULD | category | token | KR Core Client는 적어도 |
| SHOULD | issued | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| SHOULD | performer | reference | KR Core Client는 적어도 |
| MAY | code | token | KR Core Client는 적어도 |
| MAY | code-value-concept | composite | KR Core Client는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 제공할 수 있어야 한다. KR Core Server는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 지원해야 한다. |
| MAY | code-value-date | composite | KR Core Client는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 제공할 수 있어야 한다. KR Core Server는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 지원해야 한다. |
| MAY | code-value-quantity | composite | KR Core Client는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 제공할 수 있어야 한다. KR Core Server는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 지원해야 한다. |
| MAY | code-value-string | composite | KR Core Client는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 제공할 수 있어야 한다. KR Core Server는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 지원해야 한다. |
| MAY | component-code | token | KR Core Client는 적어도 |
| MAY | component-code-value-concept | composite | KR Core Client는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 제공할 수 있어야 한다. KR Core Server는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 지원해야 한다. |
| MAY | component-code-value-quantity | composite | KR Core Client는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 제공할 수 있어야 한다. KR Core Server는 반드시(SHALL) 모든 구성 요소의 검색 값을 동시에 지원해야 한다. |
| MAY | component-data-absent-reason | token | KR Core Client는 적어도 |
| MAY | component-value-concept | token | KR Core Client는 적어도 |
| MAY | component-value-quantity | quantity | KR Core Client는 적어도 반드시(SHALL) |
| MAY | data-absent-reason | token | KR Core Client는 적어도 |
| MAY | date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | specimen | reference | KR Core Client는 적어도 |
| MAY | status | token | KR Core Client는 적어도 |
| MAY | value-concept | token | KR Core Client는 적어도 |
| MAY | value-date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | value-quantity | quantity | KR Core Client는 적어도 반드시(SHALL) |
| MAY | value-string | string | KR Core Client는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. KR Core Server는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.KR Core Organization Profile
KR Core Healthcare Organization Profile
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | KR Core Client는 적어도 |
| SHOULD | name | string | KR Core Client는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. KR Core Server는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. |
| MAY | address | string | KR Core Client는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. KR Core Server는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. |
| MAY | telecom | token | KR Core Client는 적어도 |
| MAY | type | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | KR Core Client는 적어도 |
| SHALL | identifier | token | KR Core Client는 적어도 |
| SHALL | name | string | KR Core Client는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. KR Core Server는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. |
| SHOULD | birthdate | date | KR Core Client는 반드시(SHALL) day 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) day 수준의 정확도를 가지는 값을 지원해야 한다. |
| SHOULD | gender | token | KR Core Client는 적어도 |
| SHOULD | telecom | token | KR Core Client는 적어도 |
| MAY | address | string | KR Core Client는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. KR Core Server는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | KR Core Client는 적어도 |
| SHALL | name | string | KR Core Client는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. KR Core Server는 반드시(SHALL) 한글 문자열 검색을 지원해야 한다. |
| SHOULD | _id | token | KR Core Client는 적어도 |
| MAY | code | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | practitioner | reference | KR Core Client는 적어도 |
| SHOULD | role | token | KR Core Client는 적어도 |
| SHOULD | specialty | token | KR Core Client는 적어도 |
| MAY | organization | reference | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHOULD | code | token | KR Core Client는 적어도 |
| SHOULD | date | date | KR Core Client는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. KR Core Server는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | category | token | KR Core Client는 적어도 |
| MAY | status | token | KR Core Client는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | KR Core Client는 적어도 |
| SHOULD | type | token | KR Core Client는 적어도 |
| MAY | bodysite | token | KR Core Client는 적어도 |
| MAY | identifier | token | KR Core Client는 적어도 |