NGS IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: 基因報告-DocumentReference TWNGS

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

Usage:

• Use this Resource Profile: 次世代基因定序檢測-Bundle TWNGS
• Refer to this Resource Profile: 基因定序檢測證明文件-Composition TWNGS and 基因資訊-Observation TWNGS
• Examples for this Resource Profile: DocumentReference/doc-gene-min

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	TWCoreDocumentReference	文件的參照 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	創建此內容所依據的一組規則 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
masterIdentifier	SΣN	0..1	Identifier	主版本的識別碼 ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): 文件參照的狀態；應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children Required Pattern: current
type	SΣN	0..1	CodeableConceptTW	文件的類型（如果可能，使用 LOINC 代碼） Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
category	SΣN	0..*	CodeableConceptTW	文件的類別 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
subject	SΣCN	1..1	Reference(病人資訊-Patient TWNGS)	文件描述的對象是誰/是什麼？ ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
date	SΣ	0..1	instant	文件參照的創建時間是何時？ ele-1: All FHIR elements must have a @value or children
author	SΣCN	0..*	Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | TW Core RelatedPerson)	誰以及/或什麼創建了文件 ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
securityLabel	ΣN	0..*	CodeableConceptTW	文件的安全標籤(security-tags) Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
content	SΣN	1..*	BackboneElement	被參照的文件 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
attachment	SΣCN	1..1	Attachment	存取文件的位置 ele-1: All FHIR elements must have a @value or children att-1: If the Attachment has data, it SHALL have a contentType 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. ele-1: All FHIR elements must have a @value or children Required Pattern: application/pdf
url	SΣ	1..1	url	基因報告（請填寫完整檔案路徑） ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png Example General: file://PathologyReport01.pdf
title	SΣ	0..1	string	基因報告名稱。 ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
context	ΣN	0..1	BackboneElement	文件的臨床背景 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
event	N	0..*	CodeableConceptTW	正在記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
practiceSetting	N	0..1	CodeableConceptTW	內容創建的額外細節(例如：臨床專業) Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.status	required	Pattern: current http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.type	extensible	LOINCDocumentType https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code
DocumentReference.category	extensible	LOINCDocumentClass https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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}$')
att-1	error	DocumentReference.content.attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
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()
ref-1	error	DocumentReference.subject, DocumentReference.author	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from TWCoreDocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference			TWCoreDocumentReference
status				Required Pattern: current
subject			Reference(病人資訊-Patient TWNGS)
content
attachment	SC			UploadContent: 填寫格式：file://檔名.副檔名，例如：file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
contentType	S	1..		報告結果-MIMEType Required Pattern: application/pdf
url	S	1..		基因報告（請填寫完整檔案路徑） Example General: file://PathologyReport01.pdf
title	S			基因報告名稱。
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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}$')

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	TWCoreDocumentReference	文件的參照
id	Σ	0..1	string	不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄，通常又稱為邏輯性ID。
meta	ΣN	0..1	Meta	此DocumentReference Resource的metadata
implicitRules	?!Σ	0..1	uri	創建此內容所依據的一組規則
language		0..1	code	用以表述DocumentReference Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。 Additional Bindings Purpose AllLanguages Max Binding Example Value: zh-TW
text	N	0..1	Narrative	DocumentReference Resource之內容摘要以供人閱讀
contained		0..*	Resource	Contained, inline Resources
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
masterIdentifier	SΣN	0..1	Identifier	主版本的識別碼
identifier	ΣN	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ΣN	0..1	CodeableConceptTW	文件的類型（如果可能，使用 LOINC 代碼） Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
category	SΣN	0..*	CodeableConceptTW	文件的類別 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
subject	SΣCN	1..1	Reference(病人資訊-Patient TWNGS)	文件描述的對象是誰/是什麼？ ref-1: SHALL have a contained resource if a local reference is provided
date	SΣ	0..1	instant	文件參照的創建時間是何時？
author	SΣCN	0..*	Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | TW Core RelatedPerson)	誰以及/或什麼創建了文件 ref-1: SHALL have a contained resource if a local reference is provided
authenticator	CN	0..1	Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)	誰/什麼對文件進行了認證 ref-1: SHALL have a contained resource if a local reference is provided
custodian	CN	0..1	Reference(TW Core Organization)	維護此文件的機構 ref-1: SHALL have a contained resource if a local reference is provided
relatesTo	ΣN	0..*	BackboneElement	與其他文件的關係
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 文件之間的關係類型；應填入所綁定值集中的其中一個代碼。
target	ΣCN	1..1	Reference(TW Core DocumentReference)	存在此關係的目標文件 ref-1: SHALL have a contained resource if a local reference is provided
description	Σ	0..1	string	人可讀的描述。
securityLabel	ΣN	0..*	CodeableConceptTW	文件的安全標籤(security-tags) Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
content	SΣN	1..*	BackboneElement	被參照的文件
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣCN	1..1	Attachment	存取文件的位置 att-1: If the Attachment has data, it SHALL have a contentType UploadContent: 填寫格式：file://檔名.副檔名，例如：file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
id		0..1	string	Unique id for inter-element referencing
extension	N	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 Bindings Purpose 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	基因報告名稱。 Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	ΣN	0..1	Coding	文件的格式/內容規則。 Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼，但不強制一定要使用此值集，你也可使用其他值集的代碼或單純以文字表示。
context	ΣN	0..1	BackboneElement	文件的臨床背景
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	CN	0..*	Reference(TW Core Encounter | EpisodeOfCare)	文件內容的臨床背景 ref-1: SHALL have a contained resource if a local reference is provided
event	N	0..*	CodeableConceptTW	正在記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
period	ΣCN	0..1	Period	被記錄的服務時間 per-1: If present, start SHALL have a lower value than end
facilityType	N	0..1	CodeableConcept	病人接受治療的機構類型 Binding: FacilityTypeCodeValueSet (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。
practiceSetting	N	0..1	CodeableConceptTW	內容創建的額外細節(例如：臨床專業) Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
sourcePatientInfo	CN	0..1	Reference(TW Core Patient)	來源的病人人口統計資料 ref-1: SHALL have a contained resource if a local reference is provided
related	CN	0..*	Reference(Resource)	相關的識別碼或resources ref-1: SHALL have a contained resource if a local reference is provided
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	Pattern: current http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
DocumentReference.type	extensible	LOINCDocumentType https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code
DocumentReference.category	extensible	LOINCDocumentClass https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
DocumentReference.content.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	preferred	DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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}$')
att-1	error	DocumentReference.content.attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
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()
per-1	error	DocumentReference.context.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	DocumentReference.subject, DocumentReference.author, DocumentReference.authenticator, DocumentReference.custodian, DocumentReference.relatesTo.target, DocumentReference.context.encounter, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from TWCoreDocumentReference

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• 病人資訊-Patient TWNGS (https://www.ghd.tw/cdm-fhir/StructureDefinition/Patient-twngs)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	TWCoreDocumentReference	文件的參照 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	創建此內容所依據的一組規則 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
masterIdentifier	SΣN	0..1	Identifier	主版本的識別碼 ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): 文件參照的狀態；應填入所綁定值集中的其中一個代碼。 ele-1: All FHIR elements must have a @value or children Required Pattern: current
type	SΣN	0..1	CodeableConceptTW	文件的類型（如果可能，使用 LOINC 代碼） Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
category	SΣN	0..*	CodeableConceptTW	文件的類別 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
subject	SΣCN	1..1	Reference(病人資訊-Patient TWNGS)	文件描述的對象是誰/是什麼？ ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
date	SΣ	0..1	instant	文件參照的創建時間是何時？ ele-1: All FHIR elements must have a @value or children
author	SΣCN	0..*	Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | TW Core RelatedPerson)	誰以及/或什麼創建了文件 ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
securityLabel	ΣN	0..*	CodeableConceptTW	文件的安全標籤(security-tags) Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
content	SΣN	1..*	BackboneElement	被參照的文件 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
attachment	SΣCN	1..1	Attachment	存取文件的位置 ele-1: All FHIR elements must have a @value or children att-1: If the Attachment has data, it SHALL have a contentType 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. ele-1: All FHIR elements must have a @value or children Required Pattern: application/pdf
url	SΣ	1..1	url	基因報告（請填寫完整檔案路徑） ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png Example General: file://PathologyReport01.pdf
title	SΣ	0..1	string	基因報告名稱。 ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
context	ΣN	0..1	BackboneElement	文件的臨床背景 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
event	N	0..*	CodeableConceptTW	正在記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
practiceSetting	N	0..1	CodeableConceptTW	內容創建的額外細節(例如：臨床專業) Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。 ele-1: All FHIR elements must have a @value or children
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼 ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別 ele-1: All FHIR elements must have a @value or children
code	SΣ	0..1	code	系統定義的語法之符號 ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	由系統定義的表示法 ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	概念的文字表示法 ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.status	required	Pattern: current http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.type	extensible	LOINCDocumentType https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code
DocumentReference.category	extensible	LOINCDocumentClass https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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}$')
att-1	error	DocumentReference.content.attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
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()
ref-1	error	DocumentReference.subject, DocumentReference.author	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from TWCoreDocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference			TWCoreDocumentReference
status				Required Pattern: current
subject			Reference(病人資訊-Patient TWNGS)
content
attachment	SC			UploadContent: 填寫格式：file://檔名.副檔名，例如：file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
contentType	S	1..		報告結果-MIMEType Required Pattern: application/pdf
url	S	1..		基因報告（請填寫完整檔案路徑） Example General: file://PathologyReport01.pdf
title	S			基因報告名稱。
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	TWCoreDocumentReference	文件的參照
id	Σ	0..1	string	不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄，通常又稱為邏輯性ID。
meta	ΣN	0..1	Meta	此DocumentReference Resource的metadata
implicitRules	?!Σ	0..1	uri	創建此內容所依據的一組規則
language		0..1	code	用以表述DocumentReference Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。 Additional Bindings Purpose AllLanguages Max Binding Example Value: zh-TW
text	N	0..1	Narrative	DocumentReference Resource之內容摘要以供人閱讀
contained		0..*	Resource	Contained, inline Resources
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
masterIdentifier	SΣN	0..1	Identifier	主版本的識別碼
identifier	ΣN	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ΣN	0..1	CodeableConceptTW	文件的類型（如果可能，使用 LOINC 代碼） Binding: LOINC Code Document Type值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
category	SΣN	0..*	CodeableConceptTW	文件的類別 Binding: LOINC Document Class值集 (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
subject	SΣCN	1..1	Reference(病人資訊-Patient TWNGS)	文件描述的對象是誰/是什麼？ ref-1: SHALL have a contained resource if a local reference is provided
date	SΣ	0..1	instant	文件參照的創建時間是何時？
author	SΣCN	0..*	Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | TW Core RelatedPerson)	誰以及/或什麼創建了文件 ref-1: SHALL have a contained resource if a local reference is provided
authenticator	CN	0..1	Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)	誰/什麼對文件進行了認證 ref-1: SHALL have a contained resource if a local reference is provided
custodian	CN	0..1	Reference(TW Core Organization)	維護此文件的機構 ref-1: SHALL have a contained resource if a local reference is provided
relatesTo	ΣN	0..*	BackboneElement	與其他文件的關係
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): 文件之間的關係類型；應填入所綁定值集中的其中一個代碼。
target	ΣCN	1..1	Reference(TW Core DocumentReference)	存在此關係的目標文件 ref-1: SHALL have a contained resource if a local reference is provided
description	Σ	0..1	string	人可讀的描述。
securityLabel	ΣN	0..*	CodeableConceptTW	文件的安全標籤(security-tags) Binding: All Security Labels (extensible): 應填入所綁定值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
content	SΣN	1..*	BackboneElement	被參照的文件
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣCN	1..1	Attachment	存取文件的位置 att-1: If the Attachment has data, it SHALL have a contentType UploadContent: 填寫格式：file://檔名.副檔名，例如：file://US01.jpg、file://PathologyReport01.pdf、file://GenReport01.pdf、file://王大明病歷.pdf
id		0..1	string	Unique id for inter-element referencing
extension	N	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 Bindings Purpose 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	基因報告名稱。 Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	ΣN	0..1	Coding	文件的格式/內容規則。 Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼，但不強制一定要使用此值集，你也可使用其他值集的代碼或單純以文字表示。
context	ΣN	0..1	BackboneElement	文件的臨床背景
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	CN	0..*	Reference(TW Core Encounter | EpisodeOfCare)	文件內容的臨床背景 ref-1: SHALL have a contained resource if a local reference is provided
event	N	0..*	CodeableConceptTW	正在記錄的主要臨床行為 Binding: v3 Code System ActCode (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
period	ΣCN	0..1	Period	被記錄的服務時間 per-1: If present, start SHALL have a lower value than end
facilityType	N	0..1	CodeableConcept	病人接受治療的機構類型 Binding: FacilityTypeCodeValueSet (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。
practiceSetting	N	0..1	CodeableConceptTW	內容創建的額外細節(例如：臨床專業) Binding: PracticeSettingCodeValueSet (example): 可參考所綁定值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
coding	SΣN	0..*	CodingTW	由專門術語系統（terminology system）定義的代碼
id		0..1	string	唯一可識別ID，以供資料項目間相互參照。
extension	N	0..*	Extension	擴充的資料項目 Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	專門術語系統（terminology system）的識別
version	Σ	0..1	string	系統的版本—如果相關的話
code	SΣ	0..1	code	系統定義的語法之符號
display	SΣ	0..1	string	由系統定義的表示法
userSelected	Σ	0..1	boolean	此編碼是否由使用者直接選擇？
text	SΣ	0..1	string	概念的文字表示法
sourcePatientInfo	CN	0..1	Reference(TW Core Patient)	來源的病人人口統計資料 ref-1: SHALL have a contained resource if a local reference is provided
related	CN	0..*	Reference(Resource)	相關的識別碼或resources ref-1: SHALL have a contained resource if a local reference is provided
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	Pattern: current http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
DocumentReference.type	extensible	LOINCDocumentType https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-type-doc-code
DocumentReference.category	extensible	LOINCDocumentClass https://twcore.mohw.gov.tw/ig/twcore/ValueSet/loinc-document-classcodes
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Pattern: application/pdf http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard
DocumentReference.content.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	preferred	DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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}$')
att-1	error	DocumentReference.content.attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
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()
per-1	error	DocumentReference.context.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	DocumentReference.subject, DocumentReference.author, DocumentReference.authenticator, DocumentReference.custodian, DocumentReference.relatesTo.target, DocumentReference.context.encounter, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from TWCoreDocumentReference

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• 病人資訊-Patient TWNGS (https://www.ghd.tw/cdm-fhir/StructureDefinition/Patient-twngs)

Other representations of profile: CSV, Excel, Schematron