KR Core Implementation Guide
1.0.2 - STU1

KR Core Implementation Guide - Local Development build (v1.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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.2
Active as of 2024-09-12 | Computable Name: KRCore_Medication

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

Usage:

- Refer to this Resource Profile: KR Core MedicationRequest Profile
- Examples for this Resource Profile: Medication/krcore-medication-example-01

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Medication

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | KR Core Medication Profile
code | S | 1..1 | CodeableConcept | 약품 코드
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:EDI | S | 0..* | Coding | 약품제품명 정보 Binding: KR Core EDI Medication Codes (required)
system | S | 1..1 | uri | 건강보험심사평가원 의약품 보험 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
code | S | 1..1 | code | 건강보험심사평가원 의약품 보험 코드
display | S | 1..1 | string | 약품제품명
ingredient | S | 1..* | BackboneElement | 약품성분 정보
Slices for item[x] |  | 1..1 | CodeableConcept, Reference(Substance | Medication) | The actual ingredient or content Slice: Unordered, Open by type:$this
item[x]:itemCodeableConcept | S | 0..1 | CodeableConcept | 약품성분명
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ATC | S | 0..* | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required)
system | S | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc
code | S | 1..1 | code | WHO ATC 코드
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Medication.code.coding:EDI | required | KR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATC | required | KR_Core_ATC_Codes

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | KR Core Medication Profile
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
code | S Σ | 1..1 | CodeableConcept | 약품 코드 Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:EDI | S Σ | 0..* | Coding | 약품제품명 정보 Binding: KR Core EDI Medication Codes (required)
system | S Σ | 1..1 | uri | 건강보험심사평가원 의약품 보험 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
code | S Σ | 1..1 | code | 건강보험심사평가원 의약품 보험 코드
display | S Σ | 1..1 | string | 약품제품명
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
ingredient | S | 1..* | BackboneElement | 약품성분 정보
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for item[x] |  | 1..1 |  | The actual ingredient or content Slice: Unordered, Open by type:$this
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Substance | Medication) |
item[x]:itemCodeableConcept | S | 0..1 | CodeableConcept | 약품성분명
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ATC | S Σ | 0..* | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required)
system | S Σ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc
code | S Σ | 1..1 | code | WHO ATC 코드
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Medication.code | example | SNOMEDCTMedicationCodes
Medication.code.coding:EDI | required | KR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.status | required | Medication Status Codes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATC | required | KR_Core_ATC_Codes

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | KR Core Medication Profile
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business identifier for this medication
code | S Σ | 1..1 | CodeableConcept | 약품 코드 Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:EDI | S Σ | 0..* | Coding | 약품제품명 정보 Binding: KR Core EDI Medication Codes (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | 건강보험심사평가원 의약품 보험 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | 건강보험심사평가원 의약품 보험 코드
display | S Σ | 1..1 | string | 약품제품명
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item
form |  | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
amount | Σ | 0..1 | Ratio | Amount of drug in package
ingredient | S | 1..* | BackboneElement | 약품성분 정보
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for item[x] |  | 1..1 |  | The actual ingredient or content Slice: Unordered, Open by type:$this
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Substance | Medication) |
item[x]:itemCodeableConcept | S | 0..1 | CodeableConcept | 약품성분명
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ATC | S Σ | 0..* | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | WHO ATC 코드
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
isActive |  | 0..1 | boolean | Active ingredient indicator
strength |  | 0..1 | Ratio | Quantity of ingredient present
batch |  | 0..1 | BackboneElement | Details about packaged medications
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
lotNumber |  | 0..1 | string | Identifier assigned to batch
expirationDate |  | 0..1 | dateTime | When batch will expire
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Medication.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Medication.code | example | SNOMEDCTMedicationCodes
Medication.code.coding:EDI | required | KR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.status | required | Medication Status Codes
Medication.form | example | SNOMEDCTFormCodes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATC | required | KR_Core_ATC_Codes

This structure is derived from Medication

Summary

