旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引
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: 證書資料(Composition VACC)

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

此證書資料(Composition VACC)Profile 說明本IG如何進一步定義定義臺灣核心-臨床文件架構(TW Core Composition) Profile以呈現接種疫苗/開立藥品紀錄的證書資料。

Usage:

Formal Views of Profile Content

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

This structure is derived from TWCoreComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C 0..* TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。
code-newissue: 當type = Newissue,則identifier必填
code-addissue: 當type = Addissue,則identifier必填
... identifier C 0..1 Identifier 證書編號(7碼),例如:9999999
identifier-format: 證書編號(7)
... type 1..1 CodeableConceptTW Composition的種類(如果可能請使用LOINC)
Binding: CDC-VACC系統-1-證書類型值集 (required)
... subject 1..1 Reference(個案資料(Patient VACC)) Composition是關於誰和/或什麼
... author 1..* Reference(接種機構(Vaccination Organization VACC/NIIS)) 發證機構
... title 1..1 string 人類可讀的名稱/標題
Required Pattern: 疫苗接種證書資料
... section
.... entry 1..* Reference(VACC系統疫苗紀錄(Immunization VACC)) 提供一個連結用於參照或查看支持此小節內容的資料

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.typerequiredTWVACCOneCertificateType
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-one-certificate-type-values
from this IG

Constraints

