臺灣疫苗接種或開立藥品紀錄上傳實作指引
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: 藥品資料(Medication VACC)

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

此藥品資料(Medication VACC)Profile 說明本IG如何進一步定義臺灣核心-藥品(TW Core Medication) Profile以呈現接種疫苗/開立藥品紀錄之藥品資料。

Usage:

Formal Views of Profile Content

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

This structure is derived from TWCoreMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication TWCoreMedication
... code
.... coding 1..* CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
.... Slices for coding Content/Rules for all slices
..... coding:twvacc-vaccine-code S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Binding: CDC-VACC系統-藥品值集 (required)
... batch
.... lotNumber S 1..1 string 藥品的批號

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.code.coding:twvacc-vaccine-coderequiredTWVACCMedicationCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-medication-code-values
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* TWCoreMedication 藥品的定義
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... code S 0..1 CodeableConceptTW 指明這種藥品的代碼。
Binding: SNOMEDCTMedicationCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... Slices for coding S 1..* CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:fda-medication-tw S 0..1 CodingTW 此為臺灣食品藥物管理署(TFDA)維護之藥品代碼,涵蓋範圍相對完整,可免費使用,可優先選用此代碼。
Binding: 臺灣食藥署藥品及醫療器材代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:nhi-medication-tw S 0..1 CodingTW 此為中央健康保險署(NHI)維護之藥品代碼,主要針對申報使用,更新頻率相對頻繁,可免費使用,可依情境選用此代碼。
Binding: 臺灣健保署健保用藥品項代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:rxnorm-medication-us-core S 0..1 CodingTW RxNorm為美國Unified Medical Language System®中的藥品代碼,取得UMLS®授權即可免費使用,可依情境選用此代碼。
Binding: RxNorm藥品代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:atc-medication-code S 0..1 CodingTW ATC代碼的版權為世界衛生組織(WHO)Collaborating Centre for Drug Statistics Methodology,可免費使用,可依情境選用此代碼。
Binding: 臺灣食藥署藥品藥理治療分類ATC碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:snomedct-medication-codes S 0..1 CodingTW 此為SNOMED CT代碼,若機構已有購買相關授權,亦可使用。
Binding: SNOMEDCTMedicationCodes (required): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


..... coding:twvacc-vaccine-code S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Binding: CDC-VACC系統-藥品值集 (required)
.... text SΣ 0..1 string 概念的文字表示法
... form S 0..1 CodeableConceptTW powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... Slices for coding S 1..* CodingTW powder | tablets | capsule + 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:v3-orderableDrugForm S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: 藥品劑型值集 (required): 應填入所綁定值集中的其中一個代碼


..... coding:snomed-sct-form-codes S 0..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: SNOMEDCTFormCodes (required): 應填入所綁定值集中的其中一個代碼


