臺灣核心實作指引(TW Core IG)
0.3.2 - 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.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ 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.2
Active as of 2025-02-04 Computable Name: TWCoreImmunization

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

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
tw-core-10: SHOULD have a translation to the NDC value set
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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.


ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: VaccineAdministeredValueSet (extensible)
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(TW Core Patient) Who was immunized
ele-1: All FHIR elements must have a @value or children
... encounter S 0..1 Reference(TW Core Encounter) Encounter immunization was part of
ele-1: All FHIR elements must have a @value or children
... occurrence[x] SΣ 1..1 Vaccine administration date
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTime dateTime
... primarySource SΣ 0..1 boolean Indicates context the data was recorded in
ele-1: All FHIR elements must have a @value or children
... location S 0..1 Reference(TW Core Location) Where immunization occurred
ele-1: All FHIR elements must have a @value or children
... manufacturer 0..1 Reference(TW Core Organization) Vaccine manufacturer
ele-1: All FHIR elements must have a @value or children
... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport) Why immunization occurred
ele-1: All FHIR elements must have a @value or children
... isSubpotent ?!Σ 0..1 boolean Dose potency
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
from the FHIR Standard
Immunization.vaccineCodeextensibleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tw-core-10best practiceImmunizationSHOULD 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) 支援透過查詢參數 patientdate 查詢所有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) 支援透過查詢參數 patientstatus 查詢所有Immunization:
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/Immunization?patient={Type/}[id]&status={system|}[code]

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