臺灣核心實作指引(TW Core IG)
0.2.0 - Trial Use

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.2.0: Releases) 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: TW Core DocumentReference

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/DocumentReference-twcore Version: 0.2.0
Active as of 2024-03-21 Computable Name: TWCoreDocumentReference

此臺灣核心-文件參照(TW Core DocumentReference) Profile說明本IG如何進一步定義FHIR的DocumentReference Resource以呈現文件參照的詳細資料。

Resource DocumentReference - 內容

這是一個指向任何種類、用於任何用途的文件的參照。它提供了文件的基本資訊,幫助我們找到並管理這個文件。文件可以是任何有MIME類型的序列化物件,包括專門針對病人的正式文件(如CDA)、臨床筆記、掃描過的紙本文件,以及像是政策文件這樣不特定於病人的文件。

範圍與使用

DocumentReference resource 是用來索引文件、臨床筆記和其他以二進制格式存儲的資料物件,使它們能被醫療系統存取。文件是一系列可以被識別的位元組序列,它建立了自己的上下文(例如:可以向使用者展示什麼主題、作者等),並且有明確的更新管理。DocumentReference resource 可以用於任何具有公認MIME類型且符合此定義的文件格式。

通常,DocumentReference resources 被用在文件索引系統中,像是IHE XDS,如同在IHE行動式存取健康紀錄文件(Mobile access to Health Documents,MHD))中概述的那樣。

DocumentReference是描述文件的metadata,比如:

  • 在FHIR系統中的CDA文件
  • 存儲在其他地方的FHIR文件(即遵循XDS Profile的註冊中心/儲存庫)
  • PDF文件、掃描的紙本文件和傳真的數位紀錄
  • 各種形式的臨床筆記
  • 影像文件(例如:JPEG、GIF、TIFF)
  • 非標準格式(例如:WORD)
  • 其他類型的文件,如處方或疫苗接種記錄

界限與關聯

FHIR不僅定義文件格式,還定義了文件參照DocumentReference。FHIR文件是指那些在FHIR中創建和組裝的文件,DocumentReference主要是透用參照找到那些已經組裝好的文件。

被參照的文件可以是另一個伺服器上的FHIR文件、或者儲存在特殊的FHIR 二進制 resource (Binary Resource)中,或者存儲在其他任何伺服器上。DocumentReference也能夠指向透過服務呼叫來查詢文件,例如XDS.b的RetrieveDocumentSet操作、DICOM交換、或是HL7 v2訊息查詢 — 但這些服務的具體運作方式需要在其外部標準或其他文件中明確說明。

DocumentReference 描述另一份文件,這意味著這裡涉及到兩套「基本資訊(provenance)」,意即「文件本身」以及「DocumentReference」的出處、版本號、創建日期等基本資訊。有時候,這些基本資訊是密切相關的,比如當文件製作者也製作了 DocuementReference 時;但在其他工作流中,DocumentReference 可能由其他角色在後續階段產生。在 DocumentReference resource 中, meta 內容段指的是參照本身的基本資訊,而其 resource下半部內容描述涉及它所參照的文件。 就像其他所有 resources 一樣, DocumentReference resource 主要資訊和在Provenance resource 中的資訊之間有重疊。這在Provenance resource的描述有討論。

這個 resource 被許多其他 FHIR resources 參照,包括醫療不良事件(AdverseEvent)、照護計畫(CarePlan)、通訊 (Communication)、 通訊請求(CommunicationRequest)、同意書(Consent)、合約(Contract)、設備請求(DeviceRequest)、設備使用聲明(DeviceUseStatement)、文件參照(DocumentReference)、家庭成員病史(FamilyMemberHistory)、指導回應(GuidanceResponse)、影像檢査(ImagingStudy)、 藥品知識(MedicationKnowledge)、醫藥產品(MedicinalProduct)、檢驗檢查(Observation)、 處置(Procedure)、一組請求(RequestGroup)、 風險評估(RiskAssessment)、服務請求(ServiceRequest)、物質參照資訊(SubstanceReferenceInformation)、物質規格(SubstanceSpecification)及供應品請求(SupplyRequest)DocumentReference resource 在FHIR框架中扮演著一個重要的角色,連接不同的 resources 和提供關於文件的重要基本資訊。

