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

本指南适用于HL7中国的FHIR Connectathon测试。

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

Defining URL:http://hl7.org.cn/fhir/StructureDefinition/profile-documentmanifest-xds
Version:2024.5.5
Name:XDSDocumentManifest
Title:提交集元数据本地化定义
Status:Active as of 2024-05-05 21:11:47+0800
Definition:

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

Publisher:HL7中国. HL7中国,
Source Resource:XML / JSON / Turtle

本定义的正式URL为: 

http://hl7.org.cn/fhir/StructureDefinition/profile-documentmanifest-xds

定义内容的视图

关于定义、差异、快照以及如何解读这些表示法。

这种结构源自 List

Summary

Mandatory: 6 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

这种结构源自 List

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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C0..*ListA list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... SourceId 1..1Identifier提交集来源
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-documentManifest-sourceId
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier S1..1Identifier提交集的唯一标识。在XDS规范一般为OID类型
... status ?!Σ1..1code提交集的状态，默认取值为current。
Binding: ListStatus (required): The current state of the list.

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

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

... note 0..*AnnotationComments about the list
... entry C1..*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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag 0..1CodeableConceptStatus/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..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(文档元数据本地化定义)Actual entry
... emptyReason C0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list is a curated collection of resources
... identifier 1..1Identifier提交集的唯一标识。在XDS规范一般为OID类型

doco Documentation for this format

这种结构源自 List

Summary

Mandatory: 6 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

差异视图

这种结构源自 List

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

doco Documentation for this format

快照视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C0..*ListA list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... SourceId 1..1Identifier提交集来源
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-documentManifest-sourceId
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier S1..1Identifier提交集的唯一标识。在XDS规范一般为OID类型
... status ?!Σ1..1code提交集的状态，默认取值为current。
Binding: ListStatus (required): The current state of the list.

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

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

... note 0..*AnnotationComments about the list
... entry C1..*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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag 0..1CodeableConceptStatus/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..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(文档元数据本地化定义)Actual entry
... emptyReason C0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

 

本定义的其它表示法: Schematron

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/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()