HL7 FHIR Implementation Guide: HealthBank IG Release 0.1.0 - TW | STU1
0.1.0 - ci-build
HL7 FHIR Implementation Guide: HealthBank IG Release 0.1.0 - TW | STU1 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://ig.dicom.tw/healthbank/StructureDefinition/Composition-HealthBank | Version: 0.1.0 | |||
| Active as of 2024-08-16 | Computable Name: HealthBankComposition | |||
此健康存摺-臨床文件架構(HealthBank Composition) Profile說明本IG如何進一步定義FHIR的Composition Resource以呈現臨床文件架構的詳細資料。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from TWCoreComposition
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | TWCoreComposition | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 | |||||
![]() ![]() |
0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | |||||
![]() ![]() |
0..1 | Meta | 此Composition Resource的metadata | |||||
![]() ![]() |
0..1 | uri | 創建此內容所依據的一組規則 | |||||
![]() ![]() |
0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
![]() ![]() |
0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
![]() ![]() |
0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() |
0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | |||||
![]() ![]() |
S | 0..1 | Identifier | 資料唯一識別碼(建議可經邏輯編碼), system =https://r1.myhealthbank.nhi.gov.tw 自行替換r1/r2/r4/r7 | ||||
![]() ![]() |
S | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 Required Pattern: final | ||||
![]() ![]() |
S | 1..1 | CodeableConceptTW | r1: 34117-2 (History and physical note), r2: 34130-5 (Hospital Progress note), r4: 48765-2 (Allergies and adverse reactions Document), r7: 30954-2 (Relevant diagnostic tests/laboratory data Narrative) Binding: FHIRDocumentTypeCodes (preferred): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() |
0..* | CodeableConceptTW | https://myhealthbank.nhi.gov.tw, value = r1 Binding: DocumentClassValueSet (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
![]() ![]() |
S | 0..1 | Reference(Group | Device | Substance) | Patient Resource urn:uuid:ResourceID | ||||
![]() ![]() |
0..1 | Reference(TW Core Encounter) | Encounter Resource urn:uuid:ResourceID | |||||
![]() ![]() |
S | 1..1 | dateTime | b1.2資料申請日期 | ||||
![]() ![]() |
S | 1..* | Reference(Device | RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
![]() ![]() |
S | 1..1 | string | 人類可讀的名稱/標題 | ||||
![]() ![]() |
0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() |
S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
![]() ![]() ![]() |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | dateTime | 此Composition被證明的時間 | |||||
![]() ![]() ![]() |
0..1 | Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
![]() ![]() |
S | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
![]() ![]() |
0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
1..1 | Identifier, Reference(Composition) | 此關係的目標文件 | |||||
![]() ![]() |
0..* | BackboneElement | 正在記錄的臨床服務 | |||||
![]() ![]() ![]() |
0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
![]() ![]() ![]() |
0..1 | Period | 資料主日期,r1 採 r1.5 就醫日期 為資料主日期,r2 採 r2.5入院日期 為資料主日期,r4 採 r4.1上傳日期 為資料主日期,r7 採 r7.6檢驗(查)日期 為資料主日期 | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | |||||
![]() ![]() |
S | 0..* | BackboneElement | Composition被分成一個或數個小節 | ||||
![]() ![]() ![]() |
0..1 | string | ex r1: 健康存摺-西醫門診資料 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: DocumentSectionCodes (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
![]() ![]() ![]() |
S | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
![]() ![]() ![]() |
0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
S | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
0..* | 嵌套的小節 | ||||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | TWCoreComposition | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 | |||||
![]() ![]() |
Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
![]() ![]() |
Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
![]() ![]() |
?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
![]() ![]() |
0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
![]() ![]() |
0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
![]() ![]() |
0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() |
?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | 資料唯一識別碼(建議可經邏輯編碼), system =https://r1.myhealthbank.nhi.gov.tw 自行替換r1/r2/r4/r7 | ||||
![]() ![]() |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 Required Pattern: final | ||||
![]() ![]() |
S | 1..1 | CodeableConceptTW | r1: 34117-2 (History and physical note), r2: 34130-5 (Hospital Progress note), r4: 48765-2 (Allergies and adverse reactions Document), r7: 30954-2 (Relevant diagnostic tests/laboratory data Narrative) Binding: FHIRDocumentTypeCodes (preferred): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() |
0..* | CodeableConceptTW | https://myhealthbank.nhi.gov.tw, value = r1 Binding: DocumentClassValueSet (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Group | Device | Substance) | Patient Resource urn:uuid:ResourceID | ||||
![]() ![]() |
Σ | 0..1 | Reference(TW Core Encounter) | Encounter Resource urn:uuid:ResourceID | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | b1.2資料申請日期 | ||||
![]() ![]() |
SΣ | 1..* | Reference(Device | RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
![]() ![]() |
SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
![]() ![]() |
Σ | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | ||||
![]() ![]() |
S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | dateTime | 此Composition被證明的時間 | |||||
![]() ![]() ![]() |
0..1 | Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
![]() ![]() |
SΣ | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
![]() ![]() |
0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
1..1 | 此關係的目標文件 | ||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | 正在記錄的臨床服務 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | 資料主日期,r1 採 r1.5 就醫日期 為資料主日期,r2 採 r2.5入院日期 為資料主日期,r4 採 r4.1上傳日期 為資料主日期,r7 採 r7.6檢驗(查)日期 為資料主日期 | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | ||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..1 | string | ex r1: 健康存摺-西醫門診資料 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: DocumentSectionCodes (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
![]() ![]() ![]() |
SC | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
![]() ![]() ![]() |
0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
SC | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | TWCoreComposition | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 | |||||
![]() ![]() |
Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
![]() ![]() |
Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
![]() ![]() |
?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
![]() ![]() |
0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
![]() ![]() |
0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
![]() ![]() |
0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() |
?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | 資料唯一識別碼(建議可經邏輯編碼), system =https://r1.myhealthbank.nhi.gov.tw 自行替換r1/r2/r4/r7 | ||||
![]() ![]() |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 Required Pattern: final | ||||
![]() ![]() |
S | 1..1 | CodeableConceptTW | r1: 34117-2 (History and physical note), r2: 34130-5 (Hospital Progress note), r4: 48765-2 (Allergies and adverse reactions Document), r7: 30954-2 (Relevant diagnostic tests/laboratory data Narrative) Binding: FHIRDocumentTypeCodes (preferred): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() |
0..* | CodeableConceptTW | https://myhealthbank.nhi.gov.tw, value = r1 Binding: DocumentClassValueSet (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Group | Device | Substance) | Patient Resource urn:uuid:ResourceID | ||||
![]() ![]() |
Σ | 0..1 | Reference(TW Core Encounter) | Encounter Resource urn:uuid:ResourceID | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | b1.2資料申請日期 | ||||
![]() ![]() |
SΣ | 1..* | Reference(Device | RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
![]() ![]() |
SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
![]() ![]() |
Σ | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | ||||
![]() ![]() |
S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | dateTime | 此Composition被證明的時間 | |||||
![]() ![]() ![]() |
0..1 | Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
![]() ![]() |
SΣ | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
![]() ![]() |
0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
1..1 | 此關係的目標文件 | ||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | 正在記錄的臨床服務 | ||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | 資料主日期,r1 採 r1.5 就醫日期 為資料主日期,r2 採 r2.5入院日期 為資料主日期,r4 採 r4.1上傳日期 為資料主日期,r7 採 r7.6檢驗(查)日期 為資料主日期 | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | ||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..1 | string | ex r1: 健康存摺-西醫門診資料 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: DocumentSectionCodes (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
![]() ![]() ![]() |
SC | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
![]() ![]() ![]() |
0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
SC | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom 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 TWCoreComposition
Differential View
This structure is derived from TWCoreComposition
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | TWCoreComposition | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 | |||||
![]() ![]() |
0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | |||||
![]() ![]() |
0..1 | Meta | 此Composition Resource的metadata | |||||
![]() ![]() |
0..1 | uri | 創建此內容所依據的一組規則 | |||||
![]() ![]() |
0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
![]() ![]() |
0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
![]() ![]() |
0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() |
0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | |||||
![]() ![]() |
S | 0..1 | Identifier | 資料唯一識別碼(建議可經邏輯編碼), system =https://r1.myhealthbank.nhi.gov.tw 自行替換r1/r2/r4/r7 | ||||
![]() ![]() |
S | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 Required Pattern: final | ||||
![]() ![]() |
S | 1..1 | CodeableConceptTW | r1: 34117-2 (History and physical note), r2: 34130-5 (Hospital Progress note), r4: 48765-2 (Allergies and adverse reactions Document), r7: 30954-2 (Relevant diagnostic tests/laboratory data Narrative) Binding: FHIRDocumentTypeCodes (preferred): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() |
0..* | CodeableConceptTW | https://myhealthbank.nhi.gov.tw, value = r1 Binding: DocumentClassValueSet (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
![]() ![]() |
S | 0..1 | Reference(Group | Device | Substance) | Patient Resource urn:uuid:ResourceID | ||||
![]() ![]() |
0..1 | Reference(TW Core Encounter) | Encounter Resource urn:uuid:ResourceID | |||||
![]() ![]() |
S | 1..1 | dateTime | b1.2資料申請日期 | ||||
![]() ![]() |
S | 1..* | Reference(Device | RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
![]() ![]() |
S | 1..1 | string | 人類可讀的名稱/標題 | ||||
![]() ![]() |
0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() |
S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
![]() ![]() ![]() |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | dateTime | 此Composition被證明的時間 | |||||
![]() ![]() ![]() |
0..1 | Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
![]() ![]() |
S | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
![]() ![]() |
0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
1..1 | Identifier, Reference(Composition) | 此關係的目標文件 | |||||
![]() ![]() |
0..* | BackboneElement | 正在記錄的臨床服務 | |||||
![]() ![]() ![]() |
0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
![]() ![]() ![]() |
0..1 | Period | 資料主日期,r1 採 r1.5 就醫日期 為資料主日期,r2 採 r2.5入院日期 為資料主日期,r4 採 r4.1上傳日期 為資料主日期,r7 採 r7.6檢驗(查)日期 為資料主日期 | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | |||||
![]() ![]() |
S | 0..* | BackboneElement | Composition被分成一個或數個小節 | ||||
![]() ![]() ![]() |
0..1 | string | ex r1: 健康存摺-西醫門診資料 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: DocumentSectionCodes (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
![]() ![]() ![]() |
S | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
![]() ![]() ![]() |
0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
S | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
0..* | 嵌套的小節 | ||||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | TWCoreComposition | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 | |||||
![]() ![]() |
Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
![]() ![]() |
Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
![]() ![]() |
?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
![]() ![]() |
0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
![]() ![]() |
0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
![]() ![]() |
0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() |
?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | 資料唯一識別碼(建議可經邏輯編碼), system =https://r1.myhealthbank.nhi.gov.tw 自行替換r1/r2/r4/r7 | ||||
![]() ![]() |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 Required Pattern: final | ||||
![]() ![]() |
S | 1..1 | CodeableConceptTW | r1: 34117-2 (History and physical note), r2: 34130-5 (Hospital Progress note), r4: 48765-2 (Allergies and adverse reactions Document), r7: 30954-2 (Relevant diagnostic tests/laboratory data Narrative) Binding: FHIRDocumentTypeCodes (preferred): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() |
0..* | CodeableConceptTW | https://myhealthbank.nhi.gov.tw, value = r1 Binding: DocumentClassValueSet (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Group | Device | Substance) | Patient Resource urn:uuid:ResourceID | ||||
![]() ![]() |
Σ | 0..1 | Reference(TW Core Encounter) | Encounter Resource urn:uuid:ResourceID | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | b1.2資料申請日期 | ||||
![]() ![]() |
SΣ | 1..* | Reference(Device | RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
![]() ![]() |
SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
![]() ![]() |
Σ | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | ||||
![]() ![]() |
S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | dateTime | 此Composition被證明的時間 | |||||
![]() ![]() ![]() |
0..1 | Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
![]() ![]() |
SΣ | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
![]() ![]() |
0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
1..1 | 此關係的目標文件 | ||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | 正在記錄的臨床服務 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | 資料主日期,r1 採 r1.5 就醫日期 為資料主日期,r2 採 r2.5入院日期 為資料主日期,r4 採 r4.1上傳日期 為資料主日期,r7 採 r7.6檢驗(查)日期 為資料主日期 | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | ||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..1 | string | ex r1: 健康存摺-西醫門診資料 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: DocumentSectionCodes (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
![]() ![]() ![]() |
SC | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
![]() ![]() ![]() |
0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
SC | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | TWCoreComposition | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 | |||||
![]() ![]() |
Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Composition紀錄,通常又稱為邏輯性ID。 | ||||
![]() ![]() |
Σ | 0..1 | Meta | 此Composition Resource的metadata | ||||
![]() ![]() |
?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
![]() ![]() |
0..1 | code | 用以表述Composition Resource內容的語言 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
Example Value: zh-TW | |||||
![]() ![]() |
0..1 | Narrative | Composition Resource之內容摘要以供人閱讀 | |||||
![]() ![]() |
0..* | Resource | 內嵌的(contained)、行內的Resources | |||||
![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() |
?! | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | 資料唯一識別碼(建議可經邏輯編碼), system =https://r1.myhealthbank.nhi.gov.tw 自行替換r1/r2/r4/r7 | ||||
![]() ![]() |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected + Binding: CompositionStatus (required): Composition的工作流程/臨床狀態;應填入所綁定值集中的其中一個代碼。 Required Pattern: final | ||||
![]() ![]() |
S | 1..1 | CodeableConceptTW | r1: 34117-2 (History and physical note), r2: 34130-5 (Hospital Progress note), r4: 48765-2 (Allergies and adverse reactions Document), r7: 30954-2 (Relevant diagnostic tests/laboratory data Narrative) Binding: FHIRDocumentTypeCodes (preferred): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() |
0..* | CodeableConceptTW | https://myhealthbank.nhi.gov.tw, value = r1 Binding: DocumentClassValueSet (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
![]() ![]() |
SΣ | 0..1 | Reference(Group | Device | Substance) | Patient Resource urn:uuid:ResourceID | ||||
![]() ![]() |
Σ | 0..1 | Reference(TW Core Encounter) | Encounter Resource urn:uuid:ResourceID | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | b1.2資料申請日期 | ||||
![]() ![]() |
SΣ | 1..* | Reference(Device | RelatedPerson) | 誰和/或什麼創建了這個Composition | ||||
![]() ![]() |
SΣ | 1..1 | string | 人類可讀的名稱/標題 | ||||
![]() ![]() |
Σ | 0..1 | code | 根據特定技術領域的定義 Binding: v3.ConfidentialityClassification (2014-03-26) (required): 應填入所綁定值集中的其中一個代碼。 | ||||
![]() ![]() |
S | 0..* | BackboneElement | 證明Composition的準確性 | ||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): 認證者提供的認證類型;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | dateTime | 此Composition被證明的時間 | |||||
![]() ![]() ![]() |
0..1 | Reference(TW Core Patient | RelatedPerson | TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) | 誰證明了此Composition | |||||
![]() ![]() |
SΣ | 0..1 | Reference(TW Core Organization) | 維護Composition的機構 | ||||
![]() ![]() |
0..* | BackboneElement | 與其他Composition/文件之間的關係 | |||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 檔案之間的關係型別;應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
1..1 | 此關係的目標文件 | ||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | 正在記錄的臨床服務 | ||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..* | CodeableConceptTW | 此代碼表代表了正在被記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | 資料主日期,r1 採 r1.5 就醫日期 為資料主日期,r2 採 r2.5入院日期 為資料主日期,r4 採 r4.1上傳日期 為資料主日期,r7 採 r7.6檢驗(查)日期 為資料主日期 | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | 在描述被記錄下來的事件,這些事件可以是以代碼的形式、參考資料的形式,或者兩者都有的形式來呈現。 | ||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
![]() ![]() ![]() |
0..* | Extension | 擴充的資料項目 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
![]() ![]() ![]() |
0..1 | string | ex r1: 健康存摺-西醫門診資料 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 小節分類(建議) Binding: DocumentSectionCodes (example): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson) | 誰和/或什麼人撰寫了該小節 | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | 當小節與composition描述的對象無關時,此小節是關於誰/什麼。 | |||||
![]() ![]() ![]() |
SC | 0..1 | Narrative | 將文件中特定小節的內容簡化成容易理解的文字形式,便於人類閱讀和解釋。 | ||||
![]() ![]() ![]() |
0..1 | code | 適用於此小節的處理模式 Binding: ListMode (required): 應填入所綁定值集中的其中一個代碼。 | |||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 小節條目的順序 Binding: ListOrderCodes (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
SC | 0..* | Reference(Resource) | 提供一個連結用於參照或查看支持此小節內容的資料 | ||||
![]() ![]() ![]() |
0..1 | CodeableConceptTW | 為什麼此小節是空的原因 Binding: ListEmptyReasons (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
![]() ![]() ![]() |
C | 0..* | See section (Composition) | 嵌套的小節 | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom 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 TWCoreComposition
Other representations of profile: CSV, Excel, Schematron