臺灣疫苗接種或開立藥品紀錄上傳實作指引
0.1.0 - ci-build

臺灣疫苗接種或開立藥品紀錄上傳實作指引 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: VACC系統疫苗紀錄(Immunization VACC)

Official URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/immunization-vacc Version: 0.1.0
Active as of 2024-06-13 Computable Name: ImmunizationVACC

此VACC系統疫苗紀錄(Immunization VACC)Profile 說明本IG如何進一步定義FHIR的 Immunization Resource 以呈現VACC系統中的接種疫苗/開立藥品紀錄之接種疫苗資料。

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
code-vacc-fundingSource: 當StockType = 0(庫存),則收費類型fundingSource必填
code-vacc-manufacturer: 當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... StockType S 1..1 CodeableConcept 庫存類別
URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type
Binding: CDC-VACC系統-庫存類別值集 (required)
... identifier S 1..* Identifier Business identifier
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: CDC-VACC系統-疫苗值集 (required)
... Slices for occurrence[x] 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime 接種日期
... manufacturer 0..1 Reference(疫苗廠牌(Brand Of Vaccive Organization VACC)) 疫苗廠牌
... lotNumber S 0..1 string 疫苗批號
... doseQuantity S 1..1 SimpleQuantity 疫苗數量
... performer S 1..* BackboneElement Who performed event
.... actor 1..1 Reference(接種機構、發證機構(Vaccination Organization VACC)) 接種機構
... note S 0..* Annotation travelDateKey
... reasonReference S 0..1 Reference(個案出境資料(Observation VACC)) Why immunization occurred
... fundingSource 0..1 CodeableConcept 收費類型
Binding: ImmunizationFundingSource (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCoderequiredTWVACCVaccineCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values
from this IG
Immunization.fundingSourcerequiredImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
code-vacc-fundingSourceerrorImmunization當StockType = 0(庫存),則收費類型fundingSource必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (fundingSource.exists())
code-vacc-manufacturererrorImmunization當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '1').exists()) implies (manufacturer.reference.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
code-vacc-fundingSource: 當StockType = 0(庫存),則收費類型fundingSource必填
code-vacc-manufacturer: 當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... StockType S 1..1 CodeableConcept 庫存類別
URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type
Binding: CDC-VACC系統-庫存類別值集 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CDC-VACC系統-疫苗值集 (required)
... patient Σ 1..1 Reference(個案資料(Patient VACC)) Who was immunized
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime 接種日期
... manufacturer 0..1 Reference(疫苗廠牌(Brand Of Vaccive Organization VACC)) 疫苗廠牌
... lotNumber S 0..1 string 疫苗批號
... doseQuantity S 1..1 SimpleQuantity 疫苗數量
... performer SΣ 1..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(接種機構、發證機構(Vaccination Organization VACC)) 接種機構
... note SΣ 0..* Annotation travelDateKey
... reasonReference S 0..1 Reference(個案出境資料(Observation VACC)) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... fundingSource 0..1 CodeableConcept 收費類型
Binding: ImmunizationFundingSource (required)

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.vaccineCoderequiredTWVACCVaccineCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values
from this IG
Immunization.fundingSourcerequiredImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
code-vacc-fundingSourceerrorImmunization當StockType = 0(庫存),則收費類型fundingSource必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (fundingSource.exists())
code-vacc-manufacturererrorImmunization當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '1').exists()) implies (manufacturer.reference.exists())
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
code-vacc-fundingSource: 當StockType = 0(庫存),則收費類型fundingSource必填
code-vacc-manufacturer: 當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... StockType S 1..1 CodeableConcept 庫存類別
URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type
Binding: CDC-VACC系統-庫存類別值集 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

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

... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CDC-VACC系統-疫苗值集 (required)
... patient Σ 1..1 Reference(個案資料(Patient VACC)) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime 接種日期
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 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 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(疫苗廠牌(Brand Of Vaccive Organization VACC)) 疫苗廠牌
... lotNumber S 0..1 string 疫苗批號
... 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 S 1..1 SimpleQuantity 疫苗數量
... performer SΣ 1..* 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(接種機構、發證機構(Vaccination Organization VACC)) 接種機構
... note SΣ 0..* Annotation travelDateKey
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference S 0..1 Reference(個案出境資料(Observation VACC)) 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
imm-1: One of documentType or reference SHALL be present
.... 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 收費類型
Binding: ImmunizationFundingSource (required)
... 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(Observation) 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(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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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.vaccineCoderequiredTWVACCVaccineCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
from the FHIR Standard
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourcerequiredImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
code-vacc-fundingSourceerrorImmunization當StockType = 0(庫存),則收費類型fundingSource必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (fundingSource.exists())
code-vacc-manufacturererrorImmunization當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '1').exists()) implies (manufacturer.reference.exists())
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()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
code-vacc-fundingSource: 當StockType = 0(庫存),則收費類型fundingSource必填
code-vacc-manufacturer: 當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... StockType S 1..1 CodeableConcept 庫存類別
URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type
Binding: CDC-VACC系統-庫存類別值集 (required)
... identifier S 1..* Identifier Business identifier
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: CDC-VACC系統-疫苗值集 (required)
... Slices for occurrence[x] 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime 接種日期
... manufacturer 0..1 Reference(疫苗廠牌(Brand Of Vaccive Organization VACC)) 疫苗廠牌
... lotNumber S 0..1 string 疫苗批號
... doseQuantity S 1..1 SimpleQuantity 疫苗數量
... performer S 1..* BackboneElement Who performed event
.... actor 1..1 Reference(接種機構、發證機構(Vaccination Organization VACC)) 接種機構
... note S 0..* Annotation travelDateKey
... reasonReference S 0..1 Reference(個案出境資料(Observation VACC)) Why immunization occurred
... fundingSource 0..1 CodeableConcept 收費類型
Binding: ImmunizationFundingSource (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCoderequiredTWVACCVaccineCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values
from this IG
Immunization.fundingSourcerequiredImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
code-vacc-fundingSourceerrorImmunization當StockType = 0(庫存),則收費類型fundingSource必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (fundingSource.exists())
code-vacc-manufacturererrorImmunization當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '1').exists()) implies (manufacturer.reference.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
code-vacc-fundingSource: 當StockType = 0(庫存),則收費類型fundingSource必填
code-vacc-manufacturer: 當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... StockType S 1..1 CodeableConcept 庫存類別
URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type
Binding: CDC-VACC系統-庫存類別值集 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CDC-VACC系統-疫苗值集 (required)
... patient Σ 1..1 Reference(個案資料(Patient VACC)) Who was immunized
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime 接種日期
... manufacturer 0..1 Reference(疫苗廠牌(Brand Of Vaccive Organization VACC)) 疫苗廠牌
... lotNumber S 0..1 string 疫苗批號
... doseQuantity S 1..1 SimpleQuantity 疫苗數量
... performer SΣ 1..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(接種機構、發證機構(Vaccination Organization VACC)) 接種機構
... note SΣ 0..* Annotation travelDateKey
... reasonReference S 0..1 Reference(個案出境資料(Observation VACC)) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... fundingSource 0..1 CodeableConcept 收費類型
Binding: ImmunizationFundingSource (required)

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.vaccineCoderequiredTWVACCVaccineCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values
from this IG
Immunization.fundingSourcerequiredImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
code-vacc-fundingSourceerrorImmunization當StockType = 0(庫存),則收費類型fundingSource必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (fundingSource.exists())
code-vacc-manufacturererrorImmunization當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '1').exists()) implies (manufacturer.reference.exists())
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
code-vacc-fundingSource: 當StockType = 0(庫存),則收費類型fundingSource必填
code-vacc-manufacturer: 當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... StockType S 1..1 CodeableConcept 庫存類別
URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type
Binding: CDC-VACC系統-庫存類別值集 (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

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

... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CDC-VACC系統-疫苗值集 (required)
... patient Σ 1..1 Reference(個案資料(Patient VACC)) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime 接種日期
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 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 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(疫苗廠牌(Brand Of Vaccive Organization VACC)) 疫苗廠牌
... lotNumber S 0..1 string 疫苗批號
... 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 S 1..1 SimpleQuantity 疫苗數量
... performer SΣ 1..* 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(接種機構、發證機構(Vaccination Organization VACC)) 接種機構
... note SΣ 0..* Annotation travelDateKey
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference S 0..1 Reference(個案出境資料(Observation VACC)) 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
imm-1: One of documentType or reference SHALL be present
.... 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 收費類型
Binding: ImmunizationFundingSource (required)
... 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(Observation) 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(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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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.vaccineCoderequiredTWVACCVaccineCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
from the FHIR Standard
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourcerequiredImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
code-vacc-fundingSourceerrorImmunization當StockType = 0(庫存),則收費類型fundingSource必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (fundingSource.exists())
code-vacc-manufacturererrorImmunization當stockType = 1(非庫存),則疫苗廠牌manufacturer.reference必填
: (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '1').exists()) implies (manufacturer.reference.exists())
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()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

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

  1. 必須(SHALL) 支援透過查詢參數 _id 查詢所有Patient:
    (如何透過token查詢)
    GET [base]/Immunization?_id=[id]
    GET [base]/Immunization/[id]

    例子:
    (1) GET [base]/Immunization?_id=patient-id-min
    (2) GET [base]/Immunization/patient-id-min

  2. 必須(SHALL) 支援透過查詢參數 patient 查詢所有Immunization:
    (如何透過reference查詢)
    GET [base]/Immunization?patient=Patient/[id]
    GET [base]/Immunization?patient.identifier=[code]&patient.birthdate=[date]&vaccine-code.system=[system]

    例子:
    (1) GET [base]/Immunization?patient=Patient/patient-passport-min
    (2) GET [base]/Immunization?patient.identifier=S123456789&patient.birthdate=1983-02-15&vaccine-code.system=https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-vaccine-code-values