HL7中国FHIR Connectathon测试实施指南 - Local Development build (v2025.3.12) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• 内容
• 详细描述
• 映射
• 示例
• XML
• JSON
• TTL

Resource Profile: 文档元数据本地化定义

文档元数据本地化定义。

Usage:

• Use this Resource Profile: 文档查询响应消息本地化定义 and 提交文档集请求消息本地化定义
• Refer to this Resource Profile: 提交集元数据本地化定义
• Examples for this Resource Profile: DocumentReference/DocumentReferenceExample01 and DocumentReference/DocumentReferenceExample02

Formal Views of Profile Content

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

• 关键元素表
• 差异表
• 快照表
• 统计/引用
• 所有

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	DocumentReference	A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	文档的类型。例如，可以指明当前文档类型为20类健康档案之一 Binding: 健康档案共享文档类型代码表 (required) ele-1: All FHIR elements must have a @value or children
category	Σ	1..1	CodeableConcept	文档的分类。包括：PHR、EHR、EMR Binding: 共享文档类别代码表 (required) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	Reference(Patient)	文档内记录的患者。指向患者资源 ele-1: All FHIR elements must have a @value or children
context	C	0..*	Reference(Appointment | Encounter | EpisodeOfCare)	Context of the document content ele-1: All FHIR elements must have a @value or children
facilityType	SC	0..1	CodeableConcept	文档记录业务活动的场所类型。 Binding: 设施类型代码表 (required) ele-1: All FHIR elements must have a @value or children
practiceSetting	SC	0..1	CodeableConcept	文档记录业务活动的医学专业。 Binding: 临床医学专业代码表 (required) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	文档记录业务活动的起止时间。 ele-1: All FHIR elements must have a @value or children
start	ΣC	1..1	dateTime	开始时间。 ele-1: All FHIR elements must have a @value or children
end	SΣC	0..1	dateTime	结束时间。如果存在结束时间则必须给出。 ele-1: All FHIR elements must have a @value or children
date	SΣ	0..1	instant	该文档元数据资源的生成时间 ele-1: All FHIR elements must have a @value or children
author	Σ	1..1	Reference(Practitioner)	文档的作者。一般指代文档记录业务活动的责任医师 ele-1: All FHIR elements must have a @value or children
relatesTo	SΣ	0..*	BackboneElement	指向其它文档，记录本文档与其它文档之间的关系。包括：替换、追加、转换、签名 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	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
code	Σ	1..1	CodeableConcept	The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. ele-1: All FHIR elements must have a @value or children
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship ele-1: All FHIR elements must have a @value or children
securityLabel	SΣ	0..*	CodeableConcept	记录文档的安全标签 Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
content	Σ	1..1	BackboneElement	Document referenced ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	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	Σ	1..1	Attachment	Where to access the document ele-1: All FHIR elements must have a @value or children
contentType	SΣC	1..1	code	文档内容的MimeType Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png
url	SΣ	1..1	url	指向存储文档的Binary资源的地址 ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png
size	SΣ	1..1	integer64	文档的大小。原始数据的大小，而不是进行Base64算法后的值 ele-1: All FHIR elements must have a @value or children
hash	SΣ	1..1	base64Binary	文档内容进行摘要算法的Base64编码值。摘要算法为性价比最高的SHA1 ele-1: All FHIR elements must have a @value or children
title	Σ	1..1	string	文档的标题 ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	文档的生成时间 ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	BackboneElement	Content profile rules for the document ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	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
value[x]	Σ	1..1	Coding	文档的格式，由此判定文档的处理规则 Binding: 文档处理格式代码表 (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard
DocumentReference.type	required	EHRDocumentType (a valid code from 健康档案共享文档类型代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/ehr-document-type from this IG
DocumentReference.category	required	DocumentCategory (a valid code from 共享文档类别代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-category from this IG
DocumentReference.facilityType	required	VSFacilityTypeCode http://hl7.org.cn/fhir/connectathon/ValueSet/facility-typecode from this IG
DocumentReference.practiceSetting	required	VSPracticeSettingCode http://hl7.org.cn/fhir/connectathon/ValueSet/practice-setting-code from this IG
DocumentReference.relatesTo.code	extensible	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard
DocumentReference.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard
DocumentReference.content.attachment.contentType	required	MimeTypes (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard
DocumentReference.content.profile.value[x]	required	VSDocumentFormatCode (a valid code from 文档处理格式代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-formatcode from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

该结构继承自 DocumentReference 。

Name	Flags	Card.	Type	Description & Constraints
DocumentReference			DocumentReference
type		1..1	CodeableConcept	文档的类型。例如，可以指明当前文档类型为20类健康档案之一 Binding: 健康档案共享文档类型代码表 (required)
category		1..1	CodeableConcept	文档的分类。包括：PHR、EHR、EMR Binding: 共享文档类别代码表 (required)
subject		1..1	Reference(Patient)	文档内记录的患者。指向患者资源
facilityType	S	0..1	CodeableConcept	文档记录业务活动的场所类型。 Binding: 设施类型代码表 (required)
practiceSetting	S	0..1	CodeableConcept	文档记录业务活动的医学专业。 Binding: 临床医学专业代码表 (required)
period	S	0..1	Period	文档记录业务活动的起止时间。
start		1..1	dateTime	开始时间。
end	S	0..1	dateTime	结束时间。如果存在结束时间则必须给出。
date	S	0..1	instant	该文档元数据资源的生成时间
author		1..1	Reference(Practitioner)	文档的作者。一般指代文档记录业务活动的责任医师
relatesTo	S	0..*	BackboneElement	指向其它文档，记录本文档与其它文档之间的关系。包括：替换、追加、转换、签名
securityLabel	S	0..*	CodeableConcept	记录文档的安全标签
content		1..1	BackboneElement	Document referenced
attachment
contentType	S	1..1	code	文档内容的MimeType
data		0..0
url	S	1..1	url	指向存储文档的Binary资源的地址
size	S	1..1	integer64	文档的大小。原始数据的大小，而不是进行Base64算法后的值
hash	S	1..1	base64Binary	文档内容进行摘要算法的Base64编码值。摘要算法为性价比最高的SHA1
title		1..1	string	文档的标题
creation	S	1..1	dateTime	文档的生成时间
profile		1..*	BackboneElement	Content profile rules for the document
value[x]		1..1	Coding	文档的格式，由此判定文档的处理规则 Binding: 文档处理格式代码表 (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.type	required	EHRDocumentType (a valid code from 健康档案共享文档类型代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/ehr-document-type from this IG
DocumentReference.category	required	DocumentCategory (a valid code from 共享文档类别代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-category from this IG
DocumentReference.facilityType	required	VSFacilityTypeCode http://hl7.org.cn/fhir/connectathon/ValueSet/facility-typecode from this IG
DocumentReference.practiceSetting	required	VSPracticeSettingCode http://hl7.org.cn/fhir/connectathon/ValueSet/practice-setting-code from this IG
DocumentReference.content.profile.value[x]	required	VSDocumentFormatCode (a valid code from 文档处理格式代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-formatcode from this IG

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	DocumentReference	A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifiers for the document
version	Σ	0..1	string	An explicitly assigned identifer of a variation of the content in the DocumentReference
basedOn		0..*	Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription)	Procedure that caused this media to be created
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document.
modality	Σ	0..*	CodeableConcept	Imaging modality used Binding: Modality (extensible): Type of acquired data in the instance.
type	Σ	1..1	CodeableConcept	文档的类型。例如，可以指明当前文档类型为20类健康档案之一 Binding: 健康档案共享文档类型代码表 (required)
category	Σ	1..1	CodeableConcept	文档的分类。包括：PHR、EHR、EMR Binding: 共享文档类别代码表 (required)
subject	Σ	1..1	Reference(Patient)	文档内记录的患者。指向患者资源
context	C	0..*	Reference(Appointment | Encounter | EpisodeOfCare)	Context of the document content
event		0..*	CodeableReference()	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
bodySite	Σ	0..*	CodeableReference(BodyStructure)	Body part included Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
facilityType	SC	0..1	CodeableConcept	文档记录业务活动的场所类型。 Binding: 设施类型代码表 (required)
practiceSetting	SC	0..1	CodeableConcept	文档记录业务活动的医学专业。 Binding: 临床医学专业代码表 (required)
period	SΣ	0..1	Period	文档记录业务活动的起止时间。
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	1..1	dateTime	开始时间。
end	SΣC	0..1	dateTime	结束时间。如果存在结束时间则必须给出。
date	SΣ	0..1	instant	该文档元数据资源的生成时间
author	Σ	1..1	Reference(Practitioner)	文档的作者。一般指代文档记录业务活动的责任医师
attester		0..*	BackboneElement	Attests to accuracy of the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	CodeableConcept	personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
time		0..1	dateTime	When the document was attested
party		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the document
custodian		0..1	Reference(Organization)	Organization which maintains the document
relatesTo	SΣ	0..*	BackboneElement	指向其它文档，记录本文档与其它文档之间的关系。包括：替换、追加、转换、签名
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship
description	Σ	0..1	markdown	Human-readable description
securityLabel	SΣ	0..*	CodeableConcept	记录文档的安全标签 Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
content	Σ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣC	1..1	code	文档内容的MimeType Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language. Additional Bindings Purpose CommonLanguages Starter Set Example General: en-AU
url	SΣ	1..1	url	指向存储文档的Binary资源的地址 Example General: http://www.acme.com/logo-small.png
size	SΣ	1..1	integer64	文档的大小。原始数据的大小，而不是进行Base64算法后的值
hash	SΣ	1..1	base64Binary	文档内容进行摘要算法的Base64编码值。摘要算法为性价比最高的SHA1
title	Σ	1..1	string	文档的标题 Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	文档的生成时间
height		0..1	positiveInt	Height of the image in pixels (photo/video)
width		0..1	positiveInt	Width of the image in pixels (photo/video)
frames		0..1	positiveInt	Number of frames if > 1 (photo)
duration		0..1	decimal	Length in seconds (audio / video)
pages		0..1	positiveInt	Number of printed pages
profile	Σ	1..*	BackboneElement	Content profile rules for the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value[x]	Σ	1..1	Coding	文档的格式，由此判定文档的处理规则 Binding: 文档处理格式代码表 (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
DocumentReference.modality	extensible	Modality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html from http://tx.fhir.org/r5
DocumentReference.type	required	EHRDocumentType (a valid code from 健康档案共享文档类型代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/ehr-document-type from this IG
DocumentReference.category	required	DocumentCategory (a valid code from 共享文档类别代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-category from this IG
DocumentReference.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
DocumentReference.facilityType	required	VSFacilityTypeCode http://hl7.org.cn/fhir/connectathon/ValueSet/facility-typecode from this IG
DocumentReference.practiceSetting	required	VSPracticeSettingCode http://hl7.org.cn/fhir/connectathon/ValueSet/practice-setting-code from this IG
DocumentReference.attester.mode	preferred	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard
DocumentReference.relatesTo.code	extensible	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard
DocumentReference.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard
DocumentReference.content.attachment.contentType	required	MimeTypes (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard
DocumentReference.content.attachment.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
DocumentReference.content.profile.value[x]	required	VSDocumentFormatCode (a valid code from 文档处理格式代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-formatcode from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

该结构继承自 DocumentReference 。

Summary

Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 1 element

关键元素视图

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	DocumentReference	A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	文档的类型。例如，可以指明当前文档类型为20类健康档案之一 Binding: 健康档案共享文档类型代码表 (required) ele-1: All FHIR elements must have a @value or children
category	Σ	1..1	CodeableConcept	文档的分类。包括：PHR、EHR、EMR Binding: 共享文档类别代码表 (required) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	Reference(Patient)	文档内记录的患者。指向患者资源 ele-1: All FHIR elements must have a @value or children
context	C	0..*	Reference(Appointment | Encounter | EpisodeOfCare)	Context of the document content ele-1: All FHIR elements must have a @value or children
facilityType	SC	0..1	CodeableConcept	文档记录业务活动的场所类型。 Binding: 设施类型代码表 (required) ele-1: All FHIR elements must have a @value or children
practiceSetting	SC	0..1	CodeableConcept	文档记录业务活动的医学专业。 Binding: 临床医学专业代码表 (required) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	文档记录业务活动的起止时间。 ele-1: All FHIR elements must have a @value or children
start	ΣC	1..1	dateTime	开始时间。 ele-1: All FHIR elements must have a @value or children
end	SΣC	0..1	dateTime	结束时间。如果存在结束时间则必须给出。 ele-1: All FHIR elements must have a @value or children
date	SΣ	0..1	instant	该文档元数据资源的生成时间 ele-1: All FHIR elements must have a @value or children
author	Σ	1..1	Reference(Practitioner)	文档的作者。一般指代文档记录业务活动的责任医师 ele-1: All FHIR elements must have a @value or children
relatesTo	SΣ	0..*	BackboneElement	指向其它文档，记录本文档与其它文档之间的关系。包括：替换、追加、转换、签名 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	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
code	Σ	1..1	CodeableConcept	The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. ele-1: All FHIR elements must have a @value or children
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship ele-1: All FHIR elements must have a @value or children
securityLabel	SΣ	0..*	CodeableConcept	记录文档的安全标签 Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
content	Σ	1..1	BackboneElement	Document referenced ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	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	Σ	1..1	Attachment	Where to access the document ele-1: All FHIR elements must have a @value or children
contentType	SΣC	1..1	code	文档内容的MimeType Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png
url	SΣ	1..1	url	指向存储文档的Binary资源的地址 ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png
size	SΣ	1..1	integer64	文档的大小。原始数据的大小，而不是进行Base64算法后的值 ele-1: All FHIR elements must have a @value or children
hash	SΣ	1..1	base64Binary	文档内容进行摘要算法的Base64编码值。摘要算法为性价比最高的SHA1 ele-1: All FHIR elements must have a @value or children
title	Σ	1..1	string	文档的标题 ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	文档的生成时间 ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	BackboneElement	Content profile rules for the document ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	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
value[x]	Σ	1..1	Coding	文档的格式，由此判定文档的处理规则 Binding: 文档处理格式代码表 (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard
DocumentReference.type	required	EHRDocumentType (a valid code from 健康档案共享文档类型代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/ehr-document-type from this IG
DocumentReference.category	required	DocumentCategory (a valid code from 共享文档类别代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-category from this IG
DocumentReference.facilityType	required	VSFacilityTypeCode http://hl7.org.cn/fhir/connectathon/ValueSet/facility-typecode from this IG
DocumentReference.practiceSetting	required	VSPracticeSettingCode http://hl7.org.cn/fhir/connectathon/ValueSet/practice-setting-code from this IG
DocumentReference.relatesTo.code	extensible	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard
DocumentReference.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard
DocumentReference.content.attachment.contentType	required	MimeTypes (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard
DocumentReference.content.profile.value[x]	required	VSDocumentFormatCode (a valid code from 文档处理格式代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-formatcode from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

差异视图

该结构继承自 DocumentReference 。

Name	Flags	Card.	Type	Description & Constraints
DocumentReference			DocumentReference
type		1..1	CodeableConcept	文档的类型。例如，可以指明当前文档类型为20类健康档案之一 Binding: 健康档案共享文档类型代码表 (required)
category		1..1	CodeableConcept	文档的分类。包括：PHR、EHR、EMR Binding: 共享文档类别代码表 (required)
subject		1..1	Reference(Patient)	文档内记录的患者。指向患者资源
facilityType	S	0..1	CodeableConcept	文档记录业务活动的场所类型。 Binding: 设施类型代码表 (required)
practiceSetting	S	0..1	CodeableConcept	文档记录业务活动的医学专业。 Binding: 临床医学专业代码表 (required)
period	S	0..1	Period	文档记录业务活动的起止时间。
start		1..1	dateTime	开始时间。
end	S	0..1	dateTime	结束时间。如果存在结束时间则必须给出。
date	S	0..1	instant	该文档元数据资源的生成时间
author		1..1	Reference(Practitioner)	文档的作者。一般指代文档记录业务活动的责任医师
relatesTo	S	0..*	BackboneElement	指向其它文档，记录本文档与其它文档之间的关系。包括：替换、追加、转换、签名
securityLabel	S	0..*	CodeableConcept	记录文档的安全标签
content		1..1	BackboneElement	Document referenced
attachment
contentType	S	1..1	code	文档内容的MimeType
data		0..0
url	S	1..1	url	指向存储文档的Binary资源的地址
size	S	1..1	integer64	文档的大小。原始数据的大小，而不是进行Base64算法后的值
hash	S	1..1	base64Binary	文档内容进行摘要算法的Base64编码值。摘要算法为性价比最高的SHA1
title		1..1	string	文档的标题
creation	S	1..1	dateTime	文档的生成时间
profile		1..*	BackboneElement	Content profile rules for the document
value[x]		1..1	Coding	文档的格式，由此判定文档的处理规则 Binding: 文档处理格式代码表 (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.type	required	EHRDocumentType (a valid code from 健康档案共享文档类型代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/ehr-document-type from this IG
DocumentReference.category	required	DocumentCategory (a valid code from 共享文档类别代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-category from this IG
DocumentReference.facilityType	required	VSFacilityTypeCode http://hl7.org.cn/fhir/connectathon/ValueSet/facility-typecode from this IG
DocumentReference.practiceSetting	required	VSPracticeSettingCode http://hl7.org.cn/fhir/connectathon/ValueSet/practice-setting-code from this IG
DocumentReference.content.profile.value[x]	required	VSDocumentFormatCode (a valid code from 文档处理格式代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-formatcode from this IG

快照视图

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	DocumentReference	A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifiers for the document
version	Σ	0..1	string	An explicitly assigned identifer of a variation of the content in the DocumentReference
basedOn		0..*	Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription)	Procedure that caused this media to be created
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document.
modality	Σ	0..*	CodeableConcept	Imaging modality used Binding: Modality (extensible): Type of acquired data in the instance.
type	Σ	1..1	CodeableConcept	文档的类型。例如，可以指明当前文档类型为20类健康档案之一 Binding: 健康档案共享文档类型代码表 (required)
category	Σ	1..1	CodeableConcept	文档的分类。包括：PHR、EHR、EMR Binding: 共享文档类别代码表 (required)
subject	Σ	1..1	Reference(Patient)	文档内记录的患者。指向患者资源
context	C	0..*	Reference(Appointment | Encounter | EpisodeOfCare)	Context of the document content
event		0..*	CodeableReference()	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
bodySite	Σ	0..*	CodeableReference(BodyStructure)	Body part included Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
facilityType	SC	0..1	CodeableConcept	文档记录业务活动的场所类型。 Binding: 设施类型代码表 (required)
practiceSetting	SC	0..1	CodeableConcept	文档记录业务活动的医学专业。 Binding: 临床医学专业代码表 (required)
period	SΣ	0..1	Period	文档记录业务活动的起止时间。
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	1..1	dateTime	开始时间。
end	SΣC	0..1	dateTime	结束时间。如果存在结束时间则必须给出。
date	SΣ	0..1	instant	该文档元数据资源的生成时间
author	Σ	1..1	Reference(Practitioner)	文档的作者。一般指代文档记录业务活动的责任医师
attester		0..*	BackboneElement	Attests to accuracy of the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	CodeableConcept	personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
time		0..1	dateTime	When the document was attested
party		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the document
custodian		0..1	Reference(Organization)	Organization which maintains the document
relatesTo	SΣ	0..*	BackboneElement	指向其它文档，记录本文档与其它文档之间的关系。包括：替换、追加、转换、签名
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship
description	Σ	0..1	markdown	Human-readable description
securityLabel	SΣ	0..*	CodeableConcept	记录文档的安全标签 Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
content	Σ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣC	1..1	code	文档内容的MimeType Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language. Additional Bindings Purpose CommonLanguages Starter Set Example General: en-AU
url	SΣ	1..1	url	指向存储文档的Binary资源的地址 Example General: http://www.acme.com/logo-small.png
size	SΣ	1..1	integer64	文档的大小。原始数据的大小，而不是进行Base64算法后的值
hash	SΣ	1..1	base64Binary	文档内容进行摘要算法的Base64编码值。摘要算法为性价比最高的SHA1
title	Σ	1..1	string	文档的标题 Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	文档的生成时间
height		0..1	positiveInt	Height of the image in pixels (photo/video)
width		0..1	positiveInt	Width of the image in pixels (photo/video)
frames		0..1	positiveInt	Number of frames if > 1 (photo)
duration		0..1	decimal	Length in seconds (audio / video)
pages		0..1	positiveInt	Number of printed pages
profile	Σ	1..*	BackboneElement	Content profile rules for the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value[x]	Σ	1..1	Coding	文档的格式，由此判定文档的处理规则 Binding: 文档处理格式代码表 (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
DocumentReference.modality	extensible	Modality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html from http://tx.fhir.org/r5
DocumentReference.type	required	EHRDocumentType (a valid code from 健康档案共享文档类型代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/ehr-document-type from this IG
DocumentReference.category	required	DocumentCategory (a valid code from 共享文档类别代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-category from this IG
DocumentReference.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
DocumentReference.facilityType	required	VSFacilityTypeCode http://hl7.org.cn/fhir/connectathon/ValueSet/facility-typecode from this IG
DocumentReference.practiceSetting	required	VSPracticeSettingCode http://hl7.org.cn/fhir/connectathon/ValueSet/practice-setting-code from this IG
DocumentReference.attester.mode	preferred	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard
DocumentReference.relatesTo.code	extensible	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard
DocumentReference.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard
DocumentReference.content.attachment.contentType	required	MimeTypes (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard
DocumentReference.content.attachment.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
DocumentReference.content.profile.value[x]	required	VSDocumentFormatCode (a valid code from 文档处理格式代码表) http://hl7.org.cn/fhir/connectathon/ValueSet/document-formatcode from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1	warning	DocumentReference	facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2	warning	DocumentReference	practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

该结构继承自 DocumentReference 。

Summary

Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 1 element

本 Profile 的其它表示法: CSV, Excel, Schematron