Mandatory: 2 elements (5 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 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.item[x] is sliced based on the value of type:$this
- The element Medication.ingredient.item[x].coding is sliced based on the value of value:$this

Differential View

This structure is derived from Medication

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | KR Core Medication Profile
code | S | 1..1 | CodeableConcept | 약품 코드
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:EDI | S | 0..* | Coding | 약품제품명 정보 Binding: KR Core EDI Medication Codes (required)
system | S | 1..1 | uri | 건강보험심사평가원 의약품 보험 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
code | S | 1..1 | code | 건강보험심사평가원 의약품 보험 코드
display | S | 1..1 | string | 약품제품명
ingredient | S | 1..* | BackboneElement | 약품성분 정보
Slices for item[x] |  | 1..1 | CodeableConcept, Reference(Substance | Medication) | The actual ingredient or content Slice: Unordered, Open by type:$this
item[x]:itemCodeableConcept | S | 0..1 | CodeableConcept | 약품성분명
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ATC | S | 0..* | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required)
system | S | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc
code | S | 1..1 | code | WHO ATC 코드
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Medication.code.coding:EDI | required | KR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATC | required | KR_Core_ATC_Codes

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | KR Core Medication Profile
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
code | S Σ | 1..1 | CodeableConcept | 약품 코드 Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:EDI | S Σ | 0..* | Coding | 약품제품명 정보 Binding: KR Core EDI Medication Codes (required)
system | S Σ | 1..1 | uri | 건강보험심사평가원 의약품 보험 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
code | S Σ | 1..1 | code | 건강보험심사평가원 의약품 보험 코드
display | S Σ | 1..1 | string | 약품제품명
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
ingredient | S | 1..* | BackboneElement | 약품성분 정보
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for item[x] |  | 1..1 |  | The actual ingredient or content Slice: Unordered, Open by type:$this
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Substance | Medication) |
item[x]:itemCodeableConcept | S | 0..1 | CodeableConcept | 약품성분명
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ATC | S Σ | 0..* | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required)
system | S Σ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc
code | S Σ | 1..1 | code | WHO ATC 코드
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Medication.code | example | SNOMEDCTMedicationCodes
Medication.code.coding:EDI | required | KR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.status | required | Medication Status Codes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATC | required | KR_Core_ATC_Codes

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | KR Core Medication Profile
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business identifier for this medication
code | S Σ | 1..1 | CodeableConcept | 약품 코드 Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:EDI | S Σ | 0..* | Coding | 약품제품명 정보 Binding: KR Core EDI Medication Codes (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | 건강보험심사평가원 의약품 보험 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-medication
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | 건강보험심사평가원 의약품 보험 코드
display | S Σ | 1..1 | string | 약품제품명
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item
form |  | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
amount | Σ | 0..1 | Ratio | Amount of drug in package
ingredient | S | 1..* | BackboneElement | 약품성분 정보
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for item[x] |  | 1..1 |  | The actual ingredient or content Slice: Unordered, Open by type:$this
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Substance | Medication) |
item[x]:itemCodeableConcept | S | 0..1 | CodeableConcept | 약품성분명
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ATC | S Σ | 0..* | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | WHO ATC 코드
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
isActive |  | 0..1 | boolean | Active ingredient indicator
strength |  | 0..1 | Ratio | Quantity of ingredient present
batch |  | 0..1 | BackboneElement | Details about packaged medications
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
lotNumber |  | 0..1 | string | Identifier assigned to batch
expirationDate |  | 0..1 | dateTime | When batch will expire
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Medication.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Medication.code | example | SNOMEDCTMedicationCodes
Medication.code.coding:EDI | required | KR_Core_EDI_Medication_Codes (a valid code from HIRA EDI Medication)
Medication.status | required | Medication Status Codes
Medication.form | example | SNOMEDCTFormCodes
Medication.ingredient.item[x]:itemCodeableConcept.coding:ATC | required | KR_Core_ATC_Codes

This structure is derived from Medication

Summary

Mandatory: 2 elements (5 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 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.item[x] is sliced based on the value of type:$this
- The element Medication.ingredient.item[x].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 목록은 아래 요소에 대한 구현 기대치를 정의함:

- multipleAnd
- multipleOr
- comparator
- modifier
- chain

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