KR Core Implementation Guide
3.0.0-ballot - STU 3
KR Core Implementation Guide
3.0.0-ballot - STU 3
This page is part of the KR Core Implementation Guide (v3.0.0-ballot: STU 3 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization | Version: 3.0.0-ballot | |||
| Standards status: Trial-use | Computable Name: KRCore_Immunization | |||
KR CDI 예방접종 내역 클래스에서 정의한 항목들과 주요 추가 정보를 구조화하기 위해 정의한 Profile.
KR Core Immunization Profile은 KR Core Server와 KR Core Client가 진료정보를 교류할 때 예방접종 내역 정보를 표현하는 데 사용되며, 이 경우 가능한 한(SHOULD) 본 Profile을 준수해야 한다. 예방접종 내역 정보를 표현할 때 본 Profile을 적용하지 않을 수 있는 경우는 특수한 상황에 한정된다. 이 경우 반드시 해당 진료정보교류 도메인 내에서 사전 합의가 이루어져야 한다.
Usages:
KR Core Immunization Profile은 KR CDI의 예방접종내역 클래스 중 일부에 대응됨.
| KR CDI 예방접종내역 클래스 항목 | KR Core Immunization Profile 관련 항목 |
|---|---|
| 예방접종명 | Immunization.vaccineCode.where($this.coding.system = ‘http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types’) |
| 예방접종 약품명 | Immunization.extension.where(url = ‘http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product’).valueCodeableConcept.coding.where(system = ‘http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode’) |
| 예방접종 차수 | Immunization.protocolApplied.doseNumberPositiveInt |
| 예방접종 일자 | Immunization.occurrence |
| 예방접종 상태 | Immunization.status |
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Immunization |
0..* | Immunization | KR Core Immunization Profile | |||||||
  Slices for extension |
0..* | 확장(Extension) | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 | |||||||
   extension:administeredProduct |
0..1 | (Complex) | KRCDI) 예방접종 약품명 URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product | |||||||
   value[x] |
0..1 | CodeableConcept | 예방접종 약품명 바인딩(Binding): KR Core Korea Drug Codes (required)
| |||||||
 status |
1..1 | code | KRCDI) 예방접종 상태: completed | entered-in-error | not-done 선호값: completed | |||||||
| vaccineCode |
1..1 | CodeableConcept | KRCDI) 예방접종명 바인딩(Binding): KR Core Vaccination Type Codes (required)
| |||||||
 coding |
1..* | Coding | 코드 정보 | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
 code |
1..1 | code | 코드 | |||||||
 patient |
1..1 | Reference(KR Core Patient Profile) | 예방접종 대상 환자 | |||||||
 occurrence[x] |
1..1 | dateTime | KRCDI) 예방접종 일자 예방접종 일시 | |||||||
| protocolApplied |
0..* | BackboneElement | 예방접종 프로토콜 | |||||||
 Slices for doseNumber[x] |
1..1 | positiveInt, string | 예방 접종 차수 분할항목(Slice): 순서 없음, 다음 요소의 자료형이 다른 임의의 분할항목을 허용:$this 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 추가 정보가 없는 다른 자료형의 분할항목은 이 보기에서 표시하지 않음 | |||||||
 doseNumber[x]:doseNumberPositiveInt |
0..1 | positiveInt | KRCDI) 예방접종 차수 | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.extension:administeredProduct.value[x] | Base | required | KR Core Korea Drug Codes | 📦3.0.0-ballot | This IG |
| Immunization.vaccineCode | Base | required | KR Core Vaccination Type Codes | 📦3.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | KR Core Immunization Profile | |||||||
| implicitRules |
0..1 | uri | 이 리소스의 내용을 만들 때 적용한 별도의 규칙이나 기준 | |||||||
| Slices for extension |
0..* | 확장(Extension) | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 | |||||||
| extension:administeredProduct |
0..1 | (Complex) | KRCDI) 예방접종 약품명 URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product | |||||||
 extension |
