臺灣核心實作指引(TW Core IG)
0.3.3 - Ci-Build Trial Use

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/MOHW-TWCoreIG/cctwFHIRterm/ 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: 0.3.3
Active as of 2025-11-21 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: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: tw-core-10
... 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.
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(TW Core Patient) Who was immunized
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime S
.... occurrenceString string
... primarySource SΣ 0..1 boolean Indicates context the data was recorded in
... location S 0..1 Reference(TW Core Location) Where immunization occurred
... manufacturer 0..1 Reference(TW Core Organization) Vaccine manufacturer
... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency

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: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: tw-core-10
... status S 1..1 code completed | entered-in-error | not-done
... statusReason S 0..1 CodeableConcept Reason not done
... vaccineCode SC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
... occurrence[x] S 1..1 Vaccine administration date
.... occurrenceDateTime dateTime S
.... occurrenceString string
... primarySource S 0..1 boolean Indicates context the data was recorded in
... location S 0..1 Reference(TW Core Location) Where immunization occurred
... manufacturer 0..1 Reference(TW Core Organization) Vaccine manufacturer
... performer
.... actor 1..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) Individual or organization who was performing
... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) Why immunization occurred
... reaction
.... detail 0..1 Reference(TW Core Observation Clinical Result) Additional information on reaction
... protocolApplied
.... authority 0..1 Reference(TW Core Organization) Who is responsible for publishing the recommendations

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: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: tw-core-10
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
... 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.
... statusReason S 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(TW Core Patient) Who was immunized
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime S
.... occurrenceString string
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource SΣ 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 S 0..1 Reference(TW Core Location) Where immunization occurred
... manufacturer 0..1 Reference(TW Core 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(4.0.1) 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(TW Core Practitioner | TW Core PractitionerRole | TW Core 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(TW Core Condition | TW Core Observation Clinical Result | TW Core 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
Constraints: imm-1
.... 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(TW Core Observation Clinical Result) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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(TW Core 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.
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... 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()
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: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: tw-core-10
... 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.
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(TW Core Patient) Who was immunized
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime S
.... occurrenceString string
... primarySource SΣ 0..1 boolean Indicates context the data was recorded in
... location S 0..1 Reference(TW Core Location) Where immunization occurred
... manufacturer 0..1 Reference(TW Core Organization) Vaccine manufacturer
... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency

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: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: tw-core-10
... status S 1..1 code completed | entered-in-error | not-done
... statusReason S 0..1 CodeableConcept Reason not done
... vaccineCode SC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
... occurrence[x] S 1..1 Vaccine administration date
.... occurrenceDateTime dateTime S
.... occurrenceString string
... primarySource S 0..1 boolean Indicates context the data was recorded in
... location S 0..1 Reference(TW Core Location) Where immunization occurred
... manufacturer 0..1 Reference(TW Core Organization) Vaccine manufacturer
... performer
.... actor 1..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) Individual or organization who was performing
... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) Why immunization occurred
... reaction
.... detail 0..1 Reference(TW Core Observation Clinical Result) Additional information on reaction
... protocolApplied
.... authority 0..1 Reference(TW Core Organization) Who is responsible for publishing the recommendations

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: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: tw-core-10
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
... 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.
... statusReason S 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(TW Core Patient) Who was immunized
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime S
.... occurrenceString string
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource SΣ 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 S 0..1 Reference(TW Core Location) Where immunization occurred
... manufacturer 0..1 Reference(TW Core 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(4.0.1) 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(TW Core Practitioner | TW Core PractitionerRole | TW Core 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(TW Core Condition | TW Core Observation Clinical Result | TW Core 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
Constraints: imm-1
.... 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(TW Core Observation Clinical Result) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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(TW Core 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.
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... 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()
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