.... text SΣ 0..1 string 概念的文字表示法
... batch 0..1 BackboneElement 關於包裝藥品的細節
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber S 1..1 string 藥品的批號

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:fda-medication-twrequiredTWMedicationFDA
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-fda-tw
Medication.code.coding:nhi-medication-twrequiredTWMedicationNHI
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-nhi-tw
Medication.code.coding:rxnorm-medication-us-corerequiredTWMedicationRXNORM
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-rxnorm-tw
Medication.code.coding:atc-medication-coderequiredTWMedcationATC
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medcation-atc-tw
Medication.code.coding:snomedct-medication-codesrequiredSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:twvacc-vaccine-coderequiredTWVACCMedicationCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-medication-code-values
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.form.coding:v3-orderableDrugFormrequiredOrderableDrugForm
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/v3-orderableDrugForm
Medication.form.coding:snomed-sct-form-codesrequiredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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
.. Medication 0..* TWCoreMedication 藥品的定義
... id Σ 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的Medication紀錄,通常又稱為邏輯性ID。
... meta Σ 0..1 Meta 此Medication Resource的metadata
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... text 0..1 Narrative Medication Resource之內容摘要以供人閱讀
... contained 0..* Resource 內嵌的(contained)、行內的Resources
... extension 0..* Extension 擴充的資料項目
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier Σ 0..* Identifier 此藥品的業務用識別碼
... code S 0..1 CodeableConceptTW 指明這種藥品的代碼。
Binding: SNOMEDCTMedicationCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
.... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
.... Slices for coding S 1..* CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:fda-medication-tw S 0..1 CodingTW 此為臺灣食品藥物管理署(TFDA)維護之藥品代碼,涵蓋範圍相對完整,可免費使用,可優先選用此代碼。
Binding: 臺灣食藥署藥品及醫療器材代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:nhi-medication-tw S 0..1 CodingTW 此為中央健康保險署(NHI)維護之藥品代碼,主要針對申報使用,更新頻率相對頻繁,可免費使用,可依情境選用此代碼。
Binding: 臺灣健保署健保用藥品項代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:rxnorm-medication-us-core S 0..1 CodingTW RxNorm為美國Unified Medical Language System®中的藥品代碼,取得UMLS®授權即可免費使用,可依情境選用此代碼。
Binding: RxNorm藥品代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:atc-medication-code S 0..1 CodingTW ATC代碼的版權為世界衛生組織(WHO)Collaborating Centre for Drug Statistics Methodology,可免費使用,可依情境選用此代碼。
Binding: 臺灣食藥署藥品藥理治療分類ATC碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:snomedct-medication-codes S 0..1 CodingTW 此為SNOMED CT代碼,若機構已有購買相關授權,亦可使用。
Binding: SNOMEDCTMedicationCodes (required): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


..... coding:twvacc-vaccine-code S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Binding: CDC-VACC系統-藥品值集 (required)
.... text SΣ 0..1 string 概念的文字表示法
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): 應填入所綁定值集中的其中一個代碼

... manufacturer Σ 0..1 Reference(TW Core Organization Company) 此藥品的製造商
... form S 0..1 CodeableConceptTW powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
.... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
.... Slices for coding S 1..* CodingTW powder | tablets | capsule + 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:v3-orderableDrugForm S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: 藥品劑型值集 (required): 應填入所綁定值集中的其中一個代碼


..... coding:snomed-sct-form-codes S 0..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: SNOMEDCTFormCodes (required): 應填入所綁定值集中的其中一個代碼


.... text SΣ 0..1 string 概念的文字表示法
... amount Σ 0..1 Ratio 每包裝的藥品數量或容量
... ingredient 0..* BackboneElement 有使用或沒有使用的藥品成份
.... 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
.... item[x] 1..1 實際的成份或內容物
..... itemCodeableConcept CodeableConcept(CodeableConceptTW)
..... itemReference Reference(TW Core Medication | Substance)
.... isActive 0..1 boolean 有效成份指標
.... strength 0..1 Ratio 所含成份的劑量
... batch 0..1 BackboneElement 關於包裝藥品的細節
.... 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
.... lotNumber S 1..1 string 藥品的批號
.... expirationDate 0..1 dateTime 有效期限

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:fda-medication-twrequiredTWMedicationFDA
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-fda-tw
Medication.code.coding:nhi-medication-twrequiredTWMedicationNHI
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-nhi-tw
Medication.code.coding:rxnorm-medication-us-corerequiredTWMedicationRXNORM
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-rxnorm-tw
Medication.code.coding:atc-medication-coderequiredTWMedcationATC
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medcation-atc-tw
Medication.code.coding:snomedct-medication-codesrequiredSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:twvacc-vaccine-coderequiredTWVACCMedicationCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-medication-code-values
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.form.coding:v3-orderableDrugFormrequiredOrderableDrugForm
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/v3-orderableDrugForm
Medication.form.coding:snomed-sct-form-codesrequiredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()

This structure is derived from TWCoreMedication

Differential View

