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

KR Core Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: KR Core Medication Profile

Official URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-medication Version: 1.0.0
Draft as of 2021-11-13 Computable Name: KRCore_Medication

KR Core의 약품 정보에 적용되는 Medication 구조.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationKR Core Medication Profile
... code S1..1CodeableConcept약품 코드
.... Slices for coding 0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
..... coding:EDI S0..*Coding약품제품명 정보
Binding: KR Core EDI Medication Codes (required)
...... system S1..1uri건강보험심사평가원 의약품 보험 코드체계
고정값: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
...... code S1..1code건강보험심사평가원 의약품 보험 코드
...... display S1..1string약품제품명
... ingredient S1..*BackboneElement약품성분 정보
.... itemCodeableConcept S0..1CodeableConcept약품성분명
..... Slices for coding 0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
...... coding:ATC S0..*CodingWHO ATC 코드 정보
Binding: ATC Codes (required)
....... system S1..1uriWHO ATC 코드체계
고정값: http://www.whocc.no/atc
....... code S1..1codeWHO ATC 코드

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Medication.code.coding:EDIrequiredKR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.ingredient.itemCodeableConcept.coding:ATCrequiredKR_Core_ATC_Codes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationKR Core Medication Profile
... implicitRules ?!Σ0..1uri이 콘텐츠 생성 시 따른 규칙들의 집합
... modifierExtension ?!0..*Extension반드시 지원해야 하는 Extension들
... code SΣ1..1CodeableConcept약품 코드
Binding: SNOMEDCTMedicationCodes (example): 약물의 유형을 정의하는 코드화된 개념.

.... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding약품제품명 정보
Binding: KR Core EDI Medication Codes (required)
...... system SΣ1..1uri건강보험심사평가원 의약품 보험 코드체계
고정값: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
...... code SΣ1..1code건강보험심사평가원 의약품 보험 코드
...... display SΣ1..1string약품제품명
... ingredient S1..*BackboneElement약품성분 정보
.... modifierExtension ?!Σ0..*Extension인식할 수 없는 상황에서도 반드시 지원해야 하는 Extension들
.... Slices for item[x] 1..1실제 성분 또는 내용물
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept S0..1CodeableConcept약품성분명
...... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
....... coding:ATC SΣ0..*CodingWHO ATC 코드 정보
Binding: ATC Codes (required)
........ system SΣ1..1uriWHO ATC 코드체계
고정값: http://www.whocc.no/atc
........ code SΣ1..1codeWHO ATC 코드

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:EDIrequiredKR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.statusrequiredMedication Status Codes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATCrequiredKR_Core_ATC_Codes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationKR Core Medication Profile
... id Σ0..1id본 리소스 인스턴스의 논리적 ID
... meta Σ0..1Meta리소스에 대한 메타데이터
... implicitRules ?!Σ0..1uri이 콘텐츠 생성 시 따른 규칙들의 집합
... text 0..1Narrative사람의 해석을 위한, 리소스의 텍스트 요약
... contained 0..*Resource포함된 리소스
... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
... modifierExtension ?!0..*Extension반드시 지원해야 하는 Extension들
... identifier Σ0..*Identifier비즈니스 식별자 for this medication
... code SΣ1..1CodeableConcept약품 코드
Binding: SNOMEDCTMedicationCodes (example): 약물의 유형을 정의하는 코드화된 개념.

.... id 0..1string요소 간 참조를 위한 고유 ID
.... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
.... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding약품제품명 정보
Binding: KR Core EDI Medication Codes (required)
...... id 0..1string요소 간 참조를 위한 고유 ID
...... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
...... system SΣ1..1uri건강보험심사평가원 의약품 보험 코드체계
고정값: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
...... version Σ0..1string시스템의 버전 - 필요한 경우에 제공
...... code SΣ1..1code건강보험심사평가원 의약품 보험 코드
...... display SΣ1..1string약품제품명
...... userSelected Σ0..1boolean이 coding을 사용자가 직접 선택한 경우
.... text Σ0..1string개념의 일반 텍스트 표현
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): 약물 사용 상태를 정의하는 코드.

... manufacturer Σ0..1Reference(Organization)제조업체
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): 약물의 형태를 정의하는 코드화된 개념.

