臺灣核心實作指引(TW Core IG)
1.0.0 - STU 1.0.0 Taiwan flag

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TU9IVy1UV0NvcmVJRw/VFcgQ29yZSBJRyBJVFJJ/ and changes regularly. See the Directory of published versions

Resource Profile: TW Core Immunization

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Immunization-twcore Version: 1.0.0
Active as of 2026-11-10 Computable Name: TWCoreImmunization

此臺灣核心-疫苗接種 (TW Core Immunization) Profile 說明本 IG 如何進一步定義 FHIR 的 Immunization Resource 以呈現疫苗接種資料。

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization C 0..* Immunization 疫苗接種
Constraints: tw-core-10
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Immunization.modifierExtension This element is a modifier element. 0..* Extension 擴充內容可能會改變資源解釋方式
Immunization.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept 接種未完成的原因
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element must be supported. This element is included in summaries. C 1..1 CodeableConcept 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)
Binding: VaccineAdministeredValueSet (extensible)
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) 接種疫苗的病患
Immunization.encounter This element must be supported. 0..1 Reference(TW Core Encounter) 與疫苗接種相關的就醫事件
Immunization.occurrence[x] This element must be supported. This element is included in summaries. 1..1 疫苗接種的發生日期/時間
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element must be supported. This element is included in summaries. 0..1 boolean 資料來源是否為主要來源
Immunization.location This element must be supported. 0..1 Reference(TW Core Location) 疫苗接種的地點
Immunization.manufacturer 0..1 Reference(TW Core Organization) 疫苗製造商
Immunization.reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) 接種疫苗的原因
Immunization.isSubpotent This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean 疫苗效價是否低於標準

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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 extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
tw-core-10 best practice Immunization SHOULD have a translation to the NDC value set vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization C 0..* Immunization 疫苗接種
Constraints: tw-core-10
Immunization.implicitRules 0..1 uri 創建此內容所依據的一組規則
Immunization.modifierExtension 0..* Extension 擴充內容可能會改變資源解釋方式
Immunization.status This element must be supported. 1..1 code completed | entered-in-error | not-done
Immunization.vaccineCode This element must be supported. C 1..1 CodeableConcept 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)
Binding: VaccineAdministeredValueSet (extensible)
Immunization.patient This element must be supported. 1..1 Reference(TW Core Patient) 接種疫苗的病患
Immunization.encounter This element must be supported. 0..1 Reference(TW Core Encounter) 與疫苗接種相關的就醫事件
Immunization.occurrence[x] This element must be supported. 1..1 疫苗接種的發生日期/時間
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element must be supported. 0..1 boolean 資料來源是否為主要來源
Immunization.location This element must be supported. 0..1 Reference(TW Core Location) 疫苗接種的地點
Immunization.manufacturer 0..1 Reference(TW Core Organization) 疫苗製造商
Immunization.performer
Immunization.performer.actor 1..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 執行疫苗接種的人員或組織
Immunization.reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) 接種疫苗的原因
Immunization.isSubpotent This element must be supported. 0..1 boolean 疫苗效價是否低於標準
Immunization.reaction
Immunization.reaction.detail 0..1 Reference(TW Core Observation Clinical Result) 接種後反應的細節
Immunization.protocolApplied
Immunization.protocolApplied.authority 0..1 Reference(TW Core Organization) 疫苗接種計劃的權責組織

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
tw-core-10 best practice Immunization SHOULD have a translation to the NDC value set vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization C 0..* Immunization 疫苗接種
Constraints: tw-core-10
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.extension 0..* Extension Additional content defined by implementations
Immunization.modifierExtension This element is a modifier element. 0..* Extension 擴充內容可能會改變資源解釋方式
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept 接種未完成的原因
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element must be supported. This element is included in summaries. C 1..1 CodeableConcept 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)
Binding: VaccineAdministeredValueSet (extensible)
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) 接種疫苗的病患
Immunization.encounter This element must be supported. 0..1 Reference(TW Core Encounter) 與疫苗接種相關的就醫事件
Immunization.occurrence[x] This element must be supported. This element is included in summaries. 1..1 疫苗接種的發生日期/時間
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element must be supported. This element is included in summaries. 0..1 boolean 資料來源是否為主要來源
Immunization.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.
Immunization.location This element must be supported. 0..1 Reference(TW Core Location) 疫苗接種的地點
Immunization.manufacturer 0..1 Reference(TW Core Organization) 疫苗製造商
Immunization.lotNumber 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 執行疫苗接種的人員或組織
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) 接種疫苗的原因
Immunization.isSubpotent This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean 疫苗效價是否低於標準
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(TW Core Observation Clinical Result) 接種後反應的細節
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(TW Core Organization) 疫苗接種計劃的權責組織
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
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 extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()
tw-core-10 best practice Immunization SHOULD have a translation to the NDC value set vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization C 0..* Immunization 疫苗接種
Constraints: tw-core-10
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Immunization.modifierExtension This element is a modifier element. 0..* Extension 擴充內容可能會改變資源解釋方式
Immunization.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept 接種未完成的原因
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element must be supported. This element is included in summaries. C 1..1 CodeableConcept 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)
Binding: VaccineAdministeredValueSet (extensible)
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) 接種疫苗的病患
Immunization.encounter This element must be supported. 0..1 Reference(TW Core Encounter) 與疫苗接種相關的就醫事件
Immunization.occurrence[x] This element must be supported. This element is included in summaries. 1..1 疫苗接種的發生日期/時間
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element must be supported. This element is included in summaries. 0..1 boolean 資料來源是否為主要來源
Immunization.location This element must be supported. 0..1 Reference(TW Core Location) 疫苗接種的地點
Immunization.manufacturer 0..1 Reference(TW Core Organization) 疫苗製造商
Immunization.reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) 接種疫苗的原因
Immunization.isSubpotent This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean 疫苗效價是否低於標準

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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 extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
tw-core-10 best practice Immunization SHOULD have a translation to the NDC value set vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization C 0..* Immunization 疫苗接種
Constraints: tw-core-10
Immunization.implicitRules 0..1 uri 創建此內容所依據的一組規則
Immunization.modifierExtension 0..* Extension 擴充內容可能會改變資源解釋方式
Immunization.status This element must be supported. 1..1 code completed | entered-in-error | not-done
Immunization.statusReason This element must be supported. 0..1 CodeableConcept 接種未完成的原因
Immunization.vaccineCode This element must be supported. C 1..1 CodeableConcept 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)
Binding: VaccineAdministeredValueSet (extensible)
Immunization.patient This element must be supported. 1..1 Reference(TW Core Patient) 接種疫苗的病患
Immunization.encounter This element must be supported. 0..1 Reference(TW Core Encounter) 與疫苗接種相關的就醫事件
Immunization.occurrence[x] This element must be supported. 1..1 疫苗接種的發生日期/時間
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.primarySource This element must be supported. 0..1 boolean 資料來源是否為主要來源
Immunization.location This element must be supported. 0..1 Reference(TW Core Location) 疫苗接種的地點
Immunization.manufacturer 0..1 Reference(TW Core Organization) 疫苗製造商
Immunization.performer
Immunization.performer.actor 1..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 執行疫苗接種的人員或組織
Immunization.reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) 接種疫苗的原因
Immunization.isSubpotent This element must be supported. 0..1 boolean 疫苗效價是否低於標準
Immunization.reaction
Immunization.reaction.detail 0..1 Reference(TW Core Observation Clinical Result) 接種後反應的細節
Immunization.protocolApplied
Immunization.protocolApplied.authority 0..1 Reference(TW Core Organization) 疫苗接種計劃的權責組織

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
tw-core-10 best practice Immunization SHOULD have a translation to the NDC value set vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization C 0..* Immunization 疫苗接種
Constraints: tw-core-10
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.extension 0..* Extension Additional content defined by implementations
Immunization.modifierExtension This element is a modifier element. 0..* Extension 擴充內容可能會改變資源解釋方式
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept 接種未完成的原因
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element must be supported. This element is included in summaries. C 1..1 CodeableConcept 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)
Binding: VaccineAdministeredValueSet (extensible)
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) 接種疫苗的病患
Immunization.encounter This element must be supported. 0..1 Reference(TW Core Encounter) 與疫苗接種相關的就醫事件
Immunization.occurrence[x] This element must be supported. This element is included in summaries. 1..1 疫苗接種的發生日期/時間
Immunization.occurrence[x].occurrenceDateTime dateTime This target must be supported.
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element must be supported. This element is included in summaries. 0..1 boolean 資料來源是否為主要來源
Immunization.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.
Immunization.location This element must be supported. 0..1 Reference(TW Core Location) 疫苗接種的地點
Immunization.manufacturer 0..1 Reference(TW Core Organization) 疫苗製造商
Immunization.lotNumber 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 執行疫苗接種的人員或組織
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) 接種疫苗的原因
Immunization.isSubpotent This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean 疫苗效價是否低於標準
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(TW Core Observation Clinical Result) 接種後反應的細節
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(TW Core Organization) 疫苗接種計劃的權責組織
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
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 extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()
tw-core-10 best practice Immunization SHOULD have a translation to the NDC value set vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。

必須支援以下查詢參數:

  1. 必須(SHALL) 支援透過查詢參數 patient 查詢所有Immunization:
    (如何透過reference查詢)
    GET [base]/Immunization?patient={Type/}[id]

    例子:
    (1) GET [base]/Immunization?patient=Patient/pat-example

建議應該支援以下查詢參數:

  1. 建議應該(SHOULD) 支援透過查詢參數 patient 及 date 查詢所有Immunization:
    (如何透過reference查詢)
    (如何透過date查詢)
    GET [base]/Immunization?patient={Type/}[id]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    例子:
    (1) GET [base]/Immunization?patient=Patient/pat-example&date=ge2024-08-31T00:00:00Z

  2. 建議應該(SHOULD) 支援透過查詢參數 patient 及 status 查詢所有Immunization:
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/Immunization?patient={Type/}[id]&status={system|}[code]

    例子:
    (1) GET [base]/Immunization?patient=Patient/pat-example&status=completed