臺灣社政領域基礎實作指引
0.0.1 - ci-build

臺灣社政領域基礎實作指引, published by 衛生福利部社會及家庭署. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/sfaassn2025-source/base/ and changes regularly. See the Directory of published versions

Resource Profile: 共用公文-DocumentReference TWSS Base

Official URL: https://sfaa.gov.tw/base/StructureDefinition/DocumentReference-twss-base Version: 0.0.1
Draft as of 2026-10-21 Computable Name: DocumentReferenceTWSSBase

因 TW Core IG 0.3.2 尚無針對社福業務公文的 Profile,故繼承原生 DocumentReference,並於設定社福欄位後補回適用的 TW Core 0.3.2 共通交換規則。

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..* DocumentReference A reference to a document
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
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): The status of the document reference.
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept 公文類型
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.subject This element must be supported. This element is included in summaries. 0..1 Reference(個案資料-Patient TWSS Base) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
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. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime 核准文號日期或公文日期
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
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.related This element must be supported. 0..* Reference(申請或服務請求-ServiceRequest TWSS Base | 補助申請或核付明細-Claim TWSS Base | 補助審核或核付結果-ClaimResponse TWSS Base | 個案服務評估審核-Task TWSS Base | 個案轉介受理-Task TWSS Base | 個案轉介處理-Task TWSS Base | 個案評估或服務接觸-Encounter TWSS Base | 個案服務案件-EpisodeOfCare TWSS Base | 個案服務計畫-CarePlan TWSS Base | 社福表單回覆-QuestionnaireResponse TWSS Base | 同意-Consent TWSS Base) Related identifiers or resources

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 preferred Document Type Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.masterIdentifier This element must be supported. 0..1 Identifier 公文文號
DocumentReference.status This element must be supported. 1..1 code current | superseded | entered-in-error
DocumentReference.type This element must be supported. 0..1 CodeableConcept 公文類型
DocumentReference.date This element must be supported. 0..1 instant When this document reference was created
DocumentReference.content This element must be supported. 1..* BackboneElement Document referenced
DocumentReference.content.attachment This element must be supported. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.creation This element must be supported. 0..1 dateTime 核准文號日期或公文日期
DocumentReference.context
DocumentReference.context.related This element must be supported. 0..* Reference(申請或服務請求-ServiceRequest TWSS Base | 補助申請或核付明細-Claim TWSS Base | 補助審核或核付結果-ClaimResponse TWSS Base | 個案服務評估審核-Task TWSS Base | 個案轉介受理-Task TWSS Base | 個案轉介處理-Task TWSS Base | 個案評估或服務接觸-Encounter TWSS Base | 個案服務案件-EpisodeOfCare TWSS Base | 個案服務計畫-CarePlan TWSS Base | 社福表單回覆-QuestionnaireResponse TWSS Base | 同意-Consent TWSS Base) Related identifiers or resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
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 Other identifiers for the document
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): The status of the document reference.
DocumentReference.docStatus This element is included in summaries. 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept 公文類型
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.category This element is included in summaries. 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element must be supported. This element is included in summaries. 0..1 Reference(個案資料-Patient TWSS Base) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document
DocumentReference.relatesTo This element is included in summaries. 0..* BackboneElement Relationships to other documents
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): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
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. 1..1 Attachment Where to access the document
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 is included in summaries. 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
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 is included in summaries. 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
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 is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime 核准文號日期或公文日期
DocumentReference.content.format This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
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(Encounter | EpisodeOfCare) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
DocumentReference.context.sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
DocumentReference.context.related This element must be supported. 0..* Reference(申請或服務請求-ServiceRequest TWSS Base | 補助申請或核付明細-Claim TWSS Base | 補助審核或核付結果-ClaimResponse TWSS Base | 個案服務評估審核-Task TWSS Base | 個案轉介受理-Task TWSS Base | 個案轉介處理-Task TWSS Base | 個案評估或服務接觸-Encounter TWSS Base | 個案服務案件-EpisodeOfCare TWSS Base | 個案服務計畫-CarePlan TWSS Base | 社福表單回覆-QuestionnaireResponse TWSS Base | 同意-Consent TWSS Base) Related identifiers or 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 preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
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
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 DocumentReference

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
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): The status of the document reference.
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept 公文類型
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.subject This element must be supported. This element is included in summaries. 0..1 Reference(個案資料-Patient TWSS Base) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
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. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime 核准文號日期或公文日期
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
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.related This element must be supported. 0..* Reference(申請或服務請求-ServiceRequest TWSS Base | 補助申請或核付明細-Claim TWSS Base | 補助審核或核付結果-ClaimResponse TWSS Base | 個案服務評估審核-Task TWSS Base | 個案轉介受理-Task TWSS Base | 個案轉介處理-Task TWSS Base | 個案評估或服務接觸-Encounter TWSS Base | 個案服務案件-EpisodeOfCare TWSS Base | 個案服務計畫-CarePlan TWSS Base | 社福表單回覆-QuestionnaireResponse TWSS Base | 同意-Consent TWSS Base) Related identifiers or resources

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 preferred Document Type Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.masterIdentifier This element must be supported. 0..1 Identifier 公文文號
DocumentReference.status This element must be supported. 1..1 code current | superseded | entered-in-error
DocumentReference.type This element must be supported. 0..1 CodeableConcept 公文類型
DocumentReference.subject This element must be supported. 0..1 Reference(個案資料-Patient TWSS Base) Who/what is the subject of the document
DocumentReference.date This element must be supported. 0..1 instant When this document reference was created
DocumentReference.content This element must be supported. 1..* BackboneElement Document referenced
DocumentReference.content.attachment This element must be supported. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.creation This element must be supported. 0..1 dateTime 核准文號日期或公文日期
DocumentReference.context
DocumentReference.context.related This element must be supported. 0..* Reference(申請或服務請求-ServiceRequest TWSS Base | 補助申請或核付明細-Claim TWSS Base | 補助審核或核付結果-ClaimResponse TWSS Base | 個案服務評估審核-Task TWSS Base | 個案轉介受理-Task TWSS Base | 個案轉介處理-Task TWSS Base | 個案評估或服務接觸-Encounter TWSS Base | 個案服務案件-EpisodeOfCare TWSS Base | 個案服務計畫-CarePlan TWSS Base | 社福表單回覆-QuestionnaireResponse TWSS Base | 同意-Consent TWSS Base) Related identifiers or resources

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
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 Other identifiers for the document
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): The status of the document reference.
DocumentReference.docStatus This element is included in summaries. 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept 公文類型
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.category This element is included in summaries. 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element must be supported. This element is included in summaries. 0..1 Reference(個案資料-Patient TWSS Base) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document
DocumentReference.relatesTo This element is included in summaries. 0..* BackboneElement Relationships to other documents
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): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
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. 1..1 Attachment Where to access the document
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 is included in summaries. 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
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 is included in summaries. 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
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 is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime 核准文號日期或公文日期
DocumentReference.content.format This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
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(Encounter | EpisodeOfCare) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
DocumentReference.context.sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
DocumentReference.context.related This element must be supported. 0..* Reference(申請或服務請求-ServiceRequest TWSS Base | 補助申請或核付明細-Claim TWSS Base | 補助審核或核付結果-ClaimResponse TWSS Base | 個案服務評估審核-Task TWSS Base | 個案轉介受理-Task TWSS Base | 個案轉介處理-Task TWSS Base | 個案評估或服務接觸-Encounter TWSS Base | 個案服務案件-EpisodeOfCare TWSS Base | 個案服務計畫-CarePlan TWSS Base | 社福表單回覆-QuestionnaireResponse TWSS Base | 同意-Consent TWSS Base) Related identifiers or 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 preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
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
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 DocumentReference

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

