FHIR Specification Derived
earch Parameter 목록은 클라이언트 또는 서버에 대한 검색 요구 사항 목록이 아님.
CapabilityStatement는 KR Core Server에 대한 검색 기능 기대치를 정의함.
본 문단에서는 CapabilityStatement 내에서 사용되는 Search Parameter들에 대한 정의가 나열되어 있음.
본 섹터에서는 KR Core에서 기존 FHIR 구조에서 Specification 하여 활용하는 SearchParameter들을 나열합니다.
KR Core Search Parameter 목록은 기본 FHIR 사양에서 파생되었으며, 아래의 Search 동작에서의 CapabilityStatement 요소에 대한 구현 기대치를 정의합니다.
목차
* 각 리소스별 항목은 HL7 FHIR R4B 기반의 Implement Guide 를 베이스로 구성하였습니다.
FHIR R4 Implement Guide
* 또한 각 리소스별 항목은 R4B 기반의 KR-CORE Implement Guide 를 준수하여 구성하였습니다.
FHIR R4 기반의 Kr-core
※ This implementation guide (IG) is provided to support the use of FHIR®️©️. This IG is based on the KR Core version 1.0.1 which, in turn, is based on FHIR core Version R4.
AllergyIntolerance
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| category | token | 알레르기 및 불내성 원인구분 | AllergyIntolerance.category | MAY |
| clinical-status | token | 알레르기 및 불내성 상태: active | inactive | resolve | AllergyIntolerance.clinicalStatus | MAY |
| code | token | 원인물질 등 알레르기 및 불내성 반응 코드 | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | SHOULD |
| manifestation | token | 알레르기 및 불내성 증상 | AllergyIntolerance.reaction.manifestation | MAY |
| onset | date | 알레르기 및 불내성 발생일 또는 개별 증상 발생일 | AllergyIntolerance.onset.ofType(dateTime) | AllergyIntolerance.reaction.onset | MAY |
| patient | reference | 알레르기 및 불내성 정보의 대상 환자 | AllergyIntolerance.patient | SHALL |
Condition
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| category | token | 진단 및 주호소 범주 | Condition.category | MAY |
| clinical-status | token | 진단 및 주호소 임상적 상태: active | recurrence | relapse | inactive | remission | resolved | Condition.clinicalStatus | MAY |
| code | token | 진단 및 주호소 상태를 식별하는 코드 | Condition.code | SHALL |
| recorded-date | date | 진단 및 주호소 최초 기록일자 또는 진단일자 | Condition.recordedDate | MAY |
| encounter | reference | 진단 및 주호소 상태가 속한 수진 | Condition.encounter | MAY |
| onset-date | date | 진단 및 주호소 발생일자 | Condition.onset.ofType(dateTime) | Condition.onset.ofType(Period) | MAY |
| patient | reference | 진단 및 주호소 상태의 대상 | Condition.subject.where(resolve() is Patient) | SHALL |
DiagnosticReport
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| category | token | 진단보고서 범주 | DiagnosticReport.category | SHOULD |
| code | token | 진단보고서 항목을 식별하는 코드 | DiagnosticReport.code | SHALL |
| issued | date | 진단 보고 일시 | DiagnosticReport.issued | MAY |
| patient | reference | 진단보고서 대상 환자 | DiagnosticReport.subject.where(resolve() is Patient) | SHALL |
| performer | reference | 진단 책임자 | DiagnosticReport.performer | MAY |
| result | reference | 진단보고를 위한 검사 결과 | DiagnosticReport.result | SHOULD |
| status | token | 진단보고서 상태 | DiagnosticReport.status | MAY |
Encounter
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| class | token | 진료 구분 | Encounter.class | MAY |
| date | date | 내원 기간 내 날짜 | Encounter.period | MAY |
| participant | reference | 내원 참여 의료인 | Encounter.participant.actor | MAY |
| patient | reference | 내원 환자 | Encounter.subject.where(resolve() is Patient) | SHALL |
| service-provider | reference | 내원 기관 | Encounter.serviceProvider | MAY |
| status | token | 내원 상태: planned | arrived | triaged | in-progress | onleave | finished | cancelled + | Encounter.status | MAY |
ImagingStudy
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| modality | token | DICOM 촬영 장비 | ImagingStudy.series.modality | MAY |
| patient | reference | 진단영상 대상 환자 | ImagingStudy.subject.where(resolve() is Patient) | SHALL |
| series | token | DICOM Series UID | ImagingStudy.series.uid | MAY |
| started | date | 진단영상 촬영 시작 날짜 | ImagingStudy.started | MAY |
| status | token | 진단영상 상태 | ImagingStudy.status | MAY |
Immunization
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| date | date | 예방 접종 일시 | Immunization.occurrence | SHOULD |
| patient | reference | 예방 접종 대상 | Immunization.patient | SHALL |
| status | token | 예방 접종 상태 | Immunization.status | MAY |
| vaccine-code | token | 예방접종 식별 코드 | Immunization.vaccineCode | SHALL |
Medication
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| code | token | 약품제품명 | Medication.code | SHALL |
| ingredient-code | token | 약품성분명 | (Medication.ingredient.item as CodeableConcept) | SHOULD |
MedicationRequest
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| authoredon | date | 약물 처방 일시 | MedicationRequest.authoredOn | MAY |
| intent | token | 약물 처방 의도 | MedicationRequest.intent | SHOULD |
| medication | reference | 처방한 약물 | MedicationRequest.medication.reference | SHOULD |
| patient | reference | 약물 처방 대상 | MedicationRequest.subject.where(resolve() is Patient) | SHALL |
| status | token | 약물 처방 진행 상태 | MedicationRequest.status | MAY |
Observation
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| category | token | 관찰 및 측정 범주 | Observation.category | SHOULD |
| code | token | 관찰 및 측정의 유형 | Observation.code | SHALL |
| code-value-concept | composite | 관찰 및 측정의 유형과 CodeableConcept 데이터유형으로 표현된 측정값 쌍 | On Observation: code: code value-concept: value.ofType(CodeableConcept) | MAY |
| code-value-date | composite | 관찰 및 측정의 유형과 date/time 데이터유형으로 표현된 측정값 쌍 | On Observation: code: code value-date: value.ofType(DateTime) | value.ofType(Period) | MAY |
| code-value-quantity | composite | 관찰 및 측정의 유형과 quantity 데이터유형으로 표현된 측정값 쌍 | On Observation: code: code value-quantity: value.ofType(Quantity) | MAY |
| code-value-string | composite | 관찰 및 측정의 유형과 string 데이터유형으로 표현된 측정값 쌍 | On Observation: code: code value-string: value.ofType(string) | MAY |
| component-code | token | 세부 관찰 및 측정의 유형 | Observation.component.code | SHALL |
| component-code-value-concept | composite | 세부 관찰 및 측정의 유형과 CodeableConcept 데이터유형으로 표현된 세부 관찰 및 측정값 쌍 | On Observation.component: componenet-code: code component-value-concept: value.ofType(CodeableConcept) | MAY |
| component-code-value-quantity | composite | 세부 관찰 및 측정의 유형과 Quantity 데이터유형으로 표현된 세부 관찰 및 측정값 쌍 | On Observation.component: componenet-code: code component-value-quantity: value.ofType(Quantity) | MAY |
| component-data-absent-reason | token | 세부 관찰 및 측정 결과(Observation.component.value[x]) 부재 사유 | Observation.component.dataAbsentReason | MAY |
| component-value-concept | token | CodeableConcept 데이터유형으로 표현된 세부 관찰 및 측정값 | Observation.component.value.ofType(CodeableConcept) | MAY |
| component-value-quantity | quantity | Quantity 또는 SampledData 데이터유형으로 표현된 세부 관찰 및 측정값 | Observation.component.value.ofType(Quantity) | Observation.component.value.ofType(SampledData) | MAY |
| data-absent-reason | token | 관찰 및 측정 결과(Observation.value[x]) 부재 사유 | Observation.dataAbsentReason | MAY |
| date | date | 관찰 및 측정 일시 | Observation.effective | MAY |
| patient | reference | 관찰 및 측정 대상 환자 | Observation.subject.where(resolve() is Patient) | SHALL |
| performer | reference | 관찰 및 측정 책임자 | Observation.performer | SHOULD |
| status | token | 관찰 및 측정 진행 상태 | Observation.status | MAY |
| value-concept | token | CodeableConcept 데이터유형으로 표현된 측정값 | Observation.value.ofType(CodeableConcept) | MAY |
| value-date | date | dateTime 또는 Period 데이터유형으로 표현된 측정값 | Observation.value.ofType(dateTime) | Observation.value.ofType(Period) | MAY |
| value-quantity | quantity | Quantity 또는 SampledData 데이터유형으로 표현된 측정값 | Observation.value.ofType(Quantity) | Observation.value.ofType(SampledData) | MAY |
| value-string | string | string 데이터유형 또는 CodeableConcept 데이터유형 내 text로 표현된 측정값 | Observation.value.ofType(string) | Observation.value.ofType(CodeableConcept).text | MAY |
Organization
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| address | string | 한국 도로명 주소를 포함한 기관 주소 검색 | Organization.address | Organization.address.text | Organization.address.extension(‘http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-roadNameAddress’).extension.value | MAY |
| identifier | token | 기관 식별자 | Organization.identifier | SHALL |
| name | string | 기관 명칭 | Organization.name | Organization.alias | SHOULD |
| type | token | 기관 유형 | Organization.type | MAY |
Patient
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| _id | token | 본 리소스 인스턴스의 논리적 ID | Patient.id | SHALL |
| address | string | 한국 도로명 주소를 포함한 환자 주소 검색 | Patient.address | Patient.address.text | Patient.address.extension(‘http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-roadNameAddress’).extension.value | MAY |
| birthdate | date | 환자의 생일 | Patient.birthDate | SHOULD |
| gender | token | 환자의 성별 | Patient.gender | SHOULD |
| identifier | token | 환자의 식별자 | Patient.identifier | SHALL |
| name | string | 환자의 성명을 구성하는 성, 이름 등의 요소 중 일치하는 문자열 | Patient.name | SHALL |
| telecom | token | 환자의 연락처 | Patient.telecom | SHOULD |
Practitioner
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| _id | token | 본 리소스 인스턴스의 논리적 ID | Practitioner.id | SHOULD |
| identifier | token | 의료인 식별자 | Practitioner.identifier | Practitioner.qualification.identifier | SHALL |
| name | string | 의료인의 성명을 구성하는 성, 이름 등의 요소 중 일치하는 문자열 | Practitioner.name | SHALL |
PractitionerRole
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| organization | reference | 의료인 소속 기관 | PractitionerRole.organization | MAY |
| practitioner | reference | 의료인 인적사항 | PractitionerRole.practitioner | SHALL |
| role | token | 의료인 역할 | PractitionerRole.code | SHOULD |
| specialty | token | 의료인 진료과목 코드 | PractitionerRole.specialty | SHOULD |
Procedure
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| code | token | 수술 및 처치 식별 코드 | Procedure.code | SHOULD |
| date | date | 수술 및 처치 수행 일시 | Procedure.performed | SHOULD |
| patient | reference | 수술 및 처치 대상 환자 | Procedure.subject.where(resolve() is Patient) | SHALL |
| status | token | 수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown | Procedure.status | MAY |