Usage:

Formal Views of Profile Content

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReference文件的參照
... id 0..1id不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta 0..1Meta此DocumentReference Resource的metadata
... implicitRules 0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeDocumentReference Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier S0..1Identifier主版本的識別碼
... identifier 0..*Identifier文件的其他的識別碼
... status S1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。

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

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

... category S0..*CodeableConceptTW文件的類別
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

... subject S1..1Reference(TW Core Patient | TW Core Practitioner | Group | Device)文件描述的對象是誰/是什麼?
... date S0..1instant文件參照的創建時間是何時?
... author S0..*Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson)誰以及/或什麼創建了文件
... authenticator 0..1Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)誰/什麼對文件進行了認證
... custodian 0..1Reference(TW Core Organization)維護此文件的機構
... relatesTo 0..*BackboneElement與其他文件的關係
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

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

... content S1..*BackboneElement被參照的文件
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... attachment 1..1Attachment存取文件的位置
.... format 0..1Coding文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context 0..1BackboneElement文件的臨床背景
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... encounter 0..*Reference(TW Core Encounter | EpisodeOfCare)文件內容的臨床背景
.... event 0..*CodeableConceptTW正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

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

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

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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
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.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
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReference文件的參照
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此DocumentReference Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeDocumentReference Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ0..1Identifier主版本的識別碼
... identifier Σ0..*Identifier文件的其他的識別碼
... status ?!SΣ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。

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

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

... category S0..*CodeableConceptTW文件的類別
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... subject SΣ1..1Reference(TW Core Patient | TW Core Practitioner | Group | Device)文件描述的對象是誰/是什麼?
... date SΣ0..1instant文件參照的創建時間是何時?
... author SΣ0..*Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson)誰以及/或什麼創建了文件
... authenticator 0..1Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)誰/什麼對文件進行了認證
... custodian 0..1Reference(TW Core Organization)維護此文件的機構
... relatesTo Σ0..*BackboneElement與其他文件的關係
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

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


... content SΣ1..*BackboneElement被參照的文件
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... attachment Σ1..1Attachment存取文件的位置
.... format Σ0..1Coding文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context Σ0..1BackboneElement文件的臨床背景
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... encounter 0..*Reference(TW Core Encounter | EpisodeOfCare)文件內容的臨床背景
.... event 0..*CodeableConceptTW正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


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

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

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
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.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
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReference文件的參照
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此DocumentReference Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeDocumentReference Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ0..1Identifier主版本的識別碼
... identifier Σ0..*Identifier文件的其他的識別碼
... status ?!SΣ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。

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

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

... category S0..*CodeableConceptTW文件的類別
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... subject SΣ1..1Reference(TW Core Patient | TW Core Practitioner | Group | Device)文件描述的對象是誰/是什麼?
... date SΣ0..1instant文件參照的創建時間是何時?
... author SΣ0..*Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson)誰以及/或什麼創建了文件
... authenticator 0..1Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)誰/什麼對文件進行了認證
... custodian 0..1Reference(TW Core Organization)維護此文件的機構
... relatesTo Σ0..*BackboneElement與其他文件的關係
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

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


... content SΣ1..*BackboneElement被參照的文件
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... attachment Σ1..1Attachment存取文件的位置
.... format Σ0..1Coding文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context Σ0..1BackboneElement文件的臨床背景
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... encounter 0..*Reference(TW Core Encounter | EpisodeOfCare)文件內容的臨床背景
.... event 0..*CodeableConceptTW正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


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

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

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
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.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
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()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReference文件的參照
... id 0..1id不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta 0..1Meta此DocumentReference Resource的metadata
... implicitRules 0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeDocumentReference Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier S0..1Identifier主版本的識別碼
... identifier 0..*Identifier文件的其他的識別碼
... status S1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。

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

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

... category S0..*CodeableConceptTW文件的類別
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

... subject S1..1Reference(TW Core Patient | TW Core Practitioner | Group | Device)文件描述的對象是誰/是什麼?
... date S0..1instant文件參照的創建時間是何時?
... author S0..*Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson)誰以及/或什麼創建了文件
... authenticator 0..1Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)誰/什麼對文件進行了認證
... custodian 0..1Reference(TW Core Organization)維護此文件的機構
... relatesTo 0..*BackboneElement與其他文件的關係
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

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

