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

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

KR Core의 예방 접종 정보에 적용되는 Immunization 구조.

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... status S1..1code예방 접종 상태: completed | entered-in-error | not-done
Example Value (Preferred): completed
... vaccineCode S1..1CodeableConcept예방접종 식별 코드
.... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:VcntType S1..*Coding예방접종 분류
Binding: KR Core Vaccination Type Codes (required)
...... system S1..1uri예방접종 분류 코드체계
Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
...... code S1..1code예방접종 분류 코드
..... coding:KDCode 0..*Coding식품의약품안전처 의약품표준 코드 정보
Binding: KR Core Korea Drug Codes (required)
...... system 1..1uri식품의약품안전처 의약품표준 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
...... code 1..1code식품의약품안전처 의약품표준 코드
... patient 1..1Reference(KR Core Patient Profile)예방 접종 대상
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... Slices for doseNumber[x] 1..1positiveInt, stringDose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberPositiveInt 0..1positiveInt예방 접종 차수

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.vaccineCode.coding:VcntTyperequiredKR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCoderequiredKR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1code예방 접종 상태: completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Example Value (Preferred): completed
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:VcntType SΣ1..*Coding예방접종 분류
Binding: KR Core Vaccination Type Codes (required)
...... system SΣ1..1uri예방접종 분류 코드체계
Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
...... code SΣ1..1code예방접종 분류 코드
..... coding:KDCode Σ0..*Coding식품의약품안전처 의약품표준 코드 정보
Binding: KR Core Korea Drug Codes (required)
...... system Σ1..1uri식품의약품안전처 의약품표준 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
...... code Σ1..1code식품의약품안전처 의약품표준 코드
... patient Σ1..1Reference(KR Core Patient Profile)예방 접종 대상
... occurrence[x] SΣ1..1dateTime예방 접종 일시
... isSubpotent ?!Σ0..1booleanDose potency
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
..... doseNumber[x]:doseNumberPositiveInt 0..1positiveInt예방 접종 차수

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.statusrequiredImmunizationStatusCodes
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntTyperequiredKR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCoderequiredKR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization 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..*IdentifierBusiness identifier
... status ?!SΣ1..1code예방 접종 상태: completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Example Value (Preferred): completed
... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode SΣ1..1CodeableConcept예방접종 식별 코드
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:VcntType SΣ1..*Coding예방접종 분류
Binding: KR Core Vaccination Type 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/fhir/krcore/CodeSystem/krcore-vcnt-types
...... 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
..... coding:KDCode Σ0..*Coding식품의약품안전처 의약품표준 코드 정보
Binding: KR Core Korea Drug Codes (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uri식품의약품안전처 의약품표준 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ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
... patient Σ1..1Reference(KR Core Patient Profile)예방 접종 대상
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1dateTime예방 접종 일시
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer Σ0..*BackboneElementWho performed event
.... 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..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... 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
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... 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
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... 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
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
..... doseNumber[x]:doseNumberPositiveInt 0..1positiveInt예방 접종 차수
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntTyperequiredKR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCoderequiredKR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

This structure is derived from Immunization

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode.coding is sliced based on the value of value:$this
  • The element Immunization.protocolApplied.doseNumber[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... status S1..1code예방 접종 상태: completed | entered-in-error | not-done
Example Value (Preferred): completed
... vaccineCode S1..1CodeableConcept예방접종 식별 코드
.... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:VcntType S1..*Coding예방접종 분류
Binding: KR Core Vaccination Type Codes (required)
...... system S1..1uri예방접종 분류 코드체계
Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
...... code S1..1code예방접종 분류 코드
..... coding:KDCode 0..*Coding식품의약품안전처 의약품표준 코드 정보
Binding: KR Core Korea Drug Codes (required)
...... system 1..1uri식품의약품안전처 의약품표준 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
...... code 1..1code식품의약품안전처 의약품표준 코드
... patient 1..1Reference(KR Core Patient Profile)예방 접종 대상
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... Slices for doseNumber[x] 1..1positiveInt, stringDose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberPositiveInt 0..1positiveInt예방 접종 차수

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.vaccineCode.coding:VcntTyperequiredKR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCoderequiredKR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1code예방 접종 상태: completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Example Value (Preferred): completed
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:VcntType SΣ1..*Coding예방접종 분류
Binding: KR Core Vaccination Type Codes (required)
...... system SΣ1..1uri예방접종 분류 코드체계
Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
...... code SΣ1..1code예방접종 분류 코드
..... coding:KDCode Σ0..*Coding식품의약품안전처 의약품표준 코드 정보
Binding: KR Core Korea Drug Codes (required)
...... system Σ1..1uri식품의약품안전처 의약품표준 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
...... code Σ1..1code식품의약품안전처 의약품표준 코드
... patient Σ1..1Reference(KR Core Patient Profile)예방 접종 대상
... occurrence[x] SΣ1..1dateTime예방 접종 일시
... isSubpotent ?!Σ0..1booleanDose potency
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
..... doseNumber[x]:doseNumberPositiveInt 0..1positiveInt예방 접종 차수

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.statusrequiredImmunizationStatusCodes
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntTyperequiredKR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCoderequiredKR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization 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..*IdentifierBusiness identifier
... status ?!SΣ1..1code예방 접종 상태: completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Example Value (Preferred): completed
... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode SΣ1..1CodeableConcept예방접종 식별 코드
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:VcntType SΣ1..*Coding예방접종 분류
Binding: KR Core Vaccination Type 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/fhir/krcore/CodeSystem/krcore-vcnt-types
...... 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
..... coding:KDCode Σ0..*Coding식품의약품안전처 의약품표준 코드 정보
Binding: KR Core Korea Drug Codes (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uri식품의약품안전처 의약품표준 코드체계
Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ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
... patient Σ1..1Reference(KR Core Patient Profile)예방 접종 대상
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1dateTime예방 접종 일시
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer Σ0..*BackboneElementWho performed event
.... 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..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... 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
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... 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
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... 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
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
..... doseNumber[x]:doseNumberPositiveInt 0..1positiveInt예방 접종 차수
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntTyperequiredKR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCoderequiredKR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

This structure is derived from Immunization

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode.coding is sliced based on the value of value:$this
  • The element Immunization.protocolApplied.doseNumber[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

KR CDI 관련항목

KR Core Immunization Profile은 KR CDI의 예방접종내역 클래스 중 일부에 대응됨.

KR CDI 예방접종내역 클래스 항목 KR Core Immunization Profile 관련 항목
예방접종명 Immunization.vaccineCode.where($this.coding.system = ‘https://www.kdca.go.kr/CodeSystem/vcnt-types’)
예방접종 약품명 Immunization.vaccineCode.where($this.coding.system = ‘https://biz.kpis.or.kr/CodeSystem/kdcode’)
예방접종 차수 Immunization.protocolApplied.doseNumberPositiveInt
예방접종 일자 Immunization.occurrence
예방접종 상태 Immunization.status

KR Core Search Parameters (defined)

Immunization Resource를 검색하기 위해 Kr Core에서 추가로 정의한 검색 파라미터.

Name Type Description Expression Expectations
dose-number number 예방 접종 차수 Immunization.protocolApplied.doseNumber.ofType(positiveInt) MAY

KR Core Search Parameters (derived)

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

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

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

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