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

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

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

Usage:

- Examples for this Resource Profile: Immunization/krcore-immunization-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 Immunization

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | KR Core Immunization Profile
status | S | 1..1 | code | 예방 접종 상태: completed | entered-in-error | not-done Example Value (Preferred): completed
vaccineCode | S | 1..1 | CodeableConcept | 예방접종 식별 코드
Slices for coding |  | 1..* | Coding | Code 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..1 | uri | 예방접종 분류 코드체계 Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
code | S | 1..1 | code | 예방접종 분류 코드
coding:KDCode |  | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug Codes (required)
system |  | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
code |  | 1..1 | code | 식품의약품안전처 의약품표준 코드
patient |  | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상
occurrence[x] | S | 1..1 | dateTime | 예방 접종 일시
protocolApplied |  | 0..* | BackboneElement | 예방 접종 프로토콜
Slices for doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | 예방 접종 차수
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Immunization.vaccineCode.coding:VcntType | required | KR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCode | required | KR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | KR Core Immunization Profile
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | 예방 접종 상태: completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Example Value (Preferred): completed
vaccineCode | S Σ | 1..1 | CodeableConcept | 예방접종 식별 코드 Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding | Σ | 1..* | Coding | Code 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..1 | uri | 예방접종 분류 코드체계 Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
code | S Σ | 1..1 | code | 예방접종 분류 코드
coding:KDCode | Σ | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug Codes (required)
system | Σ | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
code | Σ | 1..1 | code | 식품의약품안전처 의약품표준 코드
patient | Σ | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상
occurrence[x] | S Σ | 1..1 | dateTime | 예방 접종 일시
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
protocolApplied |  | 0..* | BackboneElement | 예방 접종 프로토콜
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | 예방 접종 차수
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Immunization.status | required | ImmunizationStatusCodes
Immunization.vaccineCode | example | VaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntType | required | KR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCode | required | KR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | KR Core Immunization 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
status | ?!S Σ | 1..1 | code | 예방 접종 상태: 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..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | S Σ | 1..1 | CodeableConcept | 예방접종 식별 코드 Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
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 | Σ | 1..* | Coding | Code 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..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/fhir/krcore/CodeSystem/krcore-vcnt-types
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | 예방접종 분류 코드
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:KDCode | Σ | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug 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 | Σ | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | 식품의약품안전처 의약품표준 코드
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
patient | Σ | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 | dateTime | 예방 접종 일시
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in
reportOrigin |  | 0..1 | CodeableConcept | Indicates 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..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber |  | 0..1 | string | Vaccine lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity |  | 0..1 | SimpleQuantity | Amount of vaccine administered
performer | Σ | 0..* | BackboneElement | Who performed event
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
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient
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
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
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
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 0..* | 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
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Slices for doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | 예방 접종 차수
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Immunization.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Immunization.status | required | ImmunizationStatusCodes
Immunization.statusReason | example | ImmunizationStatusReasonCodes
Immunization.vaccineCode | example | VaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntType | required | KR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCode | required | KR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)
Immunization.reportOrigin | example | ImmunizationOriginCodes
Immunization.site | example | CodesForImmunizationSiteOfAdministration
Immunization.route | example | ImmunizationRouteCodes
Immunization.performer.function | extensible | ImmunizationFunctionCodes
Immunization.reasonCode | example | ImmunizationReasonCodes
Immunization.subpotentReason | example | ImmunizationSubpotentReason
Immunization.programEligibility | example | ImmunizationProgramEligibility
Immunization.fundingSource | example | ImmunizationFundingSource
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes

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:

- KR Core Patient Profile (http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient)

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | KR Core Immunization Profile
status | S | 1..1 | code | 예방 접종 상태: completed | entered-in-error | not-done Example Value (Preferred): completed
vaccineCode | S | 1..1 | CodeableConcept | 예방접종 식별 코드
Slices for coding |  | 1..* | Coding | Code 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..1 | uri | 예방접종 분류 코드체계 Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
code | S | 1..1 | code | 예방접종 분류 코드
coding:KDCode |  | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug Codes (required)
system |  | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
code |  | 1..1 | code | 식품의약품안전처 의약품표준 코드
patient |  | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상
occurrence[x] | S | 1..1 | dateTime | 예방 접종 일시
protocolApplied |  | 0..* | BackboneElement | 예방 접종 프로토콜
Slices for doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | 예방 접종 차수
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Immunization.vaccineCode.coding:VcntType | required | KR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCode | required | KR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | KR Core Immunization Profile
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | 예방 접종 상태: completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Example Value (Preferred): completed
vaccineCode | S Σ | 1..1 | CodeableConcept | 예방접종 식별 코드 Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding | Σ | 1..* | Coding | Code 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..1 | uri | 예방접종 분류 코드체계 Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types
code | S Σ | 1..1 | code | 예방접종 분류 코드
coding:KDCode | Σ | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug Codes (required)
system | Σ | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
code | Σ | 1..1 | code | 식품의약품안전처 의약품표준 코드
patient | Σ | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상
occurrence[x] | S Σ | 1..1 | dateTime | 예방 접종 일시
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
protocolApplied |  | 0..* | BackboneElement | 예방 접종 프로토콜
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | 예방 접종 차수
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Immunization.status | required | ImmunizationStatusCodes
Immunization.vaccineCode | example | VaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntType | required | KR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCode | required | KR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | KR Core Immunization 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
status | ?!S Σ | 1..1 | code | 예방 접종 상태: 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..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | S Σ | 1..1 | CodeableConcept | 예방접종 식별 코드 Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
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 | Σ | 1..* | Coding | Code 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..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/fhir/krcore/CodeSystem/krcore-vcnt-types
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | 예방접종 분류 코드
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:KDCode | Σ | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug 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 | Σ | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | 식품의약품안전처 의약품표준 코드
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
patient | Σ | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 | dateTime | 예방 접종 일시
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in
reportOrigin |  | 0..1 | CodeableConcept | Indicates 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..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber |  | 0..1 | string | Vaccine lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity |  | 0..1 | SimpleQuantity | Amount of vaccine administered
performer | Σ | 0..* | BackboneElement | Who performed event
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
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient
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
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
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
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 0..* | 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
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Slices for doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | 예방 접종 차수
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Immunization.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Immunization.status | required | ImmunizationStatusCodes
Immunization.statusReason | example | ImmunizationStatusReasonCodes
Immunization.vaccineCode | example | VaccineAdministeredValueSet
Immunization.vaccineCode.coding:VcntType | required | KR_Core_Vaccination_Type_Codes (a valid code from KR Core Vaccination Types)
Immunization.vaccineCode.coding:KDCode | required | KR_Core_Korea_Drug_Codes (a valid code from KPIS Korea Drug Code)
Immunization.reportOrigin | example | ImmunizationOriginCodes
Immunization.site | example | CodesForImmunizationSiteOfAdministration
Immunization.route | example | ImmunizationRouteCodes
Immunization.performer.function | extensible | ImmunizationFunctionCodes
Immunization.reasonCode | example | ImmunizationReasonCodes
Immunization.subpotentReason | example | ImmunizationSubpotentReason
Immunization.programEligibility | example | ImmunizationProgramEligibility
Immunization.fundingSource | example | ImmunizationFundingSource
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes

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:

- KR Core Patient Profile (http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient)

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 목록은 아래 요소에 대한 구현 기대치를 정의함:

- multipleAnd
- multipleOr
- comparator
- modifier
- chain

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