臺灣次世代基因定序檢測實作指引
1.0.1 - ci-build

臺灣次世代基因定序檢測實作指引, published by 衛生福利部中央健康保險署. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TWNHIFHIR/ngs/ and changes regularly. See the Directory of published versions

Resource Profile: 基因報告-DocumentReference TWNGS

Official URL: https://nhicore.nhi.gov.tw/ngs/StructureDefinition/DocumentReference-twngs Version: 1.0.1
Active as of 2026-10-14 Computable Name: DocumentReferenceTWNGS

此基因報告-DocumentReference TWNGS Profile說明本IG如何進一步定義臺灣核心-文件參照(TW Core DocumentReference) Profile以呈現次世代基因定序檢測之基因報告

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* TWCoreDocumentReference 文件的參照
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.masterIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier 主版本的識別碼
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。
Required Pattern: current
DocumentReference.type This element must be supported. 0..1 CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類型(如果可能,使用 LOINC 代碼)
Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.category This element must be supported. 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類別
Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(病人資訊-Patient TWNGS) 文件描述的對象是誰/是什麼?
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant 文件參照的創建時間是何時?
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | 病人資訊-Patient TWNGS | TW Core RelatedPerson) 誰以及/或什麼創建了文件
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement 被參照的文件
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment 存取文件的位置
Constraints: UploadContent
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
DocumentReference.content.attachment.url This element must be supported. This element is included in summaries. 1..1 url 基因報告(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
DocumentReference.content.attachment.title This element must be supported. This element is included in summaries. 1..1 string 基因報告名稱。
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible LOINC Code Document Type值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.category Base extensible LOINC Document Class值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
UploadContent error DocumentReference.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-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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 TWCoreDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference TWCoreDocumentReference
DocumentReference.status 1..1 code current | superseded | entered-in-error
Required Pattern: current
DocumentReference.subject 1..1 Reference(病人資訊-Patient TWNGS) 文件描述的對象是誰/是什麼?
DocumentReference.author 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | 病人資訊-Patient TWNGS | TW Core RelatedPerson) 誰以及/或什麼創建了文件
DocumentReference.content.attachment This element must be supported. C 1..1 Attachment 存取文件的位置
Constraints: UploadContent
DocumentReference.content.attachment.contentType This element must be supported. 1..1 code 報告結果-MIMEType
Required Pattern: application/pdf
DocumentReference.content.attachment.url This element must be supported. 1..1 url 基因報告(請填寫完整檔案路徑)
Example General: file://PathologyReport01.pdf
DocumentReference.content.attachment.title This element must be supported. 1..1 string 基因報告名稱。

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
UploadContent error DocumentReference.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}$')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* TWCoreDocumentReference 文件的參照
DocumentReference.id This element is included in summaries. 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
DocumentReference.meta This element is included in summaries. 0..1 Meta 此DocumentReference Resource的metadata
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
DocumentReference.language 0..1 code 用以表述DocumentReference Resource內容的語言。
Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Additional BindingsPurpose
AllLanguages Max Binding

Example Value: zh-TW
DocumentReference.text 0..1 Narrative DocumentReference Resource之內容摘要以供人閱讀
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.extension 0..* Extension Additional content defined by implementations
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.masterIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier 主版本的識別碼
DocumentReference.identifier This element is included in summaries. 0..* Identifier 文件的其他的識別碼
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。
Required Pattern: current
DocumentReference.docStatus This element is included in summaries. 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): 基礎文件的狀態;應填入所綁定值集中的其中一個代碼。
DocumentReference.type This element must be supported. 0..1 CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類型(如果可能,使用 LOINC 代碼)
Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.category This element must be supported. 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類別
Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(病人資訊-Patient TWNGS) 文件描述的對象是誰/是什麼?
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant 文件參照的創建時間是何時?
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | 病人資訊-Patient TWNGS | TW Core RelatedPerson) 誰以及/或什麼創建了文件
DocumentReference.authenticator 0..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 誰/什麼對文件進行了認證
DocumentReference.custodian 0..1 Reference(TW Core Organization) 維護此文件的機構
DocumentReference.relatesTo This element is included in summaries. 0..* BackboneElement 與其他文件的關係
DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing
DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(TW Core DocumentReference) 存在此關係的目標文件
DocumentReference.description This element is included in summaries. 0..1 string 人可讀的描述。
DocumentReference.securityLabel 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的安全標籤(security-tags)
Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement 被參照的文件
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.extension 0..* Extension Additional content defined by implementations
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment 存取文件的位置
Constraints: UploadContent
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
DocumentReference.content.attachment.language This element is included in summaries. 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
DocumentReference.content.attachment.data 0..1 base64Binary Data inline, base64ed
DocumentReference.content.attachment.url This element must be supported. This element is included in summaries. 1..1 url 基因報告(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element must be supported. This element is included in summaries. 1..1 string 基因報告名稱。
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element is included in summaries. 0..1 Coding 文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
DocumentReference.context This element is included in summaries. 0..1 BackboneElement 文件的臨床背景
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter 0..* Reference(TW Core Encounter | EpisodeOfCare) 文件內容的臨床背景
DocumentReference.context.event 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。
DocumentReference.context.period This element is included in summaries. 0..1 Period 被記錄的服務時間
DocumentReference.context.facilityType 0..1 CodeableConcept 病人接受治療的機構類型
Binding: FacilityTypeCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。
DocumentReference.context.practiceSetting 0..1 CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 內容創建的額外細節(例如:臨床專業)
Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。
DocumentReference.context.sourcePatientInfo 0..1 Reference(TW Core Patient) 來源的病人人口統計資料
DocumentReference.context.related 0..* Reference(Resource) 相關的識別碼或resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible LOINC Code Document Type值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.category Base extensible LOINC Document Class值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📦4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
UploadContent error DocumentReference.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-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* TWCoreDocumentReference 文件的參照
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.masterIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier 主版本的識別碼
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。
Required Pattern: current
DocumentReference.type This element must be supported. 0..1 CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類型(如果可能,使用 LOINC 代碼)
Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.category This element must be supported. 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類別
Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(病人資訊-Patient TWNGS) 文件描述的對象是誰/是什麼?
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant 文件參照的創建時間是何時?
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | 病人資訊-Patient TWNGS | TW Core RelatedPerson) 誰以及/或什麼創建了文件
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement 被參照的文件
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment 存取文件的位置
Constraints: UploadContent
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
DocumentReference.content.attachment.url This element must be supported. This element is included in summaries. 1..1 url 基因報告(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
DocumentReference.content.attachment.title This element must be supported. This element is included in summaries. 1..1 string 基因報告名稱。
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible LOINC Code Document Type值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.category Base extensible LOINC Document Class值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
UploadContent error DocumentReference.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-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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()

Differential View

This structure is derived from TWCoreDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference TWCoreDocumentReference
DocumentReference.status 1..1 code current | superseded | entered-in-error
Required Pattern: current
DocumentReference.subject 1..1 Reference(病人資訊-Patient TWNGS) 文件描述的對象是誰/是什麼?
DocumentReference.author 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | 病人資訊-Patient TWNGS | TW Core RelatedPerson) 誰以及/或什麼創建了文件
DocumentReference.content
DocumentReference.content.attachment This element must be supported. C 1..1 Attachment 存取文件的位置
Constraints: UploadContent
DocumentReference.content.attachment.contentType This element must be supported. 1..1 code 報告結果-MIMEType
Required Pattern: application/pdf
DocumentReference.content.attachment.url This element must be supported. 1..1 url 基因報告(請填寫完整檔案路徑)
Example General: file://PathologyReport01.pdf
DocumentReference.content.attachment.title This element must be supported. 1..1 string 基因報告名稱。

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
UploadContent error DocumentReference.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}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* TWCoreDocumentReference 文件的參照
DocumentReference.id This element is included in summaries. 0..1 id 不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
DocumentReference.meta This element is included in summaries. 0..1 Meta 此DocumentReference Resource的metadata
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri 創建此內容所依據的一組規則
DocumentReference.language 0..1 code 用以表述DocumentReference Resource內容的語言。
Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Additional BindingsPurpose
AllLanguages Max Binding