This structure is derived from TWCoreMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication TWCoreMedication
... code
.... coding 1..* CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
.... Slices for coding Content/Rules for all slices
..... coding:twvacc-vaccine-code S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Binding: CDC-VACC系統-藥品值集 (required)
... batch
.... lotNumber S 1..1 string 藥品的批號

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.code.coding:twvacc-vaccine-coderequiredTWVACCMedicationCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-medication-code-values
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* TWCoreMedication 藥品的定義
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... code S 0..1 CodeableConceptTW 指明這種藥品的代碼。
Binding: SNOMEDCTMedicationCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... Slices for coding S 1..* CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:fda-medication-tw S 0..1 CodingTW 此為臺灣食品藥物管理署(TFDA)維護之藥品代碼,涵蓋範圍相對完整,可免費使用,可優先選用此代碼。
Binding: 臺灣食藥署藥品及醫療器材代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:nhi-medication-tw S 0..1 CodingTW 此為中央健康保險署(NHI)維護之藥品代碼,主要針對申報使用,更新頻率相對頻繁,可免費使用,可依情境選用此代碼。
Binding: 臺灣健保署健保用藥品項代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:rxnorm-medication-us-core S 0..1 CodingTW RxNorm為美國Unified Medical Language System®中的藥品代碼,取得UMLS®授權即可免費使用,可依情境選用此代碼。
Binding: RxNorm藥品代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:atc-medication-code S 0..1 CodingTW ATC代碼的版權為世界衛生組織(WHO)Collaborating Centre for Drug Statistics Methodology,可免費使用,可依情境選用此代碼。
Binding: 臺灣食藥署藥品藥理治療分類ATC碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:snomedct-medication-codes S 0..1 CodingTW 此為SNOMED CT代碼,若機構已有購買相關授權,亦可使用。
Binding: SNOMEDCTMedicationCodes (required): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


..... coding:twvacc-vaccine-code S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Binding: CDC-VACC系統-藥品值集 (required)
.... text SΣ 0..1 string 概念的文字表示法
... form S 0..1 CodeableConceptTW powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... Slices for coding S 1..* CodingTW powder | tablets | capsule + 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:v3-orderableDrugForm S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: 藥品劑型值集 (required): 應填入所綁定值集中的其中一個代碼


..... coding:snomed-sct-form-codes S 0..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: SNOMEDCTFormCodes (required): 應填入所綁定值集中的其中一個代碼


.... text SΣ 0..1 string 概念的文字表示法
... batch 0..1 BackboneElement 關於包裝藥品的細節
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber S 1..1 string 藥品的批號

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:fda-medication-twrequiredTWMedicationFDA
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-fda-tw
Medication.code.coding:nhi-medication-twrequiredTWMedicationNHI
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-nhi-tw
Medication.code.coding:rxnorm-medication-us-corerequiredTWMedicationRXNORM
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-rxnorm-tw
Medication.code.coding:atc-medication-coderequiredTWMedcationATC
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medcation-atc-tw
Medication.code.coding:snomedct-medication-codesrequiredSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:twvacc-vaccine-coderequiredTWVACCMedicationCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-medication-code-values
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.form.coding:v3-orderableDrugFormrequiredOrderableDrugForm
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/v3-orderableDrugForm
Medication.form.coding:snomed-sct-form-codesrequiredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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
.. Medication 0..* TWCoreMedication 藥品的定義
... id Σ 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的Medication紀錄,通常又稱為邏輯性ID。
... meta Σ 0..1 Meta 此Medication Resource的metadata
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... text 0..1 Narrative Medication Resource之內容摘要以供人閱讀
... contained 0..* Resource 內嵌的(contained)、行內的Resources
... extension 0..* Extension 擴充的資料項目
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier Σ 0..* Identifier 此藥品的業務用識別碼
... code S 0..1 CodeableConceptTW 指明這種藥品的代碼。
Binding: SNOMEDCTMedicationCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
.... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
.... Slices for coding S 1..* CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:fda-medication-tw S 0..1 CodingTW 此為臺灣食品藥物管理署(TFDA)維護之藥品代碼,涵蓋範圍相對完整,可免費使用,可優先選用此代碼。
Binding: 臺灣食藥署藥品及醫療器材代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:nhi-medication-tw S 0..1 CodingTW 此為中央健康保險署(NHI)維護之藥品代碼,主要針對申報使用,更新頻率相對頻繁,可免費使用,可依情境選用此代碼。
Binding: 臺灣健保署健保用藥品項代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:rxnorm-medication-us-core S 0..1 CodingTW RxNorm為美國Unified Medical Language System®中的藥品代碼,取得UMLS®授權即可免費使用,可依情境選用此代碼。
Binding: RxNorm藥品代碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:atc-medication-code S 0..1 CodingTW ATC代碼的版權為世界衛生組織(WHO)Collaborating Centre for Drug Statistics Methodology,可免費使用,可依情境選用此代碼。
Binding: 臺灣食藥署藥品藥理治療分類ATC碼值集 (required): 應填入所綁定值集中的其中一個代碼。