0..0 | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | ||||||||
| url |
1..1 | uri | "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product" | |||||||
  value[x] |
0..1 | CodeableConcept | 예방접종 약품명 바인딩(Binding): KR Core Korea Drug Codes (required)
| |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| code |
1..1 | code | 코드 | |||||||
 modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| status |
1..1 | code | KRCDI) 예방접종 상태: completed | entered-in-error | not-done 바인딩(Binding): ImmunizationStatusCodes (required): 예방 접종의 현재 상태를 나타내는 코드 세트. 선호값: completed | |||||||
| vaccineCode |
1..1 | CodeableConcept | KRCDI) 예방접종명 바인딩(Binding): KR Core Vaccination Type Codes (required)
| |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| code |
1..1 | code | 코드 | |||||||
| patient |
1..1 | Reference(KR Core Patient Profile) | 예방접종 대상 환자 | |||||||
| occurrence[x] |
1..1 | dateTime | KRCDI) 예방접종 일자 예방접종 일시 | |||||||
| isSubpotent |
0..1 | boolean | 투여량 효력 | |||||||
| protocolApplied |
0..* | BackboneElement | 예방접종 프로토콜 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| Slices for doseNumber[x] |
1..1 | 예방 접종 차수 분할항목(Slice): Unordered, Closed by type:$this 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 추가 정보가 없는 다른 자료형의 분할항목은 이 보기에서 표시하지 않음 | ||||||||
 doseNumberPositiveInt |
