KR Core Implementation Guide
1.0.2 - STU1
KR Core Implementation Guide
1.0.2 - STU1
This page is part of the KR Core (v1.0.2 - STU1) based on FHIR R4. This is an authorized publication. 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-server | Version: 1.0.2 | |||
| 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
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.
serverKR 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 | 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 |
| 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, recorded-date, encounter, onset-date, patient | |||
| DiagnosticReport | Supported profiles: KR Core DiagnosticReport Profile for Diagnostic Imaging KR Core DiagnosticReport Profile for Function Tests KR Core DiagnosticReport Profile for Laboratory Results KR Core DiagnosticReport Profile for Pathology Results | y | y | y | y | y | y | y | y | y | request-date, study, category, code, issued, patient, performer, result, status | |||
| Encounter | Supported profiles: KR Core Encounter Profile | y | y | y | y | y | y | y | y | y | insurance-type, class, date, 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 | dose-number, date, 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, intent, medication, patient, status | |||
| Observation | Supported profiles: KR Core Observation Profile for Function 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 | issued, 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, patient, performer, status, value-concept, value-date, value-quantity, value-string | |||
| Organization | Supported profiles: KR Core Healthcare Organization Profile | y | y | y | y | y | y | y | y | y | telecom, address, identifier, name, 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 for Medical Doctor | y | y | y | y | y | y | y | y | y | code, _id, identifier, name | |||
| PractitionerRole | Supported profiles: KR Core PractitionerRole Profile for Medical Doctor | y | y | y | y | y | y | y | y | y | organization, practitioner, specialty, role | |||
| Procedure | Supported profiles: KR Core Procedure Profile | y | y | y | y | y | y | y | y | y | code, date, patient, status |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 클라이언트는 적어도 |
| SHOULD | code | token | 클라이언트는 적어도 |
| MAY | category | token | 클라이언트는 적어도 |
| MAY | clinical-status | token | 클라이언트는 적어도 |
| MAY | manifestation | token | 클라이언트는 적어도 |
| MAY | onset | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | 클라이언트는 적어도 |
| SHALL | patient | reference | 클라이언트는 적어도 |
| MAY | category | token | 클라이언트는 적어도 |
| MAY | clinical-status | token | 클라이언트는 적어도 |
| MAY | recorded-date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | encounter | reference | 클라이언트는 적어도 |
| MAY | onset-date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-diagnosticreport-diagnostic-imaging
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-diagnosticreport-function-tests
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-diagnosticreport-laboratory-results
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-diagnosticreport-pathology-results
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | 클라이언트는 적어도 |
| SHALL | patient | reference | 클라이언트는 적어도 |
| SHOULD | category | token | 클라이언트는 적어도 |
| SHOULD | result | reference | 클라이언트는 적어도 |
| MAY | request-date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | study | reference | 클라이언트는 적어도 |
| MAY | issued | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | performer | reference | 클라이언트는 적어도 |
| MAY | status | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 클라이언트는 적어도 |
| MAY | insurance-type | token | 클라이언트는 적어도 |
| MAY | class | token | 클라이언트는 적어도 |
| MAY | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | participant | reference | 클라이언트는 적어도 |
| MAY | service-provider | reference | 클라이언트는 적어도 |
| MAY | status | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 클라이언트는 적어도 |
| MAY | modality | token | 클라이언트는 적어도 |
| MAY | series | token | 클라이언트는 적어도 |
| MAY | started | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | status | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 클라이언트는 적어도 |
| SHALL | vaccine-code | token | 클라이언트는 적어도 |
| SHOULD | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | dose-number | number | |
| MAY | status | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | 클라이언트는 적어도 |
| SHOULD | ingredient-code | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 클라이언트는 적어도 |
| SHOULD | intent | token | 클라이언트는 적어도 |
| SHOULD | medication | reference | 클라이언트는 적어도 |
| MAY | authoredon | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | status | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-observation-function-test
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-observation-laboratory-result
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-vitalsigns
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-bloodpressure
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-bodyheight
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-bodytemperature
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-bodyweight
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-heartrate
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-pulseoximetry
http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-respiratoryrate
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | 클라이언트는 적어도 |
| SHALL | code-value-string | composite | |
| SHALL | patient | reference | 클라이언트는 적어도 |
| SHOULD | issued | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| SHOULD | performer | reference | 클라이언트는 적어도 |
| MAY | code | token | 클라이언트는 적어도 |
| MAY | code-value-concept | composite | |
| MAY | code-value-date | composite | |
| MAY | code-value-quantity | composite | |
| MAY | component-code | token | 클라이언트는 적어도 |
| MAY | component-code-value-concept | composite | |
| MAY | component-code-value-quantity | composite | |
| MAY | component-data-absent-reason | token | 클라이언트는 적어도 |
| MAY | component-value-concept | token | 클라이언트는 적어도 |
| MAY | component-value-quantity | quantity | |
| MAY | data-absent-reason | token | 클라이언트는 적어도 |
| MAY | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | status | token | 클라이언트는 적어도 |
| MAY | value-concept | token | 클라이언트는 적어도 |
| MAY | value-date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | value-quantity | quantity | |
| MAY | value-string | string |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | 클라이언트는 적어도 |
| SHOULD | name | string | |
| MAY | telecom | token | 클라이언트는 적어도 |
| MAY | address | string | |
| MAY | type | token |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | identifier | token | 클라이언트는 적어도 |
| SHALL | name | string | |
| SHOULD | birthdate | date | 클라이언트는 반드시(SHALL) day 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) day 수준의 정확도를 가지는 값을 지원해야 한다. |
| SHOULD | gender | token | 클라이언트는 적어도 |
| SHOULD | telecom | token | 클라이언트는 적어도 |
| MAY | address | string |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | 클라이언트는 적어도 |
| SHALL | name | string | |
| SHOULD | _id | token | |
| MAY | code | token | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | practitioner | reference | 클라이언트는 적어도 |
| SHOULD | specialty | token | 클라이언트는 적어도 |
| SHOULD | role | token | 클라이언트는 적어도 |
| MAY | organization | reference | 클라이언트는 적어도 |
resolvessearch-type, read.vread, history-instance.create, update, patch, delete, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 클라이언트는 적어도 |
| SHOULD | code | token | 클라이언트는 적어도 |
| SHOULD | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
| MAY | status | token | 클라이언트는 적어도 |