臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions
Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Composition-twcore | Version: 0.3.1 | |||
Active as of 2024-10-22 | Computable Name: TWCoreComposition |
此臺灣核心-臨床文件架構(TW Core Composition) Profile說明本IG如何進一步定義FHIR的Composition Resource以呈現臨床文件架構的詳細資料。
一組醫療相關資訊會被整合成一個單一邏輯套件(package),這個套件提供了一個連貫的意義表達,並確立了它自己的上下文。它包含了臨床上的證明,明確指出是誰做出這些陳述。Composition定義了一份文件所需的結構和敘述內容。但是單一個Composition本身並不構成一份完整的文件。反之,Composition必須是在Bundle中的第一個條目,且該Bundle.type
必須是document。此外,從Composition參照的任何其他resources都必須作為後續條目包含在該Bundle中(例如:病人(Patient)、健康照護服務提供者(Practitioner)、就醫紀錄(Encounter)等)。
Composition是FHIR文件(documents.html)的基本結構,這些文件是不可更改的bundle,包含經過認證的敘述。一個單一的邏輯Composition可能與一系列衍生文件相關聯,每一份衍生文件都是該Composition的一個固定副本。 例如:想像您是一位醫生,正在使用一個電子健康紀錄(Electronic Health Record)系統。您為一位病人創建了一份初診報告,這份報告就是使用Composition為報告結構。它包括病人的基本資訊、症狀、初步診斷和治療計劃,當這份報告完成並保存後,它就成為Composition的一個「固定副本」,即不可更改的文件。隨後,每當這位病人回診,您都會基於最初的那份報告來創建新的隨訪記錄。這些隨訪記錄也是Composition的衍生文件,每份都是Composition獨立且不可更改的固定副本。它們可能包括更新的診斷、治療反應和新的治療計劃。
因此,「每一份都是該Composition的固定版本」在這個醫療場景中意味著,無論是原始的初診報告還是基於它創建的任何隨訪記錄,都是獨立且不可更改的文件,保留了創建時的準確資訊。
需要注意的是,Composition在EN13606及FHIR這兩項醫療資訊標準中的概念不完全相同。EN 13606中「Composition」這一專門術語是用來指一次對EHR系統的提交,常見的例子包括包含諮詢記錄、進程紀錄、報告或信件、調查報告、處方單或一組床邊護理觀察紀錄的Composition。在EHR中使用Composition作為經過認證的提交是Composition resource的有效應用。但在FHIR中,通常會進行更細微的更新,並為每次更新提供來源聲明。
臨床文件 Profile(Clinical Document profile)對Composition作進一步定義,使其專門用於指定臨床文件(以符合CDA格式)。關於與CDA的比較,也有進一步的資訊可供參考。
Composition 是用於將資訊分組的結構,這種結構主要用於資訊的持久保存和可證明性。在 FHIR 中,除了 Composition 外,還有其他幾種用於不同目的的分組結構:
Composition resource 在 FHIR 中用於將臨床和行政內容組織成多個小節。每個小節都包含敘事內容,並參照其他 resources 來提供支持數據。在 Composition 的不同小節中,敘事內容得到了小節條目中參照的 resources 的支持。為了形成完整的文件,需要將 Composition resource 與直接或間接關聯到 Composition 的各種 resources 結合起來,並將它們全部匯集到一個 Bundle 中,以便於傳輸和保存。與以下 Composition 參照相關的 resources 必須(SHALL) 包含在這個 Bundle 中。
Composition.subject
(文件描述之對象,通常指病人) Composition.encounter
(就醫事件,通常指此文件所記錄的就醫事實之依據) Composition.author
(作者,撰寫此份文件者) Composition.attester.party
(證明文件正確無誤的參與者,或稱認證者) Composition.custodian
(文件保管機構) Composition.event.detail
(文件描述事件之細節) Composition.section.author
(文件小節之作者) Composition.section.focus
(文件小節之焦點) Composition.section.entry
(文件小節之條目)當 FHIR 中的 Composition 參照其他 resources 時,這些被參照的 resources 是否包含在 Bundle 中,取決於創建這些 resources 的系統。這種決策會在該系統的操作定義中進行記載(例如:透過 $document 操作來說明),或者會依照適用的 profiles 進行具體規定。 簡言之,是否將這些額外的 resources 包括在 Bundle 中,是由創建它的系統根據自己的規則和標準來決定的。FHIR並未規定Bundle是否一定要包含或者一定不要包含這些相關聯的 resources。
每個 Composition 都包含一個資料項目稱為「狀態(status
)」,它用來描述 Composition 內容的當前狀態,這個狀態是從一系列特定的代碼中選擇的。
狀態代碼 | 中文翻譯 | 代碼定義說明 |
---|---|---|
preliminary |
初步的 | 這是一個初步的 composition 或文件(也稱為初始或暫時的)。其內容可能是不完整的或未經驗證的。 |
final |
最終的 | 這版本的 composition 已經被相關人士完整地完成並進行了驗證,且不打算進行進一步的修改或添加。如果有任何後續的更新,將會在該 composition 的新版本中進行。 |
amended |
修正的 | 當一份 composition 被標記為「amended 」,這表示在該 composition 被定義為「final」後,它的內容或所參照的 resources 已經遭到修改(經過編輯或增加)。此外,這份已修改的 composition 也已由授權人員完成並進行了驗證。 |
entered-in-error |
錯誤輸入 | 這個狀態表示該 composition 或文件最初是錯誤地創建或發布的。此一代碼是用來指出整個系列的文件都不應該被認為是有效的。 |
Composition 狀態通常只會按照以下順序變化:從 preliminary
變為 final
,然後可能進一步變為 amended
。值得注意的是,在許多工作流程中,只有 final
狀態的 compositions 被公開使用,而 preliminary
狀態則不會被使用。
在工作流程中,有極少數的 Composition 是完全錯誤地創建的,通常是涉及錯誤的病人或錯誤的作者所寫,而這個錯誤在 Composition 已經被使用或已從中衍生出文件後才被發現。為了解決這類情況,會將錯誤的 Composition 更新為「entered-in-error
」狀態,並可以創建一份新的衍生文件。這表示基於該 Composition 衍生出的所有文件系列都被認為是錯誤創建的。因此,那些接收這些基於已撤回 Composition 衍生的文件的系統應從常規使用中移除之前文件的資料,或採取其他適合行動。雖然系統不必強制提供這種工作流程或支持從已撤回的 Composition 衍生的文件,但它們絕不能忽視「entered-in-error
」的狀態。需要注意的是,那些處理 Composition 或衍生文件但不支援錯誤狀態處理的系統,需要找到其他方法來處理錯誤創建的 Composition;即使這不常見,但有些臨床系統沒有辦法從病人紀錄中移除錯誤資訊,用戶也無法知道這些資訊不適用,這是不安全的。
很多使用這個規範的用戶都對臨床文件架構(Clinical Document Architecture,簡稱 CDA)及其相關的規範有所了解。CDA 是構成 Composition resource 的一個重要設計來源,除此之外,還包括其他 HL7 的文件規範和 EN13606。在 CDA 和 Composition resource 這兩者之間,存在著三個主要的結構上的不同。
identifier
)對應於CDA ClinicalDocument的setId。Composition resource 被封裝在Document結構中,用於交換整個套件(包括Composition及其各部分)。這個被封裝和密封的單位相當於CDA文件,其中Bundle的id在功能上相似於ClinicalDocument的id,但在將 Composition 轉換為CDA文件或反轉過程中,這兩個不會完全對應,因為這涉及到格式間的轉換)。section.entry
參照的其他 resources 。FHIR中沒有一個上下文流動的模型,所以從 Composition 中參照的每一個 resource 都會表達它自己的特定上下文。因此,臨床內容可以安全地從 Composition 中分離出來。另外需要注意的是,代碼列表(例如Composition.status
)和 Composition resource 本身都被對應到HL7 v3和/或CDA標準。這意味著Composition中使用的特定標準資料項目和值,如其狀態代碼,已經適配於這些更廣泛應用的健康資訊標準中。這種映射確保了不同系統和框架間的相容性和可互操作性。
此外,Composition resource 不僅僅參照自身,還被Contract和Procedure等其他FHIR resources 所參照。在FHIR架構中,這種互相參照的設計使得資料項目和資料結構能夠在不同的臨床和行政場景中被重複使用,增強了資料的連接性和一致性。例如:一個特定的 Composition 可能與某個特定的醫療處置或合約直接相關,從而使得這些相關 resources 的關聯和管理變得更加清晰和有序。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。 | |||||
id | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | |||||
meta | 0..1 | Meta | 此Composition Resource的metadata | |||||
implicitRules | 0..1 | uri | 創建此內容所依據的一組規則 | |||||
language | 0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | |||||
identifier | S | 0..1 | Identifier | 不分版本的臨床文件架構(Composition)識別碼。 | ||||
status | S | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | Composition的種類(如果可能請使用LOINC) Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
category | 0..* | CodeableConceptTW | Composition的分類 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | S | 0..1 | Reference(TW Core Patient | Group | Device | Substance | TW Core Location) | Composition是關於誰和/或什麼 | ||||
encounter | 0..1 | Reference(TW Core Encounter) | Composition的情境 | |||||
date | S | 1..1 | dateTime | Composition的編輯時間 | ||||
author | S | 1..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
title | S | 1..1 | string | 人類可讀的名稱/標題 | ||||
confidentiality | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | |||||
attester | S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
time | 0..1 | dateTime | 此Composition被證明的時間 | |||||
party | 0..1 | Reference(TW Core Patient | TW Core RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
custodian | S | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
relatesTo | 0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
target[x] | 1..1 | Identifier, Reference(Composition) | 此關係的目標文件 | |||||
event | 0..* | BackboneElement | 正在記錄的臨床服務 | |||||
code | 0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
period | 0..1 | Period | 文件所涵蓋的時間區間 | |||||
detail | 0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | |||||
section | S | 0..* | BackboneElement | Composition被分成一個或數個小節 | ||||
title | 0..1 | string | 小節標籤(例如:目錄ToC) | |||||
code | S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: LOINC Code Document Section值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
author | 0..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
focus | 0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
text | S | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
mode | 0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
orderedBy | 0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
entry | S | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
emptyReason | 0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
section | 0..* | 嵌套的小節 | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | LOINCDocumentTypehttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code from this IG | ||||
Composition.category | extensible | LOINCDocumentClasshttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes from this IG | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | extensible | LOINCDocumentSectionhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-doc-section-code from this IG | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | ?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
identifier | SΣ | 0..1 | Identifier | 不分版本的臨床文件架構(Composition)識別碼。 | ||||
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | Composition的種類(如果可能請使用LOINC) Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
category | 0..* | CodeableConceptTW | Composition的分類 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | Group | Device | Substance | TW Core Location) | Composition是關於誰和/或什麼 | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | Composition的情境 | ||||
date | SΣ | 1..1 | dateTime | Composition的編輯時間 | ||||
author | SΣ | 1..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
title | SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
confidentiality | Σ | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | ||||
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): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
time | 0..1 | dateTime | 此Composition被證明的時間 | |||||
party | 0..1 | Reference(TW Core Patient | TW Core RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
custodian | SΣ | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
relatesTo | 0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
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 | 正在記錄的臨床服務 | ||||
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 | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 0..1 | string | 小節標籤(例如:目錄ToC) | |||||
code | S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: LOINC Code Document Section值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
author | 0..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core 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 | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
emptyReason | 0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
section | C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | LOINCDocumentTypehttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code from this IG | ||||
Composition.category | extensible | LOINCDocumentClasshttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes from this IG | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | extensible | LOINCDocumentSectionhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-doc-section-code from this IG | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | 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 | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | ?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
identifier | SΣ | 0..1 | Identifier | 不分版本的臨床文件架構(Composition)識別碼。 | ||||
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | Composition的種類(如果可能請使用LOINC) Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
category | 0..* | CodeableConceptTW | Composition的分類 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | Group | Device | Substance | TW Core Location) | Composition是關於誰和/或什麼 | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | Composition的情境 | ||||
date | SΣ | 1..1 | dateTime | Composition的編輯時間 | ||||
author | SΣ | 1..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
title | SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
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 | TW Core 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: LOINC Code Document Section值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
author | 0..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core 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 | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
emptyReason | 0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
section | C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | LOINCDocumentTypehttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code from this IG | ||||
Composition.category | extensible | LOINCDocumentClasshttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes from this IG | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | extensible | LOINCDocumentSectionhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-doc-section-code from this IG | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | 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() |
This structure is derived from Composition
Summary
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。 | |||||
id | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | |||||
meta | 0..1 | Meta | 此Composition Resource的metadata | |||||
implicitRules | 0..1 | uri | 創建此內容所依據的一組規則 | |||||
language | 0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | |||||
identifier | S | 0..1 | Identifier | 不分版本的臨床文件架構(Composition)識別碼。 | ||||
status | S | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | Composition的種類(如果可能請使用LOINC) Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
category | 0..* | CodeableConceptTW | Composition的分類 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | S | 0..1 | Reference(TW Core Patient | Group | Device | Substance | TW Core Location) | Composition是關於誰和/或什麼 | ||||
encounter | 0..1 | Reference(TW Core Encounter) | Composition的情境 | |||||
date | S | 1..1 | dateTime | Composition的編輯時間 | ||||
author | S | 1..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
title | S | 1..1 | string | 人類可讀的名稱/標題 | ||||
confidentiality | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | |||||
attester | S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
time | 0..1 | dateTime | 此Composition被證明的時間 | |||||
party | 0..1 | Reference(TW Core Patient | TW Core RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
custodian | S | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
relatesTo | 0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
target[x] | 1..1 | Identifier, Reference(Composition) | 此關係的目標文件 | |||||
event | 0..* | BackboneElement | 正在記錄的臨床服務 | |||||
code | 0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
period | 0..1 | Period | 文件所涵蓋的時間區間 | |||||
detail | 0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | |||||
section | S | 0..* | BackboneElement | Composition被分成一個或數個小節 | ||||
title | 0..1 | string | 小節標籤(例如:目錄ToC) | |||||
code | S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: LOINC Code Document Section值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
author | 0..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
focus | 0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
text | S | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
mode | 0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
orderedBy | 0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
entry | S | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
emptyReason | 0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
section | 0..* | 嵌套的小節 | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | LOINCDocumentTypehttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code from this IG | ||||
Composition.category | extensible | LOINCDocumentClasshttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes from this IG | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | extensible | LOINCDocumentSectionhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-doc-section-code from this IG | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | ?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
identifier | SΣ | 0..1 | Identifier | 不分版本的臨床文件架構(Composition)識別碼。 | ||||
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | Composition的種類(如果可能請使用LOINC) Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
category | 0..* | CodeableConceptTW | Composition的分類 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | Group | Device | Substance | TW Core Location) | Composition是關於誰和/或什麼 | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | Composition的情境 | ||||
date | SΣ | 1..1 | dateTime | Composition的編輯時間 | ||||
author | SΣ | 1..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
title | SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
confidentiality | Σ | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | ||||
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): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
time | 0..1 | dateTime | 此Composition被證明的時間 | |||||
party | 0..1 | Reference(TW Core Patient | TW Core RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
custodian | SΣ | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
relatesTo | 0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
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 | 正在記錄的臨床服務 | ||||
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 | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 0..1 | string | 小節標籤(例如:目錄ToC) | |||||
code | S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: LOINC Code Document Section值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
author | 0..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core 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 | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
emptyReason | 0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
section | C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | LOINCDocumentTypehttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code from this IG | ||||
Composition.category | extensible | LOINCDocumentClasshttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes from this IG | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | extensible | LOINCDocumentSectionhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-doc-section-code from this IG | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | 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 | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | ?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
identifier | SΣ | 0..1 | Identifier | 不分版本的臨床文件架構(Composition)識別碼。 | ||||
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | Composition的種類(如果可能請使用LOINC) Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
category | 0..* | CodeableConceptTW | Composition的分類 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | Group | Device | Substance | TW Core Location) | Composition是關於誰和/或什麼 | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | Composition的情境 | ||||
date | SΣ | 1..1 | dateTime | Composition的編輯時間 | ||||
author | SΣ | 1..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
title | SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
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 | TW Core 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: LOINC Code Document Section值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
author | 0..* | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core Patient | Device | TW Core 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 | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
emptyReason | 0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
section | C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | LOINCDocumentTypehttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code from this IG | ||||
Composition.category | extensible | LOINCDocumentClasshttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes from this IG | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | extensible | LOINCDocumentSectionhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-doc-section-code from this IG | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | 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() |
This structure is derived from Composition
Summary
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。
建議應該(SHOULD) 支援透過查詢參數 _id
查詢所有Composition:
(如何透過token查詢)
GET [base]/Composition?_id=[id]
GET [base]/Composition/[id]
例子:
(1) GET [base]/Composition?_id=com-example
(2) GET [base]/Composition/com-example
建議應該(SHOULD) 支援透過查詢參數 status
查詢所有Composition:
(如何透過token查詢)
GET [base]/Composition?status=[code]
例子:
(1) GET [base]/Composition?status=final
建議應該(SHOULD) 支援透過查詢參數 type
查詢所有Composition:
(如何透過token查詢)
GET [base]/Composition?type={system|}[code]
例子:
(1) GET [base]/Composition?type=http://loinc.org|18842-5
建議應該(SHOULD) 支援透過查詢參數 subject
查詢所有Composition:
(如何透過reference查詢)
GET [base]/Composition?subject={Type/}[id]
例子::
(1) GET [base]/Composition?subject=Patient/pat-example
id | Level | 位置 | 說明 | 運算式 |
---|---|---|---|---|
cmp-1 | Rule | Composition.section | 小節必須包含至少一項:文本、條目或子小節。 | text.exists() or entry.exists() or section.exists() |
cmp-2 | Rule | Composition.section | 小節是空的才可設定emptyReason | emptyReason.empty() or entry.empty() |
Composition.section.content
參照的 resources 內容進行確認及認證,因為這些文件往往是基於 Composition 衍生而來,且 Composition 的認證被認為適用於相關文件,因此當認證者審查 Composition 的內容時,應該使用一種類似審查最終文件那樣嚴謹和仔細。這意味者,在 Composition 階段,即使文件還沒有最終完成,認證者也應以正式及詳細的方式來審核內容,就像他們在審核最終文件進行審核一樣。Composition.section.text
)而不包含任何條目(Composition.section.entry
)也是可以接受的。一般來說,一份Composition是針對某個對象製作的,例如:一位病人、一群病人、某個位置或裝置。Composition與描述對象之間的區別在於,Composition是對對象的描述。但是,有些文件中包含的是與文件對象相關的其他參與者或實體的資料。這裡有一些例子:
在這些例子中,雖然文件主要對象是一位病人,但一些細節實際上與其他人或實體有關。當出現這種情況時,這些其他相關的人員或實體會在 Composition.section.focus
資料項目中被具體說明。如果沒有明確指出focus
,那麼預設Composition的主要suject
即是focus
。
如果明確指定了focus
,那麼與該小節相關的resources 必須(SHALL) 當遵守以下其中一項條件:
subject
(不管是以病人或其他名稱標示)或如果有focus
資料項目,則該資料項目應該是所指的focus。此外,這些resources不應該包含subject資料項目。Composition.subject
應該省略,並且在每個小節中使用section-subject這個擴充資料項目來指示相應的對象。