IdGradePath(s)DetailsRequirements
code-addissueerrorComposition當type = Addissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Addissue')) implies (identifier.exists())
code-newissueerrorComposition當type = Newissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Newissue')) implies (identifier.exists())
identifier-formaterrorComposition.identifier證書編號(7)
: value.matches('^[0-9]{7}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C 0..* TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。
code-newissue: 當type = Newissue,則identifier必填
code-addissue: 當type = Addissue,則identifier必填
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC 0..1 Identifier 證書編號(7碼),例如:9999999
identifier-format: 證書編號(7)
... type S 1..1 CodeableConceptTW Composition的種類(如果可能請使用LOINC)
Binding: CDC-VACC系統-1-證書類型值集 (required)
... subject SΣ 1..1 Reference(個案資料(Patient VACC)) Composition是關於誰和/或什麼
... date SΣ 1..1 dateTime 發證日期,格式:西元年-月-日,例如:2024-04-05。
... author SΣ 1..* Reference(接種機構(Vaccination Organization VACC/NIIS)) 發證機構
... title SΣ 1..1 string 人類可讀的名稱/標題
Required Pattern: 疫苗接種證書資料
... attester S 0..* BackboneElement 證明Composition的準確性
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。

... custodian SΣ 0..1 Reference(TW Core Organization) 維護Composition的機構
... section SC 0..* BackboneElement Composition被分成一個或數個小節
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 0..1 CodeableConceptTW 小節分類(建議)
Binding: DocumentSectionCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... text SC 0..1 Narrative 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。
.... entry SC 1..* Reference(VACC系統疫苗紀錄(Immunization VACC)) 提供一個連結用於參照或查看支持此小節內容的資料

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredTWVACCOneCertificateType
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-one-certificate-type-values
from this IG
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.section.codeextensibleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
code-addissueerrorComposition當type = Addissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Addissue')) implies (identifier.exists())
code-newissueerrorComposition當type = Newissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Newissue')) implies (identifier.exists())
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA 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()
identifier-formaterrorComposition.identifier證書編號(7)
: value.matches('^[0-9]{7}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C 0..* TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。
code-newissue: 當type = Newissue,則identifier必填
code-addissue: 當type = Addissue,則identifier必填
... id Σ 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。
... meta Σ 0..1 Meta 此Composition Resource的metadata
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... text 0..1 Narrative Composition Resource之內容摘要以供人閱讀
... contained 0..* Resource 內嵌的(contained)、行內的Resources
... extension 0..* Extension 擴充的資料項目
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC 0..1 Identifier 證書編號(7碼),例如:9999999
identifier-format: 證書編號(7)
... status ?!SΣ 1..1 code registered | partial | preliminary | final | amended | corrected +
Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。

... type S 1..1 CodeableConceptTW Composition的種類(如果可能請使用LOINC)
Binding: CDC-VACC系統-1-證書類型值集 (required)
... category 0..* CodeableConceptTW Composition的分類
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... subject SΣ 1..1 Reference(個案資料(Patient VACC)) Composition是關於誰和/或什麼
... encounter Σ 0..1 Reference(TW Core Encounter) Composition的情境
... date SΣ 1..1 dateTime 發證日期,格式:西元年-月-日,例如:2024-04-05。
... author SΣ 1..* Reference(接種機構(Vaccination Organization VACC/NIIS)) 發證機構
... title SΣ 1..1 string 人類可讀的名稱/標題
Required Pattern: 疫苗接種證書資料
... confidentiality Σ 0..1 code 根據特定技術領域的定義
Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。

... attester S 0..* BackboneElement 證明Composition的準確性
.... 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
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。

.... time 0..1 dateTime 此Composition被證明的時間
.... party 0..1 Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 誰證明了此Composition
... custodian SΣ 0..1 Reference(TW Core Organization) 維護Composition的機構
... relatesTo 0..* BackboneElement 與其他Composition/文件之間的關係
.... 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
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。

.... target[x] 1..1 此關係的目標文件
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 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
.... code 0..* CodeableConceptTW 此代碼表代表了正在被記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


.... period Σ 0..1 Period 文件所涵蓋的時間區間
.... detail Σ 0..* Reference(Resource) 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。
... section SC 0..* BackboneElement Composition被分成一個或數個小節
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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
.... title 0..1 string 小節標籤(例如:目錄ToC)
.... code S 0..1 CodeableConceptTW 小節分類(建議)
Binding: DocumentSectionCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... author 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | RelatedPerson) 誰和/或什麼人撰寫了該小節
.... focus 0..1 Reference(Resource) 當小節與composition描述的對象無關時,此小節是關於誰/什麼。
.... text SC 0..1 Narrative 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。
.... mode 0..1 code 適用於此小節的處理模式
Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。

.... orderedBy 0..1 CodeableConceptTW 小節條目的順序
Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

.... entry SC 1..* Reference(VACC系統疫苗紀錄(Immunization VACC)) 提供一個連結用於參照或查看支持此小節內容的資料
.... emptyReason 0..1 CodeableConceptTW 為什麼此小節是空的原因
Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

.... section C 0..* See section (Composition) 嵌套的小節

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredTWVACCOneCertificateType
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-one-certificate-type-values
from this IG
Composition.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeextensibleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
code-addissueerrorComposition當type = Addissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Addissue')) implies (identifier.exists())
code-newissueerrorComposition當type = Newissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Newissue')) implies (identifier.exists())
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA 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()
identifier-formaterrorComposition.identifier證書編號(7)
: value.matches('^[0-9]{7}$')

Differential View

This structure is derived from TWCoreComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C 0..* TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。
code-newissue: 當type = Newissue,則identifier必填
code-addissue: 當type = Addissue,則identifier必填
... identifier C 0..1 Identifier 證書編號(7碼),例如:9999999
identifier-format: 證書編號(7)
... type 1..1 CodeableConceptTW Composition的種類(如果可能請使用LOINC)
Binding: CDC-VACC系統-1-證書類型值集 (required)
... subject 1..1 Reference(個案資料(Patient VACC)) Composition是關於誰和/或什麼
... author 1..* Reference(接種機構(Vaccination Organization VACC/NIIS)) 發證機構
... title 1..1 string 人類可讀的名稱/標題
Required Pattern: 疫苗接種證書資料
... section
.... entry 1..* Reference(VACC系統疫苗紀錄(Immunization VACC)) 提供一個連結用於參照或查看支持此小節內容的資料

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.typerequiredTWVACCOneCertificateType
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-one-certificate-type-values
from this IG

Constraints

IdGradePath(s)DetailsRequirements
code-addissueerrorComposition當type = Addissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Addissue')) implies (identifier.exists())
code-newissueerrorComposition當type = Newissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Newissue')) implies (identifier.exists())
identifier-formaterrorComposition.identifier證書編號(7)
: value.matches('^[0-9]{7}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C 0..* TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。
code-newissue: 當type = Newissue,則identifier必填
code-addissue: 當type = Addissue,則identifier必填
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC 0..1 Identifier 證書編號(7碼),例如:9999999
identifier-format: 證書編號(7)
... type S 1..1 CodeableConceptTW Composition的種類(如果可能請使用LOINC)
Binding: CDC-VACC系統-1-證書類型值集 (required)
... subject SΣ 1..1 Reference(個案資料(Patient VACC)) Composition是關於誰和/或什麼
... date SΣ 1..1 dateTime 發證日期,格式:西元年-月-日,例如:2024-04-05。
... author SΣ 1..* Reference(接種機構(Vaccination Organization VACC/NIIS)) 發證機構
... title SΣ 1..1 string 人類可讀的名稱/標題
Required Pattern: 疫苗接種證書資料
... attester S 0..* BackboneElement 證明Composition的準確性
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。

... custodian SΣ 0..1 Reference(TW Core Organization) 維護Composition的機構
... section SC 0..* BackboneElement Composition被分成一個或數個小節
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 0..1 CodeableConceptTW 小節分類(建議)
Binding: DocumentSectionCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... text SC 0..1 Narrative 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。
.... entry SC 1..* Reference(VACC系統疫苗紀錄(Immunization VACC)) 提供一個連結用於參照或查看支持此小節內容的資料

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredTWVACCOneCertificateType
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-one-certificate-type-values
from this IG
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.section.codeextensibleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
code-addissueerrorComposition當type = Addissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Addissue')) implies (identifier.exists())
code-newissueerrorComposition當type = Newissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Newissue')) implies (identifier.exists())
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA 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()
identifier-formaterrorComposition.identifier證書編號(7)
: value.matches('^[0-9]{7}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C 0..* TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。
code-newissue: 當type = Newissue,則identifier必填
code-addissue: 當type = Addissue,則identifier必填
... id Σ 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。
... meta Σ 0..1 Meta 此Composition Resource的metadata
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... text 0..1 Narrative Composition Resource之內容摘要以供人閱讀
... contained 0..* Resource 內嵌的(contained)、行內的Resources
... extension 0..* Extension 擴充的資料項目
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC 0..1 Identifier 證書編號(7碼),例如:9999999
identifier-format: 證書編號(7)
... status ?!SΣ 1..1 code registered | partial | preliminary | final | amended | corrected +
Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。

... type S 1..1 CodeableConceptTW Composition的種類(如果可能請使用LOINC)
Binding: CDC-VACC系統-1-證書類型值集 (required)
... category 0..* CodeableConceptTW Composition的分類
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... subject SΣ 1..1 Reference(個案資料(Patient VACC)) Composition是關於誰和/或什麼
... encounter Σ 0..1 Reference(TW Core Encounter) Composition的情境
... date SΣ 1..1 dateTime 發證日期,格式:西元年-月-日,例如:2024-04-05。
... author SΣ 1..* Reference(接種機構(Vaccination Organization VACC/NIIS)) 發證機構
... title SΣ 1..1 string 人類可讀的名稱/標題
Required Pattern: 疫苗接種證書資料
... confidentiality Σ 0..1 code 根據特定技術領域的定義
Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。

... attester S 0..* BackboneElement 證明Composition的準確性
.... 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
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。

.... time 0..1 dateTime 此Composition被證明的時間
.... party 0..1 Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 誰證明了此Composition
... custodian SΣ 0..1 Reference(TW Core Organization) 維護Composition的機構
... relatesTo 0..* BackboneElement 與其他Composition/文件之間的關係
.... 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
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。

.... target[x] 1..1 此關係的目標文件
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 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
.... code 0..* CodeableConceptTW 此代碼表代表了正在被記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


.... period Σ 0..1 Period 文件所涵蓋的時間區間
.... detail Σ 0..* Reference(Resource) 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。
... section SC 0..* BackboneElement Composition被分成一個或數個小節
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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
.... title 0..1 string 小節標籤(例如:目錄ToC)
.... code S 0..1 CodeableConceptTW 小節分類(建議)
Binding: DocumentSectionCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... author 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | RelatedPerson) 誰和/或什麼人撰寫了該小節
.... focus 0..1 Reference(Resource) 當小節與composition描述的對象無關時,此小節是關於誰/什麼。
.... text SC 0..1 Narrative 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。
.... mode 0..1 code 適用於此小節的處理模式
Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。

.... orderedBy 0..1 CodeableConceptTW 小節條目的順序
Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

.... entry SC 1..* Reference(VACC系統疫苗紀錄(Immunization VACC)) 提供一個連結用於參照或查看支持此小節內容的資料
.... emptyReason 0..1 CodeableConceptTW 為什麼此小節是空的原因
Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

.... section C 0..* See section (Composition) 嵌套的小節

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredTWVACCOneCertificateType
https://vacc.cdc.gov.tw/vacc/ValueSet/twvacc-one-certificate-type-values
from this IG
Composition.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeextensibleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
code-addissueerrorComposition當type = Addissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Addissue')) implies (identifier.exists())
code-newissueerrorComposition當type = Newissue,則identifier必填
: (type.coding.exists(system='https://vacc.cdc.gov.tw/vacc/CodeSystem/twvacc-certificate-type-values' and code='Newissue')) implies (identifier.exists())
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA 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()
identifier-formaterrorComposition.identifier證書編號(7)
: value.matches('^[0-9]{7}$')

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

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

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

    例子: (1) GET [base]/Composition?_id=composition-newissue-min
    (2) GET [base]/Composition/composition-newissue-min

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

    例子:
    (1) GET [base]/Composition?patient=Patient/patient-passport-min
    (2) GET [base]/Composition?patient.identifier=888800371&patient.birthdate=1983-02-15