疫苗/藥品廠牌（Brand Of Vaccine Organization VACC/NIIS） - 旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引 v1.0.0

旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引
1.0.0 - ci-build

This page is part of the 旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引 (v1.0.0: Releases Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: 疫苗/藥品廠牌（Brand Of Vaccine Organization VACC/NIIS）

Official URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/brand-organization-vacc				Version: 1.0.0
Active as of 2024-09-23				Computable Name: BrandOrganizationVACC

此疫苗/藥品廠牌（Brand Of Vaccine Organization VACC/NIIS）Profile 說明本IG如何進一步定義臺灣核心-機構（TW Core Organization）Profile以呈現接種開立藥品紀錄上傳之疫苗廠牌、接種機構、發證機構資料。

Usage:

Use this Resource Profile: 接種疫苗/開立藥品紀錄API-新增多筆紀錄（Bundle Upload POST VACC1-1） and 接種疫苗/開立藥品紀錄API-修改多筆/單筆紀錄（Bundle Upload PUT VACC1-1）
Refer to this Resource Profile: NIIS系統疫苗紀錄（Immunization NIIS）, VACC系統疫苗紀錄（Immunization VACC）, 藥品資料（Medication VACC） and 庫存資料（SupplyDelivery VACC）
Examples for this Resource Profile: GSK, Sanofi Pasteur and Sanofi Pasteur

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from TWCoreOrganization

Name	Card.	Type	Description & Constraints
Organization	0..*	TWCoreOrganization	具有共同目的的一群人或機構
type	1..1	CodeableConceptTW	機構的型別 Binding: CDC-VACC系統-機構種類值集 (required)
coding
system	1..1	uri	專門術語系統（terminology system）的識別 Required Pattern: https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-organization-type-values
code	1..1	code	系統定義的語法之符號 Required Pattern: BrandOfVaccine
name	1..1	string	機構的名稱
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	required	TWVACCOrganizationType (a valid code from CDC-VACC系統-機構種類) `https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-organization-type-values` from this IG

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	TWCoreOrganization	具有共同目的的一群人或機構 org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	創建此內容所依據的一組規則
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	0..*	Identifier	跨多個系統中識別此機構
use	?!SΣ	0..1	code	usual ｜ official ｜ temp ｜ secondary ｜ old （如果知道） Binding: IdentifierUse (required): 如果已知，請說明此識別碼的目的；應填入所綁定值集中的其中一個代碼。
type	S	0..1	CodeableConceptTW	機構識別碼（identifier）的型別說明 Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別，用於決定特定目的所適用的識別碼；應填入所綁定值集中的其中一個代碼。
system	SΣ	0..1	uri	機構識別碼（identifier）的命名空間（namespace），可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	唯一值 Example General: 123456
active	?!SΣ	0..1	boolean	此機構的紀錄是否仍在使用中
type	S	1..1	CodeableConceptTW	機構的型別 Binding: CDC-VACC系統-機構種類值集 (required)
coding	S	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
system	SΣ	1..1	uri	專門術語系統（terminology system）的識別 Required Pattern: https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-organization-type-values
code	SΣ	1..1	code	系統定義的語法之符號 Required Pattern: BrandOfVaccine
display	SΣ	0..1	string	由系統定義的表示法
text	SΣ	0..1	string	概念的文字表示法
name	SΣC	1..1	string	機構的名稱
telecom	SC	0..*	ContactPoint	此機構的詳細聯絡方式。 org-3：一個機構的通訊永遠不可能是「家用」，意即不可能使用「home」。 org-3: The telecom of an organization can never be of use 'home'
system	SΣC	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。
value	SΣ	0..1	string	實際的聯絡方式之細節
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile－此聯絡方式的用途 Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Organization.identifier.type	extensible	TWIdentifierType `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw`
Organization.type	required	TWVACCOrganizationType (a valid code from CDC-VACC系統-機構種類) `https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-organization-type-values` from this IG
Organization.telecom.system	required	ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system\|4.0.1` from the FHIR Standard
Organization.telecom.use	required	ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Description & Constraints

Organization

C

0..*

TWCoreOrganization

具有共同目的的一群人或機構
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one

id

Σ

0..1

id

不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄，通常又稱為邏輯性ID。

Terminology Bindings

Path Conformance ValueSet URI

Organization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Organization.identifier.use

required

IdentifierUse

http://hl7.org/fhir/ValueSet/identifier-use|4.0.1

from the FHIR Standard

Organization.identifier.type

extensible

TWIdentifierType

https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw

Organization.type

required

TWVACCOrganizationType (a valid code from CDC-VACC系統-機構種類)

https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-organization-type-values

from this IG

Organization.telecom.system

required

ContactPointSystem

http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1

from the FHIR Standard

Organization.telecom.use

required

ContactPointUse

http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1

from the FHIR Standard

Organization.contact.purpose

extensible

ContactEntityType

http://hl7.org/fhir/ValueSet/contactentity-type

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from TWCoreOrganization

Summary

Mandatory: 2 elements(2 nested mandatory elements)

Differential View

This structure is derived from TWCoreOrganization

Name	Card.	Type	Description & Constraints
Organization	0..*	TWCoreOrganization	具有共同目的的一群人或機構
type	1..1	CodeableConceptTW	機構的型別 Binding: CDC-VACC系統-機構種類值集 (required)
coding
system	1..1	uri	專門術語系統（terminology system）的識別 Required Pattern: https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-organization-type-values
code	1..1	code	系統定義的語法之符號 Required Pattern: BrandOfVaccine
name	1..1	string	機構的名稱
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	required	TWVACCOrganizationType (a valid code from CDC-VACC系統-機構種類) `https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-organization-type-values` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	TWCoreOrganization	具有共同目的的一群人或機構 org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	創建此內容所依據的一組規則
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	0..*	Identifier	跨多個系統中識別此機構
use	?!SΣ	0..1	code	usual ｜ official ｜ temp ｜ secondary ｜ old （如果知道） Binding: IdentifierUse (required): 如果已知，請說明此識別碼的目的；應填入所綁定值集中的其中一個代碼。
type	S	0..1	CodeableConceptTW	機構識別碼（identifier）的型別說明 Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別，用於決定特定目的所適用的識別碼；應填入所綁定值集中的其中一個代碼。
system	SΣ	0..1	uri	機構識別碼（identifier）的命名空間（namespace），可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	唯一值 Example General: 123456
active	?!SΣ	0..1	boolean	此機構的紀錄是否仍在使用中
type	S	1..1	CodeableConceptTW	機構的型別 Binding: CDC-VACC系統-機構種類值集 (required)
coding	S	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
system	SΣ	1..1	uri	專門術語系統（terminology system）的識別 Required Pattern: https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-organization-type-values
code	SΣ	1..1	code	系統定義的語法之符號 Required Pattern: BrandOfVaccine
display	SΣ	0..1	string	由系統定義的表示法
text	SΣ	0..1	string	概念的文字表示法
name	SΣC	1..1	string	機構的名稱
telecom	SC	0..*	ContactPoint	此機構的詳細聯絡方式。 org-3：一個機構的通訊永遠不可能是「家用」，意即不可能使用「home」。 org-3: The telecom of an organization can never be of use 'home'
system	SΣC	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。
value	SΣ	0..1	string	實際的聯絡方式之細節
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile－此聯絡方式的用途 Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Organization.identifier.type	extensible	TWIdentifierType `https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw`
Organization.type	required	TWVACCOrganizationType (a valid code from CDC-VACC系統-機構種類) `https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-organization-type-values` from this IG
Organization.telecom.system	required	ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system\|4.0.1` from the FHIR Standard
Organization.telecom.use	required	ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Snapshot View

Description & Constraints

Organization

C

0..*

TWCoreOrganization

具有共同目的的一群人或機構
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one

id

Σ

0..1

id

不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄，通常又稱為邏輯性ID。

Terminology Bindings

Path Conformance ValueSet URI

Organization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Organization.identifier.use

required

IdentifierUse

http://hl7.org/fhir/ValueSet/identifier-use|4.0.1

from the FHIR Standard

Organization.identifier.type

extensible

TWIdentifierType

https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw

Organization.type

required

TWVACCOrganizationType (a valid code from CDC-VACC系統-機構種類)

https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-organization-type-values

from this IG

Organization.telecom.system

required

ContactPointSystem

http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1

from the FHIR Standard

Organization.telecom.use

required

ContactPointUse

http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1

from the FHIR Standard

Organization.contact.purpose

extensible

ContactEntityType

http://hl7.org/fhir/ValueSet/contactentity-type

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from TWCoreOrganization

Summary

Mandatory: 2 elements(2 nested mandatory elements)

Other representations of profile: CSV, Excel, Schematron

IG © 2024+ 衛福部疾病管制署. Package tw.gov.mohw.cdc.vacc#1.0.0 based on FHIR 4.0.1. Generated 2024-09-23
Links: Table of Contents | QA Report