HL7中国FHIR Connectathon测试实施指南
2025.3.12 - release

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

Resource Profile: 提交集元数据本地化定义

官方URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/profile-documentmanifest-xds 版本: 2025.3.12
Draft as of 2025-03-11 机读名称: XDSDocumentManifest

提交集元数据本地化定义。

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
lst-1: A list can only have an emptyReason if it is empty
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:SourceId 1..1 Identifier 提交集来源
URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/ext-documentManifest-sourceId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier S 1..1 Identifier 提交集的唯一标识。在XDS规范一般为OID类型
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code 提交集的状态,默认取值为current。
Binding: ListStatus (required): The current state of the list.


ele-1: All FHIR elements must have a @value or children
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


ele-1: All FHIR elements must have a @value or children
... code Σ 0..1 CodeableConcept 提交集的类型: SubmissionSet | Folder。
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
... date Σ 1..1 dateTime 提交集的生成时间
ele-1: All FHIR elements must have a @value or children
... source Σ 0..1 Reference(Practitioner) 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。
ele-1: All FHIR elements must have a @value or children
... entry C 1..* BackboneElement 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用
ele-1: All FHIR elements must have a @value or children
This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy.
.... 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
.... deleted ?! 0..1 boolean If this item is actually marked as deleted
ele-1: All FHIR elements must have a @value or children
.... item 1..1 Reference(文档元数据本地化定义) Actual entry
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|5.0.0
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|5.0.0
from the FHIR Standard
List.coderequiredManifestCategoryCodes (a valid code from 提交集类型代码表)
http://hl7.org.cn/fhir/connectathon/ValueSet/manifest-category-codes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()

该结构继承自 List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List List
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SourceId 1..1 Identifier 提交集来源
URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/ext-documentManifest-sourceId
... identifier S 1..1 Identifier 提交集的唯一标识。在XDS规范一般为OID类型
... status 1..1 code 提交集的状态,默认取值为current。
... subject 1..1 Reference(Patient) 提交集记录的患者。指向患者资源
... date 1..1 dateTime 提交集的生成时间
... source 0..1 Reference(Practitioner) 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。
... entry 1..* BackboneElement 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用
.... item 1..1 Reference(文档元数据本地化定义) Actual entry

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.coderequiredManifestCategoryCodes (a valid code from 提交集类型代码表)
http://hl7.org.cn/fhir/connectathon/ValueSet/manifest-category-codes
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SourceId 1..1 Identifier 提交集来源
URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/ext-documentManifest-sourceId
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier S 1..1 Identifier 提交集的唯一标识。在XDS规范一般为OID类型
... status ?!Σ 1..1 code 提交集的状态,默认取值为current。
Binding: ListStatus (required): The current state of the list.

... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 0..1 CodeableConcept 提交集的类型: SubmissionSet | Folder。
Binding: 提交集类型代码表 (required)
... subject Σ 1..1 Reference(Patient) 提交集记录的患者。指向患者资源
... encounter 0..1 Reference(Encounter) Context in which list created
... date Σ 1..1 dateTime 提交集的生成时间
... source Σ 0..1 Reference(Practitioner) 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。
... orderedBy 0..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..* Annotation Comments about the list
... entry C 1..* BackboneElement 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用
This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy.
.... 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
.... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?! 0..1 boolean If this item is actually marked as deleted
.... date 0..1 dateTime When item added to list
.... item 1..1 Reference(文档元数据本地化定义) Actual entry
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|5.0.0
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|5.0.0
from the FHIR Standard
List.coderequiredManifestCategoryCodes (a valid code from 提交集类型代码表)
http://hl7.org.cn/fhir/connectathon/ValueSet/manifest-category-codes
from this IG
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()

该结构继承自 List

Summary

Mandatory: 6 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

关键元素视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
lst-1: A list can only have an emptyReason if it is empty
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:SourceId 1..1 Identifier 提交集来源
URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/ext-documentManifest-sourceId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier S 1..1 Identifier 提交集的唯一标识。在XDS规范一般为OID类型
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code 提交集的状态,默认取值为current。
Binding: ListStatus (required): The current state of the list.


ele-1: All FHIR elements must have a @value or children
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


ele-1: All FHIR elements must have a @value or children
... code Σ 0..1 CodeableConcept 提交集的类型: SubmissionSet | Folder。
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
... date Σ 1..1 dateTime 提交集的生成时间
ele-1: All FHIR elements must have a @value or children
... source Σ 0..1 Reference(Practitioner) 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。
ele-1: All FHIR elements must have a @value or children
... entry C 1..* BackboneElement 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用
ele-1: All FHIR elements must have a @value or children
This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy.
.... 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
.... deleted ?! 0..1 boolean If this item is actually marked as deleted
ele-1: All FHIR elements must have a @value or children
.... item 1..1 Reference(文档元数据本地化定义) Actual entry
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|5.0.0
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|5.0.0
from the FHIR Standard
List.coderequiredManifestCategoryCodes (a valid code from 提交集类型代码表)
http://hl7.org.cn/fhir/connectathon/ValueSet/manifest-category-codes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()

差异视图

该结构继承自 List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List List
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SourceId 1..1 Identifier 提交集来源
URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/ext-documentManifest-sourceId
... identifier S 1..1 Identifier 提交集的唯一标识。在XDS规范一般为OID类型
... status 1..1 code 提交集的状态,默认取值为current。
... subject 1..1 Reference(Patient) 提交集记录的患者。指向患者资源
... date 1..1 dateTime 提交集的生成时间
... source 0..1 Reference(Practitioner) 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。
... entry 1..* BackboneElement 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用
.... item 1..1 Reference(文档元数据本地化定义) Actual entry

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.coderequiredManifestCategoryCodes (a valid code from 提交集类型代码表)
http://hl7.org.cn/fhir/connectathon/ValueSet/manifest-category-codes
from this IG

快照视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SourceId 1..1 Identifier 提交集来源
URL: http://hl7.org.cn/fhir/connectathon/StructureDefinition/ext-documentManifest-sourceId
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier S 1..1 Identifier 提交集的唯一标识。在XDS规范一般为OID类型
... status ?!Σ 1..1 code 提交集的状态,默认取值为current。
Binding: ListStatus (required): The current state of the list.

... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 0..1 CodeableConcept 提交集的类型: SubmissionSet | Folder。
Binding: 提交集类型代码表 (required)
... subject Σ 1..1 Reference(Patient) 提交集记录的患者。指向患者资源
... encounter 0..1 Reference(Encounter) Context in which list created
... date Σ 1..1 dateTime 提交集的生成时间
... source Σ 0..1 Reference(Practitioner) 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。
... orderedBy 0..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..* Annotation Comments about the list
... entry C 1..* BackboneElement 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用
This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy.
.... 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
.... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?! 0..1 boolean If this item is actually marked as deleted
.... date 0..1 dateTime When item added to list
.... item 1..1 Reference(文档元数据本地化定义) Actual entry
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|5.0.0
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|5.0.0
from the FHIR Standard
List.coderequiredManifestCategoryCodes (a valid code from 提交集类型代码表)
http://hl7.org.cn/fhir/connectathon/ValueSet/manifest-category-codes
from this IG
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()

该结构继承自 List

Summary

Mandatory: 6 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

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