empty
empty

KR Core Implementation Guide
1.0.0 - STU 1

KR Core Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: KR Core Immunization Profile

Defining URL:https://example.org/fhir/krcore/StructureDefinition/krcore-immunization
Version:1.0.0
Name:KRCore_Immunization
Title:KR Core Immunization Profile
Status:Draft as of 2021-11-14T02:54:35.9067173+00:00
Publisher:Smart Health Standards Forum
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

https://example.org/fhir/krcore/StructureDefinition/krcore-immunization

Formal Views of Profile Content

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

This structure is derived from Immunization

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... krcore-vaccinedrugcode S0..*CodeableConceptExtension
URL: https://example.org/fhir/krcore/StructureDefinition/krcore-vaccinedrugcode
Binding: Korea Drug Codes (required): KD Code

... status 1..1code예방 접종 상태: completed(완료) | entered-in-error(입력 오류) | not-done(미실행)
.... coding 0..*Coding정의된 코드
..... system S1..1uri코드체계 식별자
..... code S1..1code코드값
..... display 0..1string코드명칭
.... text 0..1string백신 정보 텍스트
... patient S1..1Reference(KR Core Patient Profile)예방 접종 대상
... occurrence[x] S1..1dateTime, string예방 접종 일시
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... doseNumber[x] S1..1positiveInt, string에방 접종 차수

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... krcore-vaccinedrugcode S0..*CodeableConceptOptional Extensions Element
URL: https://example.org/fhir/krcore/StructureDefinition/krcore-vaccinedrugcode
Binding: Korea Drug Codes (required): KD Code


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1code예방 접종 상태: completed(완료) | entered-in-error(입력 오류) | not-done(미실행)
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

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

... vaccineCode SΣ1..1CodeableConcept백신 코드
Binding: KR Core Vaccine Codes (extensible): KR Core Vaccine Codes

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*Coding정의된 코드
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uri코드체계 식별자
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1code코드값
..... display Σ0..1string코드명칭
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1string백신 정보 텍스트
... patient SΣ1..1Reference(KR Core Patient Profile)예방 접종 대상
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1예방 접종 일시
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... 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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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.


.... doseNumber[x] S1..1에방 접종 차수
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... krcore-vaccinedrugcode 0..*CodeableConceptOptional Extensions Element
URL: https://example.org/fhir/krcore/StructureDefinition/krcore-vaccinedrugcode
Binding: Korea Drug Codes (required): KD Code


... vaccineCode Σ1..1CodeableConcept백신 코드
Binding: KR Core Vaccine Codes (extensible): KR Core Vaccine Codes

.... coding Σ0..*Coding정의된 코드
..... system Σ1..1uri코드체계 식별자
..... code Σ1..1code코드값
... patient Σ1..1Reference(KR Core Patient Profile)예방 접종 대상
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... doseNumber[x] 1..1에방 접종 차수
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

This structure is derived from Immunization

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... krcore-vaccinedrugcode S0..*CodeableConceptExtension
URL: https://example.org/fhir/krcore/StructureDefinition/krcore-vaccinedrugcode
Binding: Korea Drug Codes (required): KD Code

... status 1..1code예방 접종 상태: completed(완료) | entered-in-error(입력 오류) | not-done(미실행)
.... coding 0..*Coding정의된 코드
..... system S1..1uri코드체계 식별자
..... code S1..1code코드값
..... display 0..1string코드명칭
.... text 0..1string백신 정보 텍스트
... patient S1..1Reference(KR Core Patient Profile)예방 접종 대상
... occurrence[x] S1..1dateTime, string예방 접종 일시
... protocolApplied 0..*BackboneElement예방 접종 프로토콜
.... doseNumber[x] S1..1positiveInt, string에방 접종 차수

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationKR Core Immunization Profile
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... krcore-vaccinedrugcode S0..*CodeableConceptOptional Extensions Element
URL: https://example.org/fhir/krcore/StructureDefinition/krcore-vaccinedrugcode
Binding: Korea Drug Codes (required): KD Code


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1code예방 접종 상태: completed(완료) | entered-in-error(입력 오류) | not-done(미실행)
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

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

... vaccineCode SΣ1..1CodeableConcept백신 코드
Binding: KR Core Vaccine Codes (extensible): KR Core Vaccine Codes

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*Coding정의된 코드
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uri코드체계 식별자
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1code코드값
..... display Σ0..1string코드명칭
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1string백신 정보 텍스트
... patient SΣ1..1Reference(KR Core Patient Profile)예방 접종 대상
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1예방 접종 일시
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... 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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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.


.... doseNumber[x] S1..1에방 접종 차수
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodeextensibleKR_Core_Vaccince_Codes
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

IdPathDetailsRequirements
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()