Example Value: zh-TW
DocumentReference.text 0..1 Narrative DocumentReference Resource之內容摘要以供人閱讀
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.extension 0..* Extension Additional content defined by implementations
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.masterIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier 主版本的識別碼
DocumentReference.identifier This element is included in summaries. 0..* Identifier 文件的其他的識別碼
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。
Required Pattern: current
DocumentReference.docStatus This element is included in summaries. 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): 基礎文件的狀態;應填入所綁定值集中的其中一個代碼。
DocumentReference.type This element must be supported. 0..1 CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類型(如果可能,使用 LOINC 代碼)
Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.category This element must be supported. 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的類別
Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(病人資訊-Patient TWNGS) 文件描述的對象是誰/是什麼?
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant 文件參照的創建時間是何時?
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | 病人資訊-Patient TWNGS | TW Core RelatedPerson) 誰以及/或什麼創建了文件
DocumentReference.authenticator 0..1 Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization) 誰/什麼對文件進行了認證
DocumentReference.custodian 0..1 Reference(TW Core Organization) 維護此文件的機構
DocumentReference.relatesTo This element is included in summaries. 0..* BackboneElement 與其他文件的關係
DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing
DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(TW Core DocumentReference) 存在此關係的目標文件
DocumentReference.description This element is included in summaries. 0..1 string 人可讀的描述。
DocumentReference.securityLabel 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 文件的安全標籤(security-tags)
Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement 被參照的文件
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.extension 0..* Extension Additional content defined by implementations
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment 存取文件的位置
Constraints: UploadContent
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 1..1 code 報告結果-MIMEType
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/pdf
DocumentReference.content.attachment.language This element is included in summaries. 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
DocumentReference.content.attachment.data 0..1 base64Binary Data inline, base64ed
DocumentReference.content.attachment.url This element must be supported. This element is included in summaries. 1..1 url 基因報告(請填寫完整檔案路徑)
Example General: http://www.acme.com/logo-small.png
Example General: file://PathologyReport01.pdf
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element must be supported. This element is included in summaries. 1..1 string 基因報告名稱。
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element is included in summaries. 0..1 Coding 文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。
DocumentReference.context This element is included in summaries. 0..1 BackboneElement 文件的臨床背景
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter 0..* Reference(TW Core Encounter | EpisodeOfCare) 文件內容的臨床背景
DocumentReference.context.event 0..* CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。
DocumentReference.context.period This element is included in summaries. 0..1 Period 被記錄的服務時間
DocumentReference.context.facilityType 0..1 CodeableConcept 病人接受治療的機構類型
Binding: FacilityTypeCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。
DocumentReference.context.practiceSetting 0..1 CodeableConceptTW The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well 內容創建的額外細節(例如:臨床專業)
Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。
DocumentReference.context.sourcePatientInfo 0..1 Reference(TW Core Patient) 來源的病人人口統計資料
DocumentReference.context.related 0..* Reference(Resource) 相關的識別碼或resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible LOINC Code Document Type值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.category Base extensible LOINC Document Class值集 📦2.77 臺灣核心實作指引 v0.3
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📦4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
UploadContent error DocumentReference.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-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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()

 

Other representations of profile: CSV, Excel, Schematron