positiveInt | |||||||||
| doseNumberString |
string | |||||||||
| doseNumber[x]:doseNumberPositiveInt |
0..1 | positiveInt | KRCDI) 예방접종 차수 | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.extension:administeredProduct.value[x] | Base | required | KR Core Korea Drug Codes | 📦3.0.0-ballot | This IG |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | KR Core Vaccination Type Codes | 📦3.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | KR Core Immunization Profile | |||||||
| id |
0..1 | id | 본 리소스 인스턴스의 논리적 ID | |||||||
| meta |
0..1 | Meta | 리소스에 대한 메타데이터 | |||||||
| implicitRules |
0..1 | uri | 이 리소스의 내용을 만들 때 적용한 별도의 규칙이나 기준 | |||||||
| language |
0..1 | code | 리소스 콘텐츠의 언어 바인딩(Binding): CommonLanguages (preferred): 국가별 언어.
| |||||||
| text |
0..1 | Narrative | 사람이 이해할 수 있도록 작성된 리소스 인스턴스의 요약 텍스트 이 프로파일은 내러티브의 내용, 사용 언어, 또는 해당 내용이 데이터 요소에 얼마나 추적 가능한지에 대해 제한하지 않음 | |||||||
| contained |
0..* | Resource | 포함된 리소스 | |||||||
| Slices for extension |
0..* | 확장(Extension) | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 | |||||||
| extension:administeredProduct |
0..1 | (Complex) | KRCDI) 예방접종 약품명 URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..0 | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | ||||||||
| url |
1..1 | uri | "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product" | |||||||
| value[x] |
0..1 | CodeableConcept | 예방접종 약품명 바인딩(Binding): KR Core Korea Drug Codes (required)
| |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| version |
0..1 | string | 시스템의 버전 - 필요한 경우에 제공 | |||||||
| code |
1..1 | code | 코드 | |||||||
| display |
0..1 | string | 표시명 | |||||||
| userSelected |
0..1 | boolean | 해당 코드 정보가 사용자의 직접 입력에 의해 선택된 경우 | |||||||
| text |
0..1 | string | 개념의 일반 텍스트 표현 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| identifier |
0..* | Identifier | 비즈니스 식별자 | |||||||
| status |
1..1 | code | KRCDI) 예방접종 상태: completed | entered-in-error | not-done 바인딩(Binding): ImmunizationStatusCodes (required): 예방 접종의 현재 상태를 나타내는 코드 세트. 선호값: completed | |||||||
| statusReason |
0..1 | CodeableConcept | 예방 접종이 이루어지지 않은 이유 바인딩(Binding): ImmunizationStatusReasonCodes (example): 백신을 투여하지 않은 이유. | |||||||
| vaccineCode |
1..1 | CodeableConcept | KRCDI) 예방접종명 바인딩(Binding): KR Core Vaccination Type Codes (required)
| |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| version |
0..1 | string | 시스템의 버전 - 필요한 경우에 제공 | |||||||
| code |
1..1 | code | 코드 | |||||||
| display |
0..1 | string | 표시명 | |||||||
| userSelected |
0..1 | boolean | 해당 코드 정보가 사용자의 직접 입력에 의해 선택된 경우 | |||||||
| text |
0..1 | string | 개념의 일반 텍스트 표현 | |||||||
| patient |
1..1 | Reference(KR Core Patient Profile) | 예방접종 대상 환자 | |||||||
| encounter |
0..1 | Reference(Encounter) | 예방 접종이 속한 수진 | |||||||
| occurrence[x] |
1..1 | dateTime | KRCDI) 예방접종 일자 예방접종 일시 | |||||||
| recorded |
0..1 | dateTime | 첫 예방접종 기록시점 | |||||||
| primarySource |
0..1 | boolean | 데이터가 기록된 맥락을 표시 | |||||||
| reportOrigin |
0..1 | CodeableConcept | 2차적으로 보고된 기록의 출처를 표시. 바인딩(Binding): ImmunizationOriginCodes (example): 1차 출처가 아닌 기록의 데이터 출처. | |||||||
| location |
0..1 | Reference(Location) | 예방 접종이 이루어진 곳 | |||||||
| manufacturer |
0..1 | Reference(Organization) | 백신 생산자 | |||||||
| lotNumber |
0..1 | string | 백신 LOT 넘버 | |||||||
| expirationDate |
0..1 | date | 백신 유효 기한 | |||||||
| site |
0..1 | CodeableConcept | 백신을 투여한 신체 부위 바인딩(Binding): CodesForImmunizationSiteOfAdministration (example): 백신이 투여된 부위. | |||||||
| route |
0..1 | CodeableConcept | 백신이 체내에 투여된 방법 바인딩(Binding): ImmunizationRouteCodes (example): 백신이 투여된 경로. | |||||||
| doseQuantity |
C | 0..1 | SimpleQuantity(4.0.1) | 투여된 백신의 양 Constraints: sqty-1 | ||||||
| performer |
0..* | BackboneElement | 백신 투여자 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| function |
0..1 | CodeableConcept | 완료된 수행의 종류 바인딩(Binding): ImmunizationFunctionCodes (extensible): 예방 접종 이벤트에서 의료인 또는 기관이 수행하는 역할. | |||||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | 수행한 개인 또는 기관 | |||||||
| note |
0..* | Annotation | 예방 접종 추가 참고사항 | |||||||
| reasonCode |
0..* | CodeableConcept | 예방 접종이 이루어진 이유 바인딩(Binding): ImmunizationReasonCodes (example): 백신이 투여된 이유. | |||||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | 예방 접종이 이루어진 이유 | |||||||
| isSubpotent |
0..1 | boolean | 투여량 효력 | |||||||
| subpotentReason |
0..* | CodeableConcept | 효력 감소 이유 바인딩(Binding): ImmunizationSubpotentReason (example): 투여량의 효력이 감소했다고 간주되는 이유 | |||||||
| education |
C | 0..* | BackboneElement | 환자에게 제공되는 교육 자료 Constraints: imm-1 | ||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| documentType |
0..1 | string | 교육 자료 문서 식별자 | |||||||
| reference |
0..1 | uri | 교육 자료 참조 | |||||||
| publicationDate |
0..1 | dateTime | 교육 자료 출판일 | |||||||
| presentationDate |
0..1 | dateTime | 교육 자료 제공일 | |||||||
| programEligibility |
0..* | CodeableConcept | 예방접종 프로그램에 대한 환자의 적격성 바인딩(Binding): ImmunizationProgramEligibility (example): 예방접종 프로그램에 대한 환자의 적격성. | |||||||
| fundingSource |
0..1 | CodeableConcept | 백신 자금 출처 바인딩(Binding): ImmunizationFundingSource (example): 투여한 백신을 구입하는 데 사용된 자금 출처. | |||||||
| reaction |
0..* | BackboneElement | 예방 접종 후 반응의 세부 사항 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| date |
0..1 | dateTime | 반응 시작 시각 | |||||||
| detail |
0..1 | Reference(Observation) | 반응에 대한 추가 정보 | |||||||
| reported |
0..1 | boolean | 자체 보고된 반응 표시 | |||||||
| protocolApplied |
0..* | BackboneElement | 예방접종 프로토콜 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| series |
0..1 | string | 백신 시리즈의 이름 | |||||||
| authority |
0..1 | Reference(Organization) | 권장사항 게시에 책임이 있는 사람 | |||||||
| targetDisease |
0..* | CodeableConcept | 백신으로 예방할 표적 질병 바인딩(Binding): ImmunizationTargetDiseaseCodes (example): 특정 용량으로 투여한 백신이 예방할 수 있는 질병. | |||||||
| Slices for doseNumber[x] |
1..1 | 예방 접종 차수 분할항목(Slice): Unordered, Closed by type:$this 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 추가 정보가 없는 다른 자료형의 분할항목은 이 보기에서 표시하지 않음 | ||||||||
| doseNumberPositiveInt |
positiveInt | |||||||||
| doseNumberString |
string | |||||||||
| doseNumber[x]:doseNumberPositiveInt |
0..1 | positiveInt | KRCDI) 예방접종 차수 | |||||||
 seriesDoses[x] |
0..1 | 면역을 위한 권장 투여량 | ||||||||
| seriesDosesPositiveInt |
positiveInt | |||||||||
| seriesDosesString |
string | |||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Immunization.extension:administeredProduct.value[x] | Base | required | KR Core Korea Drug Codes | 📦3.0.0-ballot | This IG |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | KR Core Vaccination Type Codes | 📦3.0.0-ballot | This IG |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | KR Core Immunization Profile | |||||||
| Slices for extension |
0..* | 확장(Extension) | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 | |||||||
| extension:administeredProduct |
0..1 | (Complex) | KRCDI) 예방접종 약품명 URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product | |||||||
| value[x] |
0..1 | CodeableConcept | 예방접종 약품명 바인딩(Binding): KR Core Korea Drug Codes (required)
| |||||||
| status |
1..1 | code | KRCDI) 예방접종 상태: completed | entered-in-error | not-done 선호값: completed | |||||||
| vaccineCode |
1..1 | CodeableConcept | KRCDI) 예방접종명 바인딩(Binding): KR Core Vaccination Type Codes (required)
| |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| code |
1..1 | code | 코드 | |||||||
| patient |
1..1 | Reference(KR Core Patient Profile) | 예방접종 대상 환자 | |||||||
| occurrence[x] |
1..1 | dateTime | KRCDI) 예방접종 일자 예방접종 일시 | |||||||
| protocolApplied |
0..* | BackboneElement | 예방접종 프로토콜 | |||||||
| Slices for doseNumber[x] |
1..1 | positiveInt, string | 예방 접종 차수 분할항목(Slice): 순서 없음, 다음 요소의 자료형이 다른 임의의 분할항목을 허용:$this 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 추가 정보가 없는 다른 자료형의 분할항목은 이 보기에서 표시하지 않음 | |||||||
| doseNumber[x]:doseNumberPositiveInt |
0..1 | positiveInt | KRCDI) 예방접종 차수 | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.extension:administeredProduct.value[x] | Base | required | KR Core Korea Drug Codes | 📦3.0.0-ballot | This IG |
| Immunization.vaccineCode | Base | required | KR Core Vaccination Type Codes | 📦3.0.0-ballot | This IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | KR Core Immunization Profile | |||||||
| implicitRules |
0..1 | uri | 이 리소스의 내용을 만들 때 적용한 별도의 규칙이나 기준 | |||||||
| Slices for extension |
0..* | 확장(Extension) | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 | |||||||
| extension:administeredProduct |
0..1 | (Complex) | KRCDI) 예방접종 약품명 URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product | |||||||
| extension |
0..0 | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | ||||||||
| url |
1..1 | uri | "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product" | |||||||
| value[x] |
0..1 | CodeableConcept | 예방접종 약품명 바인딩(Binding): KR Core Korea Drug Codes (required)
| |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| code |
1..1 | code | 코드 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| status |
1..1 | code | KRCDI) 예방접종 상태: completed | entered-in-error | not-done 바인딩(Binding): ImmunizationStatusCodes (required): 예방 접종의 현재 상태를 나타내는 코드 세트. 선호값: completed | |||||||
| vaccineCode |
1..1 | CodeableConcept | KRCDI) 예방접종명 바인딩(Binding): KR Core Vaccination Type Codes (required)
| |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| code |
1..1 | code | 코드 | |||||||
| patient |
1..1 | Reference(KR Core Patient Profile) | 예방접종 대상 환자 | |||||||
| occurrence[x] |
1..1 | dateTime | KRCDI) 예방접종 일자 예방접종 일시 | |||||||
| isSubpotent |
0..1 | boolean | 투여량 효력 | |||||||
| protocolApplied |
0..* | BackboneElement | 예방접종 프로토콜 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| Slices for doseNumber[x] |
1..1 | 예방 접종 차수 분할항목(Slice): Unordered, Closed by type:$this 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 추가 정보가 없는 다른 자료형의 분할항목은 이 보기에서 표시하지 않음 | ||||||||
| doseNumberPositiveInt |
positiveInt | |||||||||
| doseNumberString |
string | |||||||||
| doseNumber[x]:doseNumberPositiveInt |
0..1 | positiveInt | KRCDI) 예방접종 차수 | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.extension:administeredProduct.value[x] | Base | required | KR Core Korea Drug Codes | 📦3.0.0-ballot | This IG |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | KR Core Vaccination Type Codes | 📦3.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | KR Core Immunization Profile | |||||||
| id |
0..1 | id | 본 리소스 인스턴스의 논리적 ID | |||||||
| meta |
0..1 | Meta | 리소스에 대한 메타데이터 | |||||||
| implicitRules |
0..1 | uri | 이 리소스의 내용을 만들 때 적용한 별도의 규칙이나 기준 | |||||||
| language |
0..1 | code | 리소스 콘텐츠의 언어 바인딩(Binding): CommonLanguages (preferred): 국가별 언어.
| |||||||
| text |
0..1 | Narrative | 사람이 이해할 수 있도록 작성된 리소스 인스턴스의 요약 텍스트 이 프로파일은 내러티브의 내용, 사용 언어, 또는 해당 내용이 데이터 요소에 얼마나 추적 가능한지에 대해 제한하지 않음 | |||||||
| contained |
0..* | Resource | 포함된 리소스 | |||||||
| Slices for extension |
0..* | 확장(Extension) | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 | |||||||
| extension:administeredProduct |
0..1 | (Complex) | KRCDI) 예방접종 약품명 URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..0 | 확장(Extension) 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | ||||||||
| url |
1..1 | uri | "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization-administered-product" | |||||||
| value[x] |
0..1 | CodeableConcept | 예방접종 약품명 바인딩(Binding): KR Core Korea Drug Codes (required)
| |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| version |
0..1 | string | 시스템의 버전 - 필요한 경우에 제공 | |||||||
| code |
1..1 | code | 코드 | |||||||
| display |
0..1 | string | 표시명 | |||||||
| userSelected |
0..1 | boolean | 해당 코드 정보가 사용자의 직접 입력에 의해 선택된 경우 | |||||||
| text |
0..1 | string | 개념의 일반 텍스트 표현 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| identifier |
0..* | Identifier | 비즈니스 식별자 | |||||||
| status |
1..1 | code | KRCDI) 예방접종 상태: completed | entered-in-error | not-done 바인딩(Binding): ImmunizationStatusCodes (required): 예방 접종의 현재 상태를 나타내는 코드 세트. 선호값: completed | |||||||
| statusReason |
0..1 | CodeableConcept | 예방 접종이 이루어지지 않은 이유 바인딩(Binding): ImmunizationStatusReasonCodes (example): 백신을 투여하지 않은 이유. | |||||||
| vaccineCode |
1..1 | CodeableConcept | KRCDI) 예방접종명 바인딩(Binding): KR Core Vaccination Type Codes (required)
| |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| coding |
1..* | Coding | 코드 정보 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 분할항목(Slice): 순서 없음, 다음 요소의 값이 다른 임의의 분할항목을 허용:url | |||||||
| system |
1..1 | uri | 코드체계 식별자 | |||||||
| version |
0..1 | string | 시스템의 버전 - 필요한 경우에 제공 | |||||||
| code |
1..1 | code | 코드 | |||||||
| display |
0..1 | string | 표시명 | |||||||
| userSelected |
0..1 | boolean | 해당 코드 정보가 사용자의 직접 입력에 의해 선택된 경우 | |||||||
| text |
0..1 | string | 개념의 일반 텍스트 표현 | |||||||
| patient |
1..1 | Reference(KR Core Patient Profile) | 예방접종 대상 환자 | |||||||
| encounter |
0..1 | Reference(Encounter) | 예방 접종이 속한 수진 | |||||||
| occurrence[x] |
1..1 | dateTime | KRCDI) 예방접종 일자 예방접종 일시 | |||||||
| recorded |
0..1 | dateTime | 첫 예방접종 기록시점 | |||||||
| primarySource |
0..1 | boolean | 데이터가 기록된 맥락을 표시 | |||||||
| reportOrigin |
0..1 | CodeableConcept | 2차적으로 보고된 기록의 출처를 표시. 바인딩(Binding): ImmunizationOriginCodes (example): 1차 출처가 아닌 기록의 데이터 출처. | |||||||
| location |
0..1 | Reference(Location) | 예방 접종이 이루어진 곳 | |||||||
| manufacturer |
0..1 | Reference(Organization) | 백신 생산자 | |||||||
| lotNumber |
0..1 | string | 백신 LOT 넘버 | |||||||
| expirationDate |
0..1 | date | 백신 유효 기한 | |||||||
| site |
0..1 | CodeableConcept | 백신을 투여한 신체 부위 바인딩(Binding): CodesForImmunizationSiteOfAdministration (example): 백신이 투여된 부위. | |||||||
| route |
0..1 | CodeableConcept | 백신이 체내에 투여된 방법 바인딩(Binding): ImmunizationRouteCodes (example): 백신이 투여된 경로. | |||||||
| doseQuantity |
C | 0..1 | SimpleQuantity(4.0.1) | 투여된 백신의 양 Constraints: sqty-1 | ||||||
| performer |
0..* | BackboneElement | 백신 투여자 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| function |
0..1 | CodeableConcept | 완료된 수행의 종류 바인딩(Binding): ImmunizationFunctionCodes (extensible): 예방 접종 이벤트에서 의료인 또는 기관이 수행하는 역할. | |||||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | 수행한 개인 또는 기관 | |||||||
| note |
0..* | Annotation | 예방 접종 추가 참고사항 | |||||||
| reasonCode |
0..* | CodeableConcept | 예방 접종이 이루어진 이유 바인딩(Binding): ImmunizationReasonCodes (example): 백신이 투여된 이유. | |||||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | 예방 접종이 이루어진 이유 | |||||||
| isSubpotent |
0..1 | boolean | 투여량 효력 | |||||||
| subpotentReason |
0..* | CodeableConcept | 효력 감소 이유 바인딩(Binding): ImmunizationSubpotentReason (example): 투여량의 효력이 감소했다고 간주되는 이유 | |||||||
| education |
C | 0..* | BackboneElement | 환자에게 제공되는 교육 자료 Constraints: imm-1 | ||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| documentType |
0..1 | string | 교육 자료 문서 식별자 | |||||||
| reference |
0..1 | uri | 교육 자료 참조 | |||||||
| publicationDate |
0..1 | dateTime | 교육 자료 출판일 | |||||||
| presentationDate |
0..1 | dateTime | 교육 자료 제공일 | |||||||
| programEligibility |
0..* | CodeableConcept | 예방접종 프로그램에 대한 환자의 적격성 바인딩(Binding): ImmunizationProgramEligibility (example): 예방접종 프로그램에 대한 환자의 적격성. | |||||||
| fundingSource |
0..1 | CodeableConcept | 백신 자금 출처 바인딩(Binding): ImmunizationFundingSource (example): 투여한 백신을 구입하는 데 사용된 자금 출처. | |||||||
| reaction |
0..* | BackboneElement | 예방 접종 후 반응의 세부 사항 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| date |
0..1 | dateTime | 반응 시작 시각 | |||||||
| detail |
0..1 | Reference(Observation) | 반응에 대한 추가 정보 | |||||||
| reported |
0..1 | boolean | 자체 보고된 반응 표시 | |||||||
| protocolApplied |
0..* | BackboneElement | 예방접종 프로토콜 | |||||||
| id |
0..1 | string | 요소 간 참조를 위한 고유 ID | |||||||
| extension |
0..* | 확장(Extension) | 추가 정보를 제공하기 위해 정의한 확장(Extension) 목록 | |||||||
| modifierExtension |
0..* | 확장(Extension) | 의미나 해석을 변경하기 위해 정의한 확장(Extension) 목록 | |||||||
| series |
0..1 | string | 백신 시리즈의 이름 | |||||||
| authority |
0..1 | Reference(Organization) | 권장사항 게시에 책임이 있는 사람 | |||||||
| targetDisease |
0..* | CodeableConcept | 백신으로 예방할 표적 질병 바인딩(Binding): ImmunizationTargetDiseaseCodes (example): 특정 용량으로 투여한 백신이 예방할 수 있는 질병. | |||||||
| Slices for doseNumber[x] |
1..1 | 예방 접종 차수 분할항목(Slice): Unordered, Closed by type:$this 노트: 이 요소와 그 하위 요소에 정의된 규칙은 모든 슬라이스에 적용되지만, 각 슬라이스에 반복하여 표시하지는 않음 추가 정보가 없는 다른 자료형의 분할항목은 이 보기에서 표시하지 않음 | ||||||||
| doseNumberPositiveInt |
positiveInt | |||||||||
| doseNumberString |
string | |||||||||
| doseNumber[x]:doseNumberPositiveInt |
0..1 | positiveInt | KRCDI) 예방접종 차수 | |||||||
| seriesDoses[x] |
0..1 | 면역을 위한 권장 투여량 | ||||||||
| seriesDosesPositiveInt |
positiveInt | |||||||||
| seriesDosesString |
string | |||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Immunization.extension:administeredProduct.value[x] | Base | required | KR Core Korea Drug Codes | 📦3.0.0-ballot | This IG |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | KR Core Vaccination Type Codes | 📦3.0.0-ballot | This IG |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
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) 지원해야 한다.
Immunization Resource를 검색하기 위해 KR Core에서 추가로 정의한 검색 파라미터.
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| dose-number | positiveint | 예방 접종 차수 | Immunization.protocolApplied.doseNumber.ofType(positiveInt) | MAY |
Immunization Resource를 검색하기 위해 기본 FHIR 사양을 기반으로 정의한 검색 파라미터.
| Name | Type | Description | Expression | Expectations |
|---|---|---|---|---|
| date | datetime | 예방 접종 일시 | 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를 구현한 서버의 선택 사항에 따라 추가로 제공 가능.
IG © 2022+ HL7 Korea. Package hl7.fhir.kr.core#3.0.0-ballot based on FHIR 4.0.1. Generated 2026-10-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change