臺灣癌症用藥事前審查實作指引
1.0.0 - release

This page is part of the 臺灣癌症用藥事前審查實作指引(TWPAS IG) (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: 文件參照-DocumentReference TWPAS

Official URL: https://twcore.mohw.gov.tw/ig/pas/StructureDefinition/DocumentReference-twpas Version: 1.0.0
Active as of 2024-10-16 Computable Name: DocumentReferenceTWPAS

此文件參照-DocumentReference TWPAS Profile說明本IG如何進一步定義臺灣核心-文件參照(TW Core DocumentReference) Profile以呈現癌藥事前審查之治療計畫文件及基因報告

Usage:

Formal Views of Profile Content

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

This structure is derived from TWCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* TWCoreDocumentReference 文件的參照
report-title: 若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
... status 1..1 code current | superseded | entered-in-error
Required Pattern: current
... category 1..1 CodeableConceptTW 文件的類別
Binding: NHI-文件類型值集 (required)
.... coding 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
..... code 1..1 code 系統定義的語法之符號
... subject 1..1 Reference(病人資訊-Patient TWPAS) 文件描述的對象是誰/是什麼?
.... attachment SC 1..1 Attachment 存取文件的位置
UploadContent: 填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
..... contentType S 1..1 code 報告結果-MIMEType
Required Pattern: application/pdf
..... url S 1..1 url 基因報告/治療計畫文件/檢驗(查)附件/病歷資料。(請填寫完整檔案路徑)
Example General: file://PathologyReport01.pdf
..... title S 0..1 string 基因報告名稱/治療計畫文件名稱/檢驗(查)附件名稱/病歷資料名稱。若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」。

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.categoryrequiredNHIPDFType (a valid code from NHI-文件類型)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-pdf-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
UploadContenterrorDocumentReference.content.attachment填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
: url.matches('^file://[a-zA-Z0-9一-龥]+.[a-zA-Z]{2,5}$')
report-titleerrorDocumentReference若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
: ((category.coding.exists(code='careplan')) implies (content.attachment.title = '免疫檢查點抑制劑治療計畫' or content.attachment.title = 'CAR-T多團隊會議紀錄' or content.attachment.title = '造血幹細胞移植計畫書'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* TWCoreDocumentReference 文件的參照
report-title: 若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ 0..1 Identifier 主版本的識別碼
... type S 0..1 CodeableConceptTW 文件的類型(如果可能,使用 LOINC 代碼)
Binding: DocumentTypeValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

... category S 1..1 CodeableConceptTW 文件的類別
Binding: NHI-文件類型值集 (required)
.... coding S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
..... system SΣ 0..1 uri 專門術語系統(terminology system)的識別
..... code SΣ 1..1 code 系統定義的語法之符號
..... display SΣ 0..1 string 由系統定義的表示法
.... text SΣ 0..1 string 概念的文字表示法
... subject SΣ 1..1 Reference(病人資訊-Patient TWPAS) 文件描述的對象是誰/是什麼?
... date SΣ 0..1 instant 文件參照的創建時間是何時?
... author SΣ 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson) 誰以及/或什麼創建了文件
... content SΣ 1..* BackboneElement 被參照的文件
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣC 1..1 Attachment 存取文件的位置
UploadContent: 填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
..... contentType SΣ 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf
..... url SΣ 1..1 url 基因報告/治療計畫文件/檢驗(查)附件/病歷資料。(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
..... title SΣ 0..1 string 基因報告名稱/治療計畫文件名稱/檢驗(查)附件名稱/病歷資料名稱。若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」。
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryrequiredNHIPDFType (a valid code from NHI-文件類型)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-pdf-type
from this IG
DocumentReference.content.attachment.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
UploadContenterrorDocumentReference.content.attachment填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
: url.matches('^file://[a-zA-Z0-9一-龥]+.[a-zA-Z]{2,5}$')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
report-titleerrorDocumentReference若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
: ((category.coding.exists(code='careplan')) implies (content.attachment.title = '免疫檢查點抑制劑治療計畫' or content.attachment.title = 'CAR-T多團隊會議紀錄' or content.attachment.title = '造血幹細胞移植計畫書'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* TWCoreDocumentReference 文件的參照
report-title: 若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
... id Σ 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta Σ 0..1 Meta 此DocumentReference Resource的metadata
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... text 0..1 Narrative DocumentReference Resource之內容摘要以供人閱讀
... contained 0..* Resource 內嵌的(contained)、行內的Resources
... extension 0..* Extension 擴充的資料項目
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ 0..1 Identifier 主版本的識別碼
... identifier Σ 0..* Identifier 文件的其他的識別碼
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。


Required Pattern: current
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): 基礎文件的狀態;應填入所綁定值集中的其中一個代碼。

... type S 0..1 CodeableConceptTW 文件的類型(如果可能,使用 LOINC 代碼)
Binding: DocumentTypeValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

... category S 1..1 CodeableConceptTW 文件的類別
Binding: NHI-文件類型值集 (required)
.... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
.... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
.... coding S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
..... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
..... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
..... system SΣ 0..1 uri 專門術語系統(terminology system)的識別
..... version Σ 0..1 string 系統的版本—如果相關的話
..... code SΣ 1..1 code 系統定義的語法之符號
..... display SΣ 0..1 string 由系統定義的表示法
..... userSelected Σ 0..1 boolean 此編碼是否由使用者直接選擇?
.... text SΣ 0..1 string 概念的文字表示法
... subject SΣ 1..1 Reference(病人資訊-Patient TWPAS) 文件描述的對象是誰/是什麼?
... date SΣ 0..1 instant 文件參照的創建時間是何時?
... author SΣ 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson) 誰以及/或什麼創建了文件
... authenticator 0..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 誰/什麼對文件進行了認證
... custodian 0..1 Reference(TW Core Organization) 維護此文件的機構
... relatesTo Σ 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 Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

.... target Σ 1..1 Reference(TW Core DocumentReference) 存在此關係的目標文件
... description Σ 0..1 string 人可讀的描述。
... securityLabel 0..* CodeableConceptTW 文件的安全標籤(security-tags)
Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... content SΣ 1..* BackboneElement 被參照的文件
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣC 1..1 Attachment 存取文件的位置
UploadContent: 填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url SΣ 1..1 url 基因報告/治療計畫文件/檢驗(查)附件/病歷資料。(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string 基因報告名稱/治療計畫文件名稱/檢驗(查)附件名稱/病歷資料名稱。若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」。
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding 文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context Σ 0..1 BackboneElement 文件的臨床背景
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(TW Core Encounter | EpisodeOfCare) 文件內容的臨床背景
.... event 0..* CodeableConceptTW 正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


.... period Σ 0..1 Period 被記錄的服務時間
.... facilityType 0..1 CodeableConcept 病人接受治療的機構類型
Binding: FacilityTypeCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

.... practiceSetting 0..1 CodeableConceptTW 內容創建的額外細節(例如:臨床專業)
Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

.... sourcePatientInfo 0..1 Reference(TW Core Patient) 來源的病人人口統計資料
.... related 0..* Reference(Resource) 相關的識別碼或resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryrequiredNHIPDFType (a valid code from NHI-文件類型)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-pdf-type
from this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
UploadContenterrorDocumentReference.content.attachment填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
: url.matches('^file://[a-zA-Z0-9一-龥]+.[a-zA-Z]{2,5}$')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
report-titleerrorDocumentReference若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
: ((category.coding.exists(code='careplan')) implies (content.attachment.title = '免疫檢查點抑制劑治療計畫' or content.attachment.title = 'CAR-T多團隊會議紀錄' or content.attachment.title = '造血幹細胞移植計畫書'))

This structure is derived from TWCoreDocumentReference

Summary

Mandatory: 5 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from TWCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* TWCoreDocumentReference 文件的參照
report-title: 若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
... status 1..1 code current | superseded | entered-in-error
Required Pattern: current
... category 1..1 CodeableConceptTW 文件的類別
Binding: NHI-文件類型值集 (required)
.... coding 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
..... code 1..1 code 系統定義的語法之符號
... subject 1..1 Reference(病人資訊-Patient TWPAS) 文件描述的對象是誰/是什麼?
.... attachment SC 1..1 Attachment 存取文件的位置
UploadContent: 填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
..... contentType S 1..1 code 報告結果-MIMEType
Required Pattern: application/pdf
..... url S 1..1 url 基因報告/治療計畫文件/檢驗(查)附件/病歷資料。(請填寫完整檔案路徑)
Example General: file://PathologyReport01.pdf
..... title S 0..1 string 基因報告名稱/治療計畫文件名稱/檢驗(查)附件名稱/病歷資料名稱。若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」。

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.categoryrequiredNHIPDFType (a valid code from NHI-文件類型)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-pdf-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
UploadContenterrorDocumentReference.content.attachment填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
: url.matches('^file://[a-zA-Z0-9一-龥]+.[a-zA-Z]{2,5}$')
report-titleerrorDocumentReference若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
: ((category.coding.exists(code='careplan')) implies (content.attachment.title = '免疫檢查點抑制劑治療計畫' or content.attachment.title = 'CAR-T多團隊會議紀錄' or content.attachment.title = '造血幹細胞移植計畫書'))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* TWCoreDocumentReference 文件的參照
report-title: 若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ 0..1 Identifier 主版本的識別碼
... type S 0..1 CodeableConceptTW 文件的類型(如果可能,使用 LOINC 代碼)
Binding: DocumentTypeValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

... category S 1..1 CodeableConceptTW 文件的類別
Binding: NHI-文件類型值集 (required)
.... coding S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
..... system SΣ 0..1 uri 專門術語系統(terminology system)的識別
..... code SΣ 1..1 code 系統定義的語法之符號
..... display SΣ 0..1 string 由系統定義的表示法
.... text SΣ 0..1 string 概念的文字表示法
... subject SΣ 1..1 Reference(病人資訊-Patient TWPAS) 文件描述的對象是誰/是什麼?
... date SΣ 0..1 instant 文件參照的創建時間是何時?
... author SΣ 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson) 誰以及/或什麼創建了文件
... content SΣ 1..* BackboneElement 被參照的文件
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣC 1..1 Attachment 存取文件的位置
UploadContent: 填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
..... contentType SΣ 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf
..... url SΣ 1..1 url 基因報告/治療計畫文件/檢驗(查)附件/病歷資料。(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
..... title SΣ 0..1 string 基因報告名稱/治療計畫文件名稱/檢驗(查)附件名稱/病歷資料名稱。若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」。
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryrequiredNHIPDFType (a valid code from NHI-文件類型)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-pdf-type
from this IG
DocumentReference.content.attachment.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
UploadContenterrorDocumentReference.content.attachment填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
: url.matches('^file://[a-zA-Z0-9一-龥]+.[a-zA-Z]{2,5}$')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
report-titleerrorDocumentReference若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
: ((category.coding.exists(code='careplan')) implies (content.attachment.title = '免疫檢查點抑制劑治療計畫' or content.attachment.title = 'CAR-T多團隊會議紀錄' or content.attachment.title = '造血幹細胞移植計畫書'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C 0..* TWCoreDocumentReference 文件的參照
report-title: 若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
... id Σ 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta Σ 0..1 Meta 此DocumentReference Resource的metadata
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
... text 0..1 Narrative DocumentReference Resource之內容摘要以供人閱讀
... contained 0..* Resource 內嵌的(contained)、行內的Resources
... extension 0..* Extension 擴充的資料項目
... modifierExtension ?! 0..* Extension 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ 0..1 Identifier 主版本的識別碼
... identifier Σ 0..* Identifier 文件的其他的識別碼
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。


Required Pattern: current
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): 基礎文件的狀態;應填入所綁定值集中的其中一個代碼。

... type S 0..1 CodeableConceptTW 文件的類型(如果可能,使用 LOINC 代碼)
Binding: DocumentTypeValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

... category S 1..1 CodeableConceptTW 文件的類別
Binding: NHI-文件類型值集 (required)
.... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
.... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
.... coding S 1..1 CodingTW 由專門術語系統(terminology system)定義的代碼
..... id 0..1 string 唯一可識別ID,以供資料項目間相互參照。
..... extension 0..* Extension 擴充的資料項目
Slice: Unordered, Open by value:url
..... system SΣ 0..1 uri 專門術語系統(terminology system)的識別
..... version Σ 0..1 string 系統的版本—如果相關的話
..... code SΣ 1..1 code 系統定義的語法之符號
..... display SΣ 0..1 string 由系統定義的表示法
..... userSelected Σ 0..1 boolean 此編碼是否由使用者直接選擇?
.... text SΣ 0..1 string 概念的文字表示法
... subject SΣ 1..1 Reference(病人資訊-Patient TWPAS) 文件描述的對象是誰/是什麼?
... date SΣ 0..1 instant 文件參照的創建時間是何時?
... author SΣ 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson) 誰以及/或什麼創建了文件
... authenticator 0..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 誰/什麼對文件進行了認證
... custodian 0..1 Reference(TW Core Organization) 維護此文件的機構
... relatesTo Σ 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 Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

.... target Σ 1..1 Reference(TW Core DocumentReference) 存在此關係的目標文件
... description Σ 0..1 string 人可讀的描述。
... securityLabel 0..* CodeableConceptTW 文件的安全標籤(security-tags)
Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... content SΣ 1..* BackboneElement 被參照的文件
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣC 1..1 Attachment 存取文件的位置
UploadContent: 填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url SΣ 1..1 url 基因報告/治療計畫文件/檢驗(查)附件/病歷資料。(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string 基因報告名稱/治療計畫文件名稱/檢驗(查)附件名稱/病歷資料名稱。若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」。
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding 文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context Σ 0..1 BackboneElement 文件的臨床背景
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(TW Core Encounter | EpisodeOfCare) 文件內容的臨床背景
.... event 0..* CodeableConceptTW 正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


.... period Σ 0..1 Period 被記錄的服務時間
.... facilityType 0..1 CodeableConcept 病人接受治療的機構類型
Binding: FacilityTypeCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

.... practiceSetting 0..1 CodeableConceptTW 內容創建的額外細節(例如:臨床專業)
Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

.... sourcePatientInfo 0..1 Reference(TW Core Patient) 來源的病人人口統計資料
.... related 0..* Reference(Resource) 相關的識別碼或resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryrequiredNHIPDFType (a valid code from NHI-文件類型)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-pdf-type
from this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
UploadContenterrorDocumentReference.content.attachment填寫格式:file://檔名.副檔名,例如:file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
: url.matches('^file://[a-zA-Z0-9一-龥]+.[a-zA-Z]{2,5}$')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
report-titleerrorDocumentReference若category為「治療計畫文件(#careplan)」,請擇一填寫:「免疫檢查點抑制劑治療計畫/CAR-T多團隊會議紀錄/造血幹細胞移植計畫書」
: ((category.coding.exists(code='careplan')) implies (content.attachment.title = '免疫檢查點抑制劑治療計畫' or content.attachment.title = 'CAR-T多團隊會議紀錄' or content.attachment.title = '造血幹細胞移植計畫書'))

This structure is derived from TWCoreDocumentReference

Summary

Mandatory: 5 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron