• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
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)
patient		1..1	Reference(個案資料（Patient VACC）)	Who was immunized
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 Vaccine Organization VACC/NIIS）)	疫苗廠牌
lotNumber	S	0..1	string	疫苗批號
doseQuantity	S	1..1	SimpleQuantity	疫苗數量
performer	S	0..*	BackboneElement	Who performed event
actor		1..1	Reference(接種機構（Vaccination Organization VACC/NIIS）)	接種機構
note	S	0..*	Annotation	TravelDataKey
reasonReference	S	0..1	Reference(個案出境資料（Observation VACC）)	Why immunization occurred
fundingSource		0..1	CodeableConcept	收費類型 Binding: ImmunizationFundingSource (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	required	TWVACCVaccineCode https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values from this IG
Immunization.fundingSource	required	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
code-vacc-fundingSource	error	Immunization	當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-manufacturer	error	Immunization	當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())

Name	Flags	Card.	Type	Description & Constraints
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
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.
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 Vaccine Organization VACC/NIIS）)	疫苗廠牌
lotNumber	S	0..1	string	疫苗批號
doseQuantity	S	1..1	SimpleQuantity	疫苗數量
performer	SΣ	0..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	1..1	Reference(接種機構（Vaccination Organization VACC/NIIS）)	接種機構
note	SΣ	0..*	Annotation	TravelDataKey
reasonReference	S	0..1	Reference(個案出境資料（Observation VACC）)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
fundingSource		0..1	CodeableConcept	收費類型 Binding: ImmunizationFundingSource (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	required	TWVACCVaccineCode https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values from this IG
Immunization.fundingSource	required	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
code-vacc-fundingSource	error	Immunization	當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-manufacturer	error	Immunization	當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-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()

Name	Flags	Card.	Type	Description & Constraints
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 Bindings Purpose 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 Vaccine Organization VACC/NIIS）)	疫苗廠牌
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Σ	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(接種機構（Vaccination Organization VACC/NIIS）)	接種機構
note	SΣ	0..*	Annotation	TravelDataKey
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	required	TWVACCVaccineCode https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values from this IG
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	required	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
code-vacc-fundingSource	error	Immunization	當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-manufacturer	error	Immunization	當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-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()

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
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)
patient		1..1	Reference(個案資料（Patient VACC）)	Who was immunized
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 Vaccine Organization VACC/NIIS）)	疫苗廠牌
lotNumber	S	0..1	string	疫苗批號
doseQuantity	S	1..1	SimpleQuantity	疫苗數量
performer	S	0..*	BackboneElement	Who performed event
actor		1..1	Reference(接種機構（Vaccination Organization VACC/NIIS）)	接種機構
note	S	0..*	Annotation	TravelDataKey
reasonReference	S	0..1	Reference(個案出境資料（Observation VACC）)	Why immunization occurred
fundingSource		0..1	CodeableConcept	收費類型 Binding: ImmunizationFundingSource (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	required	TWVACCVaccineCode https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values from this IG
Immunization.fundingSource	required	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
code-vacc-fundingSource	error	Immunization	當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-manufacturer	error	Immunization	當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

Name	Flags	Card.	Type	Description & Constraints
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
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.
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 Vaccine Organization VACC/NIIS）)	疫苗廠牌
lotNumber	S	0..1	string	疫苗批號
doseQuantity	S	1..1	SimpleQuantity	疫苗數量
performer	SΣ	0..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	1..1	Reference(接種機構（Vaccination Organization VACC/NIIS）)	接種機構
note	SΣ	0..*	Annotation	TravelDataKey
reasonReference	S	0..1	Reference(個案出境資料（Observation VACC）)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
fundingSource		0..1	CodeableConcept	收費類型 Binding: ImmunizationFundingSource (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	required	TWVACCVaccineCode https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values from this IG
Immunization.fundingSource	required	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
code-vacc-fundingSource	error	Immunization	當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-manufacturer	error	Immunization	當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-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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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 Bindings Purpose 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 Vaccine Organization VACC/NIIS）)	疫苗廠牌
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Σ	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(接種機構（Vaccination Organization VACC/NIIS）)	接種機構
note	SΣ	0..*	Annotation	TravelDataKey
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	required	TWVACCVaccineCode https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-vaccine-code-values from this IG
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	required	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
code-vacc-fundingSource	error	Immunization	當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-manufacturer	error	Immunization	當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-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()

This structure is derived from Immunization

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• 個案資料（Patient VACC） (https://vacc.cdc.gov.tw/vacc/StructureDefinition/patient-vacc)
• 疫苗/藥品廠牌（Brand Of Vaccine Organization VACC/NIIS） (https://vacc.cdc.gov.tw/vacc/StructureDefinition/brand-organization-vacc)
• 接種機構（Vaccination Organization VACC/NIIS） (https://vacc.cdc.gov.tw/vacc/StructureDefinition/vaccination-organization-vacc)
• 個案出境資料（Observation VACC） (https://vacc.cdc.gov.tw/vacc/StructureDefinition/observation-vacc)

Extensions

This structure refers to these extensions:

• https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.occurrence[x]

以下概述了此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

   • 回覆內容請參考CDC回覆院所查詢個案的接種疫苗紀錄、給藥紀錄及證書資料