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

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 Procedure Profile

Official URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-procedure Version: 1.0.2
Active as of 2023-12-04 Computable Name: KRCore_Procedure

KR Core의 수술 및 처치 정보에 적용되는 Procedure 구조.

Usage:

Formal Views of Profile Content

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

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureKR Core Procedure Profile
... status S1..1code수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Example Value (Preferred): completed
... code S1..1CodeableConcept수술명 및 처치명
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:EDI S0..*Coding건강보험심사평가원 건강보험요양급여비용 코드 정보
Binding: KR Core EDI Procedure Codes (required)
...... system S1..1uri건강보험심사평가원 건강보험요양급여비용 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-procedure
...... code S1..1code건강보험심사평가원 건강보험요양급여비용 코드
... subject 1..1Reference(KR Core Patient Profile)수술 및 처치 대상
.... performedDateTimedateTime S
.... performedPeriodPeriod
.... performedStringstring
.... performedAgeAge
.... performedRangeRange

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.code.coding:EDIrequiredKR_Core_EDI_Procedure_Codes (a valid code from HIRA EDI Procedure)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureKR Core Procedure Profile
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1code수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Example Value (Preferred): completed
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding건강보험심사평가원 건강보험요양급여비용 코드 정보
Binding: KR Core EDI Procedure Codes (required)
...... system SΣ1..1uri건강보험심사평가원 건강보험요양급여비용 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-procedure
...... code SΣ1..1code건강보험심사평가원 건강보험요양급여비용 코드
... subject Σ1..1Reference(KR Core Patient Profile)수술 및 처치 대상
... performed[x] SΣ1..1수술 및 처치일자
.... performedDateTimedateTime

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.statusrequiredEventStatus
Procedure.codeexampleProcedureCodes(SNOMEDCT)
Procedure.code.coding:EDIrequiredKR_Core_EDI_Procedure_Codes (a valid code from HIRA EDI Procedure)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureKR Core Procedure Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)A request for this procedure
... partOf Σ0..*Reference(Procedure | Observation | MedicationAdministration)Part of referenced event
... status ?!SΣ1..1code수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Example Value (Preferred): completed
... statusReason Σ0..1CodeableConceptReason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ0..1CodeableConceptClassification of the procedure
Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.

... code SΣ1..1CodeableConcept수술명 및 처치명
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding건강보험심사평가원 건강보험요양급여비용 코드 정보
Binding: KR Core EDI Procedure Codes (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uri건강보험심사평가원 건강보험요양급여비용 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-procedure
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1code건강보험심사평가원 건강보험요양급여비용 코드
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(KR Core Patient Profile)수술 및 처치 대상
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... performed[x] SΣ1..1수술 및 처치일자
.... performedDateTimedateTime S
.... performedPeriodPeriod
.... performedStringstring
.... performedAgeAge
.... performedRangeRange
... recorder Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Who recorded the procedure
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Person who asserts this procedure
... performer Σ0..*BackboneElementThe people who performed the procedure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)The reference to the practitioner
.... onBehalfOf 0..1Reference(Organization)Organization the device or practitioner was acting for
... location Σ0..1Reference(Location)Where the procedure happened
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference Σ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The justification that the procedure was performed
... bodySite Σ0..*CodeableConceptTarget body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... outcome Σ0..1CodeableConceptThe result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.


... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementManipulated, implanted, or removed device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... action 0..1CodeableConceptKind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1Reference(Device)Device that was changed
... usedReference 0..*Reference(Device | Medication | Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codeexampleProcedureCodes(SNOMEDCT)
Procedure.code.coding:EDIrequiredKR_Core_EDI_Procedure_Codes (a valid code from HIRA EDI Procedure)
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodeexampleProcedureReasonCodes
Procedure.bodySiteexampleSNOMEDCTBodyStructures
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
Procedure.usedCodeexampleFHIRDeviceTypes

This structure is derived from Procedure

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 6 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureKR Core Procedure Profile
... status S1..1code수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Example Value (Preferred): completed
... code S1..1CodeableConcept수술명 및 처치명
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:EDI S0..*Coding건강보험심사평가원 건강보험요양급여비용 코드 정보
Binding: KR Core EDI Procedure Codes (required)
...... system S1..1uri건강보험심사평가원 건강보험요양급여비용 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-procedure
...... code S1..1code건강보험심사평가원 건강보험요양급여비용 코드
... subject 1..1Reference(KR Core Patient Profile)수술 및 처치 대상
.... performedDateTimedateTime S
.... performedPeriodPeriod
.... performedStringstring
.... performedAgeAge
.... performedRangeRange

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.code.coding:EDIrequiredKR_Core_EDI_Procedure_Codes (a valid code from HIRA EDI Procedure)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureKR Core Procedure Profile
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1code수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Example Value (Preferred): completed
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding건강보험심사평가원 건강보험요양급여비용 코드 정보
Binding: KR Core EDI Procedure Codes (required)
...... system SΣ1..1uri건강보험심사평가원 건강보험요양급여비용 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-procedure
...... code SΣ1..1code건강보험심사평가원 건강보험요양급여비용 코드
... subject Σ1..1Reference(KR Core Patient Profile)수술 및 처치 대상
... performed[x] SΣ1..1수술 및 처치일자
.... performedDateTimedateTime

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.statusrequiredEventStatus
Procedure.codeexampleProcedureCodes(SNOMEDCT)
Procedure.code.coding:EDIrequiredKR_Core_EDI_Procedure_Codes (a valid code from HIRA EDI Procedure)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureKR Core Procedure Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)A request for this procedure
... partOf Σ0..*Reference(Procedure | Observation | MedicationAdministration)Part of referenced event
... status ?!SΣ1..1code수술 및 처치 상태: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Example Value (Preferred): completed
... statusReason Σ0..1CodeableConceptReason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ0..1CodeableConceptClassification of the procedure
Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.

... code SΣ1..1CodeableConcept수술명 및 처치명
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:EDI SΣ0..*Coding건강보험심사평가원 건강보험요양급여비용 코드 정보
Binding: KR Core EDI Procedure Codes (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uri건강보험심사평가원 건강보험요양급여비용 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/hira-edi-procedure
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1code건강보험심사평가원 건강보험요양급여비용 코드
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(KR Core Patient Profile)수술 및 처치 대상
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... performed[x] SΣ1..1수술 및 처치일자
.... performedDateTimedateTime S
.... performedPeriodPeriod
.... performedStringstring
.... performedAgeAge
.... performedRangeRange
... recorder Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Who recorded the procedure
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Person who asserts this procedure
... performer Σ0..*BackboneElementThe people who performed the procedure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)The reference to the practitioner
.... onBehalfOf 0..1Reference(Organization)Organization the device or practitioner was acting for
... location Σ0..1Reference(Location)Where the procedure happened
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference Σ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The justification that the procedure was performed
... bodySite Σ0..*CodeableConceptTarget body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... outcome Σ0..1CodeableConceptThe result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.


... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementManipulated, implanted, or removed device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... action 0..1CodeableConceptKind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1Reference(Device)Device that was changed
... usedReference 0..*Reference(Device | Medication | Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codeexampleProcedureCodes(SNOMEDCT)
Procedure.code.coding:EDIrequiredKR_Core_EDI_Procedure_Codes (a valid code from HIRA EDI Procedure)
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodeexampleProcedureReasonCodes
Procedure.bodySiteexampleSNOMEDCTBodyStructures
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
Procedure.usedCodeexampleFHIRDeviceTypes

This structure is derived from Procedure

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 6 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

KR CDI 관련항목

KR Core Procedure Profile은 KR CDI의 수술 및 처치 정보 클래스에 대응됨.

KR CDI 수술 및 처치 정보 클래스 항목 KR Core Procedure Profile 관련 항목
수술 및 처치일자 Procedure.performed
수술명 및 처치명 Procedure.code
수술 및 처치 상태 Procedure.status

KR Core Search Parameters (derived)

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

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

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

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