KR Core Implementation Guide
2.0.0-preview - STU2
KR Core Implementation Guide - Local Development build (v2.0.0-preview) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://www.hl7korea.or.kr/fhir/krcore/CapabilityStatement/krcore-capabilitystatement-server | Version: 2.0.0-preview | |||
Standards status: Trial-use | Computable Name: KRCoreServerCapabilityStatement |
이 CapabilityStatement는 보건의료데이터 생성(create), 수정(update), 읽기(read), 검색(search) 요청에 응답하는 역할을 담당하는 KR Core Server에 대한 기본 규칙을 설명한다. KR Core Server가 지원해야 하는 하는 KR Core Profile, RESTful API, 검색 인자(Search Parameter)의 전체 목록은 이 CapabilityStatement에 정의되어 있다.
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml
, SHALL support application/fhir+json
application/fhir+json
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 http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-capabilitystatement-server
server
KR Core Server는 다음 사항을 반드시(SHALL) 준수:
FHIR specification을 따라 RESTful operation을 구현.
다음 응답을 반환.
(Status 400): invalid parameter (=잘못된 매개변수)
(Status 401/4xx): unauthorized request (=승인되지 않은 요청)
(Status 403): insufficient scopes (=권한 범위 부족)
(Status 404): unknown resource (=알 수 없는 리소스)
모든 KR Core 상호 작용에 대해 JSON 형식을 지원.
KR Core Server는 다음 사항을 가능한 한(SHOULD) 준수:
모든 KR Core 상호작용에 대해 XML 형식을 지원.
각 인스턴스의 FHIR 'meta.profile' 속성의 일부로 지원되는 KR Core Profile을 식별.
- KR Core Server는 승인되지 않은 요청에 대해 다음 중 하나를 반환하여 거부할 것을 반드시(SHALL) 준수: 'HTTP 401' "Unauthorized", 'HTTP 403' "Forbidden", 'HTTP 404' "Not Found"
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 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AllergyIntolerance | Supported Profiles KR Core AllergyIntolerance Profile | y | y | y | y | y | y | y | y | y | category, clinical-status, code, manifestation, onset, patient | |||
Condition | Supported Profiles KR Core Condition Profile for Chief Complaint KR Core Condition Profile for Encounter Diagnosis | y | y | y | y | y | y | y | y | y | category, clinical-status, code, encounter, onset-date, patient, recorded-date | |||
DiagnosticReport | Supported Profiles KR Core DiagnosticReport Profile for Diagnostic Imaging KR Core DiagnosticReport Profile for Functional Tests KR Core DiagnosticReport Profile for Laboratory Results KR Core DiagnosticReport Profile for Pathology Results | y | y | y | y | y | y | y | y | y | category, code, issued, patient, performer, request-date, result, specimen, status, study | |||
Encounter | Supported Profiles KR Core Encounter Profile | y | y | y | y | y | y | y | y | y | class, date, insurance-type, participant, patient, service-provider, status | |||
ImagingStudy | Supported Profiles KR Core ImagingStudy Profile | y | y | y | y | y | y | y | y | y | modality, patient, series, started, status | |||
Immunization | Supported Profiles KR Core Immunization Profile | y | y | y | y | y | y | y | y | y | date, dose-number, patient, status, vaccine-code | |||
Medication | Supported Profiles KR Core Medication Profile | y | y | y | y | y | y | y | y | y | code, ingredient-code | |||
MedicationRequest | Supported Profiles KR Core MedicationRequest Profile | y | y | y | y | y | y | y | y | y | authoredon, code, ingredient-code, intent, medication, patient, status | |||
Observation | Supported Profiles KR Core Observation Profile for Functional Test KR Core Observation Profile for Laboratory Result 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 | y | y | y | y | y | y | y | y | y | category, code, code-value-concept, code-value-date, code-value-quantity, code-value-string, component-code, component-code-value-concept, component-code-value-quantity, component-data-absent-reason, component-value-concept, component-value-quantity, data-absent-reason, date, issued, patient, performer, specimen, status, value-concept, value-date, value-quantity, value-string | |||
Organization | Supported Profiles KR Core Organization Profile KR Core Healthcare Organization Profile | y | y | y | y | y | y | y | y | y | address, identifier, name, telecom, type | |||
Patient | Supported Profiles KR Core Patient Profile | y | y | y | y | y | y | y | y | y | _id, address, birthdate, gender, identifier, name, telecom | |||
Practitioner | Supported Profiles KR Core Practitioner Profile KR Core Practitioner Profile for Medical Doctor | y | y | y | y | y | y | y | y | y | _id, code, identifier, name | |||
PractitionerRole | Supported Profiles KR Core PractitionerRole Profile KR Core PractitionerRole Profile for Medical Doctor | y | y | y | y | y | y | y | y | y | organization, practitioner, role, specialty | |||
Procedure | Supported Profiles KR Core Procedure Profile | y | y | y | y | y | y | y | y | y | category, code, date, patient, status | |||
Specimen | Supported Profiles KR Core Specimen Profile | y | y | y | y | y | y | y | y | y | bodysite, identifier, patient, type |
resolves
search-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 수준의 정확도를 가지는 값을 지원해야 한다. |
resolves
search-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 수준의 정확도를 가지는 값을 지원해야 한다. |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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 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) 한글 문자열 검색을 지원해야 한다. |
resolves
search-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는 적어도 |
resolves
search-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) 한글 문자열 검색을 지원해야 한다. |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |
resolves
search-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는 적어도 |