此 Profile 使用 FHIR R4 DocumentReference Resource;伺服端建議(SHOULD)支援以下 FHIR 原生查詢參數: 完整定義請參考 FHIR R4 DocumentReference 原生查詢參數。

查詢參數 類型 查詢範例
_content string GET [base]/_content=[value]
_filter special GET [base]/_filter=[value]
_id token GET [base]/DocumentReference/[id]
_lastUpdated date GET [base]/_lastUpdated=[value]
_profile uri GET [base]/_profile=[value]
_query token GET [base]/_query=[value]
_security token GET [base]/_security=[value]
_source uri GET [base]/_source=[value]
_tag token GET [base]/_tag=[value]
_text string GET [base]/_text=[value]
authenticator reference GET [base]/authenticator=[value]
author reference GET [base]/author=[value]
category token GET [base]/category=[value]
contenttype token GET [base]/contenttype=[value]
custodian reference GET [base]/custodian=[value]
date date GET [base]/date=[value]
description string GET [base]/description=[value]
encounter reference GET [base]/encounter=[value]
event token GET [base]/event=[value]
facility token GET [base]/facility=[value]
format token GET [base]/format=[value]
identifier token GET [base]/identifier=[value]
language token GET [base]/language=[value]
location uri GET [base]/location=[value]
patient reference GET [base]/patient=[value]
period date GET [base]/period=[value]
related reference GET [base]/related=[value]
relatesto reference GET [base]/relatesto=[value]
relation token GET [base]/relation=[value]
relationship composite GET [base]/relationship=[value]
security-label token GET [base]/security-label=[value]
setting token GET [base]/setting=[value]
status token GET [base]/status=[value]
subject reference GET [base]/subject=[value]
type token GET [base]/type=[value]