... amount Σ0..1Ratio패키지에 포함된 약물의 양
... ingredient S1..*BackboneElement약품성분 정보
.... id 0..1string요소 간 참조를 위한 고유 ID
.... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
.... modifierExtension ?!Σ0..*Extension인식할 수 없는 상황에서도 반드시 지원해야 하는 Extension들
.... Slices for item[x] 1..1실제 성분 또는 내용물
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept S0..1CodeableConcept약품성분명
...... id 0..1string요소 간 참조를 위한 고유 ID
...... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
...... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
....... coding:ATC SΣ0..*CodingWHO ATC 코드 정보
Binding: ATC Codes (required)
........ id 0..1string요소 간 참조를 위한 고유 ID
........ extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
........ system SΣ1..1uriWHO ATC 코드체계
고정값: http://www.whocc.no/atc
........ version Σ0..1string시스템의 버전 - 필요한 경우에 제공
........ code SΣ1..1codeWHO ATC 코드
........ display Σ0..1string시스템에서 정의한 표현
........ userSelected Σ0..1boolean이 coding을 사용자가 직접 선택한 경우
...... text Σ0..1string개념의 일반 텍스트 표현
.... isActive 0..1boolean유효 성분 표시
.... strength 0..1Ratio존재하는 성분의 양
... batch 0..1BackboneElement포장된 약물에 대한 세부 정보
.... id 0..1string요소 간 참조를 위한 고유 ID
.... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
.... modifierExtension ?!Σ0..*Extension인식할 수 없는 상황에서도 반드시 지원해야 하는 Extension들
.... lotNumber 0..1string패키지에 할당된 식별자
.... expirationDate 0..1dateTime패키지 유효 기간

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
추가 바인딩 목적
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:EDIrequiredKR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATCrequiredKR_Core_ATC_Codes

This structure is derived from Medication

Summary

Mandatory: 2 elements (5 nested mandatory elements)
Must-Support: 10 elements
고정값: 2 elements

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:$this
  • The element Medication.ingredient.itemCodeableConcept.coding is sliced based on the value of value:$this

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationKR Core Medication Profile
... code S1..1CodeableConcept약품 코드
.... Slices for coding 0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
..... coding:EDI S0..*Coding약품제품명 정보
Binding: KR Core EDI Medication Codes (required)
...... system S1..1uri건강보험심사평가원 의약품 보험 코드체계
고정값: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
...... code S1..1code건강보험심사평가원 의약품 보험 코드
...... display S1..1string약품제품명
... ingredient S1..*BackboneElement약품성분 정보
.... itemCodeableConcept S0..1CodeableConcept약품성분명
..... Slices for coding 0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
...... coding:ATC S0..*CodingWHO ATC 코드 정보
Binding: ATC Codes (required)
....... system S1..1uriWHO ATC 코드체계
고정값: http://www.whocc.no/atc
....... code S1..1codeWHO ATC 코드

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Medication.code.coding:EDIrequiredKR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.ingredient.itemCodeableConcept.coding:ATCrequiredKR_Core_ATC_Codes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationKR Core Medication Profile
... implicitRules ?!Σ0..1uri이 콘텐츠 생성 시 따른 규칙들의 집합
... modifierExtension ?!0..*Extension반드시 지원해야 하는 Extension들
... code SΣ1..1CodeableConcept약품 코드
Binding: SNOMEDCTMedicationCodes (example): 약물의 유형을 정의하는 코드화된 개념.

.... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding약품제품명 정보
Binding: KR Core EDI Medication Codes (required)
...... system SΣ1..1uri건강보험심사평가원 의약품 보험 코드체계
고정값: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
...... code SΣ1..1code건강보험심사평가원 의약품 보험 코드
...... display SΣ1..1string약품제품명
... ingredient S1..*BackboneElement약품성분 정보
.... modifierExtension ?!Σ0..*Extension인식할 수 없는 상황에서도 반드시 지원해야 하는 Extension들
.... Slices for item[x] 1..1실제 성분 또는 내용물
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept S0..1CodeableConcept약품성분명
...... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
....... coding:ATC SΣ0..*CodingWHO ATC 코드 정보
Binding: ATC Codes (required)
........ system SΣ1..1uriWHO ATC 코드체계
고정값: http://www.whocc.no/atc
........ code SΣ1..1codeWHO ATC 코드

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:EDIrequiredKR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.statusrequiredMedication Status Codes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATCrequiredKR_Core_ATC_Codes

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationKR Core Medication Profile
... id Σ0..1id본 리소스 인스턴스의 논리적 ID
... meta Σ0..1Meta리소스에 대한 메타데이터
... implicitRules ?!Σ0..1uri이 콘텐츠 생성 시 따른 규칙들의 집합
... text 0..1Narrative사람의 해석을 위한, 리소스의 텍스트 요약
... contained 0..*Resource포함된 리소스
... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
... modifierExtension ?!0..*Extension반드시 지원해야 하는 Extension들
... identifier Σ0..*Identifier비즈니스 식별자 for this medication
... code SΣ1..1CodeableConcept약품 코드
Binding: SNOMEDCTMedicationCodes (example): 약물의 유형을 정의하는 코드화된 개념.