..... coding:snomedct-medication-codes S 0..1 CodingTW 此為SNOMED CT代碼,若機構已有購買相關授權,亦可使用。
Binding: SNOMEDCTMedicationCodes (required): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


..... coding:twvacc-vaccine-code S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼。此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Binding: CDC-VACC系統-藥品值集 (required)
.... text SΣ 0..1 string 概念的文字表示法
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): 應填入所綁定值集中的其中一個代碼

... manufacturer Σ 0..1 Reference(TW Core Organization Company) 此藥品的製造商
... form S 0..1 CodeableConceptTW powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。

.... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
.... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
.... Slices for coding S 1..* CodingTW powder | tablets | capsule + 此資料項目為可擴充綁定預設國際標準值集,但實作者可視實務專案需求只綁定以下slices中的任一值集。目前未只限定綁定預設值集是因為尚無slice值集與預設國際標準值集的代碼對應表,待後續有相對的代碼對應表後將建議採用國際標準值集作為唯一綁定值集並針對該值集進行擴充與管理,以利進行跨國與跨系統之資料交換。
Slice: Unordered, Open by pattern:$this
..... coding:v3-orderableDrugForm S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: 藥品劑型值集 (required): 應填入所綁定值集中的其中一個代碼


..... coding:snomed-sct-form-codes S 0..1 CodingTW 由專門術語系統(terminology system)定義的代碼
Binding: SNOMEDCTFormCodes (required): 應填入所綁定值集中的其中一個代碼


.... text SΣ 0..1 string 概念的文字表示法
... amount Σ 0..1 Ratio 每包裝的藥品數量或容量
... ingredient 0..* BackboneElement 有使用或沒有使用的藥品成份
.... 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
.... item[x] 1..1 實際的成份或內容物
..... itemCodeableConcept CodeableConcept(CodeableConceptTW)
..... itemReference Reference(TW Core Medication | Substance)
.... isActive 0..1 boolean 有效成份指標
.... strength 0..1 Ratio 所含成份的劑量
... batch 0..1 BackboneElement 關於包裝藥品的細節
.... 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
.... lotNumber S 1..1 string 藥品的批號
.... expirationDate 0..1 dateTime 有效期限

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:fda-medication-twrequiredTWMedicationFDA
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-fda-tw
Medication.code.coding:nhi-medication-twrequiredTWMedicationNHI
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-nhi-tw
Medication.code.coding:rxnorm-medication-us-corerequiredTWMedicationRXNORM
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medication-rxnorm-tw
Medication.code.coding:atc-medication-coderequiredTWMedcationATC
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/medcation-atc-tw
Medication.code.coding:snomedct-medication-codesrequiredSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:twvacc-vaccine-coderequiredTWVACCMedicationCode
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-medication-code-values
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.form.coding:v3-orderableDrugFormrequiredOrderableDrugForm
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/v3-orderableDrugForm
Medication.form.coding:snomed-sct-form-codesrequiredSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()

This structure is derived from TWCoreMedication

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

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

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

    例子:
    (1) GET [base]/Medication?_id=medication-min
    (2) GET [base]/Medication/medication-min