... content S1..*BackboneElement被參照的文件
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... attachment 1..1Attachment存取文件的位置
.... format 0..1Coding文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context 0..1BackboneElement文件的臨床背景
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... encounter 0..*Reference(TW Core Encounter | EpisodeOfCare)文件內容的臨床背景
.... event 0..*CodeableConceptTW正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

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

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

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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
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.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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReference文件的參照
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此DocumentReference Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeDocumentReference Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ0..1Identifier主版本的識別碼
... identifier Σ0..*Identifier文件的其他的識別碼
... status ?!SΣ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。

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

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

... category S0..*CodeableConceptTW文件的類別
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... subject SΣ1..1Reference(TW Core Patient | TW Core Practitioner | Group | Device)文件描述的對象是誰/是什麼?
... date SΣ0..1instant文件參照的創建時間是何時?
... author SΣ0..*Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson)誰以及/或什麼創建了文件
... authenticator 0..1Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)誰/什麼對文件進行了認證
... custodian 0..1Reference(TW Core Organization)維護此文件的機構
... relatesTo Σ0..*BackboneElement與其他文件的關係
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

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


... content SΣ1..*BackboneElement被參照的文件
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... attachment Σ1..1Attachment存取文件的位置
.... format Σ0..1Coding文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context Σ0..1BackboneElement文件的臨床背景
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... encounter 0..*Reference(TW Core Encounter | EpisodeOfCare)文件內容的臨床背景
.... event 0..*CodeableConceptTW正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


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

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

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
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.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
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReference文件的參照
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的DocumentReference紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此DocumentReference Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeDocumentReference Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... masterIdentifier SΣ0..1Identifier主版本的識別碼
... identifier Σ0..*Identifier文件的其他的識別碼
... status ?!SΣ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): 文件參照的狀態;應填入所綁定值集中的其中一個代碼。

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

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

... category S0..*CodeableConceptTW文件的類別
Binding: DocumentClassValueSet (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。


... subject SΣ1..1Reference(TW Core Patient | TW Core Practitioner | Group | Device)文件描述的對象是誰/是什麼?
... date SΣ0..1instant文件參照的創建時間是何時?
... author SΣ0..*Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | Device | TW Core Patient | RelatedPerson)誰以及/或什麼創建了文件
... authenticator 0..1Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization)誰/什麼對文件進行了認證
... custodian 0..1Reference(TW Core Organization)維護此文件的機構
... relatesTo Σ0..*BackboneElement與其他文件的關係
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): 文件之間的關係類型;應填入所綁定值集中的其中一個代碼。

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


... content SΣ1..*BackboneElement被參照的文件
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... attachment Σ1..1Attachment存取文件的位置
.... format Σ0..1Coding文件的格式/內容規則。
Binding: DocumentReferenceFormatCodeSet (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。

... context Σ0..1BackboneElement文件的臨床背景
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... encounter 0..*Reference(TW Core Encounter | EpisodeOfCare)文件內容的臨床背景
.... event 0..*CodeableConceptTW正在記錄的主要臨床行為
Binding: v3 Code System ActCode (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


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

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

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.categoryextensibleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
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.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
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()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明

建議應該支援以下查詢參數:

  1. 建議應該(SHOULD) 支援透過查詢參數 _id 查詢所有DocumentReference:
    (如何透過token查詢)
    GET [base]/DocumentReference?_id=[id]
    GET [base]/DocumentReference/[id]

    例子:
    (1) GET [base]/DocumentReference?_id=documentReference-example

    (2) GET [base]/DocumentReference/documentReference-example

  2. 建議應該(SHOULD) 支援透過查詢參數 status 查詢所有DocumentReference:
    (如何透過token查詢)
    GET [base]/DocumentReference?status=[code]

    例子:
    (1) GET [base]/DocumentReference?status=completed

  3. 建議應該(SHOULD) 支援透過查詢參數 subject 查詢所有DocumentReference:
    (如何透過reference查詢)
    GET [base]/DocumentReference?subject={Type/}[id]

    例子:
    (1) GET [base]/DocumentReference?subject=Patient/pat-example