.... id 0..1string요소 간 참조를 위한 고유 ID
.... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
.... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding약품제품명 정보
Binding: KR Core EDI Medication Codes (required)
...... id 0..1string요소 간 참조를 위한 고유 ID
...... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
...... system SΣ1..1uri건강보험심사평가원 의약품 보험 코드체계
고정값: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
...... version Σ0..1string시스템의 버전 - 필요한 경우에 제공
...... code SΣ1..1code건강보험심사평가원 의약품 보험 코드
...... display SΣ1..1string약품제품명
...... userSelected Σ0..1boolean이 coding을 사용자가 직접 선택한 경우
.... text Σ0..1string개념의 일반 텍스트 표현
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): 약물 사용 상태를 정의하는 코드.

... manufacturer Σ0..1Reference(Organization)제조업체
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): 약물의 형태를 정의하는 코드화된 개념.

... amount Σ0..1Ratio패키지에 포함된 약물의 양
... ingredient S1..*BackboneElement약품성분 정보
.... id 0..1string요소 간 참조를 위한 고유 ID
.... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
.... modifierExtension ?!Σ0..*Extension인식할 수 없는 상황에서도 반드시 지원해야 하는 Extension들
.... Slices for item[x] 1..1실제 성분 또는 내용물
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept S0..1CodeableConcept약품성분명
...... id 0..1string요소 간 참조를 위한 고유 ID
...... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
...... Slices for coding Σ0..*Coding용어 시스템에 의해 정의된 코드
Slice: Unordered, Open by value:$this
....... coding:ATC SΣ0..*CodingWHO ATC 코드 정보
Binding: ATC Codes (required)
........ id 0..1string요소 간 참조를 위한 고유 ID
........ extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
Slice: 순서 없음, url 값에 대해 열려있음
........ system SΣ1..1uriWHO ATC 코드체계
고정값: http://www.whocc.no/atc
........ version Σ0..1string시스템의 버전 - 필요한 경우에 제공
........ code SΣ1..1codeWHO ATC 코드
........ display Σ0..1string시스템에서 정의한 표현
........ userSelected Σ0..1boolean이 coding을 사용자가 직접 선택한 경우
...... text Σ0..1string개념의 일반 텍스트 표현
.... isActive 0..1boolean유효 성분 표시
.... strength 0..1Ratio존재하는 성분의 양
... batch 0..1BackboneElement포장된 약물에 대한 세부 정보
.... id 0..1string요소 간 참조를 위한 고유 ID
.... extension 0..*Extension구현에 의해 정의된 추가 콘텐츠
.... modifierExtension ?!Σ0..*Extension인식할 수 없는 상황에서도 반드시 지원해야 하는 Extension들
.... lotNumber 0..1string패키지에 할당된 식별자
.... expirationDate 0..1dateTime패키지 유효 기간

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
추가 바인딩 목적
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:EDIrequiredKR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATCrequiredKR_Core_ATC_Codes

This structure is derived from Medication

Summary

Mandatory: 2 elements (5 nested mandatory elements)
Must-Support: 10 elements
고정값: 2 elements

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:$this
  • The element Medication.ingredient.itemCodeableConcept.coding is sliced based on the value of value:$this

 

Other representations of profile: CSV, Excel, Schematron

Notes:

KR Core IG를 따르는 Server는 반드시(SHALL) Medication Resource를 지원하고, KR Core Medication Profile을 반드시(SHALL) 지원해야 한다.
KR Core IG를 따르는 Client는 가능한 한(SHOULD) Medication Resource를 지원하고, Medication Resource를 지원하는 경우, KR Core Medication Profile을 반드시(SHALL) 지원해야 한다.

KR CDI 관련항목

KR Core Medication Profile은 KR CDI의 약물 정보 클래스 중 일부에 대응됨.

KR CDI 약물 정보 클래스 항목 KR Core Medication Profile 관련 항목
약품제품명 Medication.code.coding.where(system = ‘https://hira.or.kr/CodeSystem/edi/medication’)
약품성분명 Medication.ingredient
1회량 KR Core MedicationRequest Profile 참고
1회량 단위 KR Core MedicationRequest Profile 참고
복용횟수 KR Core MedicationRequest Profile 참고
용법 KR Core MedicationRequest Profile 참고
처방일수 KR Core MedicationRequest Profile 참고
총량 KR Core MedicationRequest Profile 참고
총량단위 KR Core MedicationRequest Profile 참고
처방상태 KR Core MedicationRequest Profile 참고
처방의도 KR Core MedicationRequest Profile 참고

KR Core Search Parameters (derived)

Medication Resource를 검색하기 위해 기본 FHIR 사양을 기반으로 정의한 검색 파라미터.

Name Type Description Expression Expectations
code token 약품제품명 Medication.code SHALL
ingredient-code token 약품성분명 (Medication.ingredient.item as CodeableConcept) SHOULD

NOTE: 위 Search Parameter 목록은 아래 요소에 대한 구현 기대치를 정의함:

NOTE: 이 외 기본 FHIR 사양에서 정의하고 있는 Search Parameter들은 KR Core IG를 구현한 서버의 선택 사항에 따라 추가로 제공 가능.