KR Core Implementation Guide
2.0.0 - STU 2 Korea, Republic of

KR Core Implementation Guide, published by HL7 Korea. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7korea/krcore/ and changes regularly. 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: 2.0.0
Standards status: Trial-use Computable Name: KRCore_Medication

KR Core Medication Profile은 KR Core Server와 KR Core Client가 진료정보를 교류할 때 약품 자체의 정보를 표현하는 데 사용되며, 이 경우 가능한 한(SHOULD) 본 Profile을 준수해야 한다. 약품 정보를 표현할 때 본 Profile을 적용하지 않을 수 있는 경우는 특수한 상황에 한정된다. 이 경우 반드시 해당 진료정보교류 도메인 내에서 사전 합의가 이루어져야 한다.

KR CDI V2 약물 정보 클래스에서 정의한 약품 정보 관련 항목들과 주요 추가 정보를 구조화하기 위해 정의한 Profile.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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: KR Core EDI Medication Codes (extensible)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... 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 The actual ingredient or content
Binding: ATC Codes (preferred)
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
....... code SΣ 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.code Base extensible KR Core EDI Medication Codes 📦1.0.2 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.ingredient.​item[x]:itemCodeableConcept Base preferred ATC Codes 📦1.0.2 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication KR Core Medication Profile
... code S 1..1 CodeableConcept 약품 코드
Binding: KR Core EDI Medication Codes (extensible)
.... coding
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... 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 The actual ingredient or content
Binding: ATC Codes (preferred)
...... coding
....... system S 1..1 uri Identity of the terminology system
....... code S 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.code Base extensible KR Core EDI Medication Codes 📦1.0.2 This IG
Medication.ingredient.​item[x]:itemCodeableConcept Base preferred ATC Codes 📦1.0.2 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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: KR Core EDI Medication Codes (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..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
... 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 The actual ingredient or content
Binding: ATC Codes (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... 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 Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.code Base extensible KR Core EDI Medication Codes 📦1.0.2 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.ingredient.​item[x]:itemCodeableConcept Base preferred ATC Codes 📦1.0.2 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Medication

Summary

Mandatory: 2 elements(5 nested mandatory elements)
Must-Support: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.ingredient.item[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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: KR Core EDI Medication Codes (extensible)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... 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 The actual ingredient or content
Binding: ATC Codes (preferred)
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
....... code SΣ 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.code Base extensible KR Core EDI Medication Codes 📦1.0.2 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.ingredient.​item[x]:itemCodeableConcept Base preferred ATC Codes 📦1.0.2 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication KR Core Medication Profile
... code S 1..1 CodeableConcept 약품 코드
Binding: KR Core EDI Medication Codes (extensible)
.... coding
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... 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 The actual ingredient or content
Binding: ATC Codes (preferred)
...... coding
....... system S 1..1 uri Identity of the terminology system
....... code S 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.code Base extensible KR Core EDI Medication Codes 📦1.0.2 This IG
Medication.ingredient.​item[x]:itemCodeableConcept Base preferred ATC Codes 📦1.0.2 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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: KR Core EDI Medication Codes (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... 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 Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..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
... 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 The actual ingredient or content
Binding: ATC Codes (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... 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 Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.code Base extensible KR Core EDI Medication Codes 📦1.0.2 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.ingredient.​item[x]:itemCodeableConcept Base preferred ATC Codes 📦1.0.2 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Medication

Summary

Mandatory: 2 elements(5 nested mandatory elements)
Must-Support: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.ingredient.item[x]

 

Other representations of profile: CSV, Excel, Schematron