HL7中国FHIR Connectathon测试实施指南
V20230304 - release
本指南适用于HL7中国的FHIR Connectathon测试。
Defining URL: | http://hl7.org.cn/fhir/StructureDefinition/profile-documentmanifest-xds |
Version: | V20230304 |
Name: | XDSDocumentManifest |
Title: | 提交集元数据本地化定义 |
Status: | Active as of 2023-03-04T16:13:14+08:00 |
Definition: | 提交集元数据本地化定义。 |
Publisher: | HL7中国 |
Source Resource: | XML / JSON / Turtle |
本定义的正式URL为:
http://hl7.org.cn/fhir/StructureDefinition/profile-documentmanifest-xds
这种结构源自 DocumentManifest
这种结构源自 DocumentManifest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | 0..* | DocumentManifest | A list that defines a set of documents | |
masterIdentifier | S | 1..1 | Identifier | 提交集的唯一标识。在XDS规范一般为OID类型 |
status | 1..1 | code | 提交集的状态,默认取值为current。 | |
type | 0..1 | CodeableConcept | 提交集的类型。 Binding: 共享文档类别代码表 (required) | |
subject | 1..1 | Reference(Patient) | 提交集记录的患者。指向患者资源 | |
created | 1..1 | dateTime | 提交集的生成时间 | |
author | 1..* | Reference(Practitioner | Organization) | 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。 | |
source | 1..1 | uri | 标识来源系统。该提交集是由哪一个应用系统提交的。 | |
content | S | 1..* | Reference(文档元数据本地化定义) | 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用 |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | 0..* | DocumentManifest | A list that defines a set of documents | |
id | Σ | 0..1 | string | 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: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
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 |
masterIdentifier | SΣ | 1..1 | Identifier | 提交集的唯一标识。在XDS规范一般为OID类型 |
identifier | Σ | 0..* | Identifier | Other identifiers for the manifest |
status | ?!Σ | 1..1 | code | 提交集的状态,默认取值为current。 Binding: DocumentReferenceStatus (required): The status of the document reference. |
type | Σ | 0..1 | CodeableConcept | 提交集的类型。 Binding: 共享文档类别代码表 (required) |
subject | Σ | 1..1 | Reference(Patient) | 提交集记录的患者。指向患者资源 |
created | 1..1 | dateTime | 提交集的生成时间 | |
author | Σ | 1..* | Reference(Practitioner | Organization) | 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。 |
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | |
source | 1..1 | uri | 标识来源系统。该提交集是由哪一个应用系统提交的。 | |
description | Σ | 0..1 | string | Human-readable description (title) |
content | SΣ | 1..* | Reference(文档元数据本地化定义) | 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用 |
related | 0..* | BackboneElement | Related things | |
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 |
identifier | 0..1 | Identifier | Identifiers of things that are related | |
ref | 0..1 | Reference(Resource) | Related Resource | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | 0..* | DocumentManifest | A list that defines a set of documents | |
masterIdentifier | Σ | 1..1 | Identifier | 提交集的唯一标识。在XDS规范一般为OID类型 |
content | Σ | 1..* | Reference(文档元数据本地化定义) | 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用 |
Documentation for this format |
这种结构源自 DocumentManifest
差异视图
这种结构源自 DocumentManifest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | 0..* | DocumentManifest | A list that defines a set of documents | |
masterIdentifier | S | 1..1 | Identifier | 提交集的唯一标识。在XDS规范一般为OID类型 |
status | 1..1 | code | 提交集的状态,默认取值为current。 | |
type | 0..1 | CodeableConcept | 提交集的类型。 Binding: 共享文档类别代码表 (required) | |
subject | 1..1 | Reference(Patient) | 提交集记录的患者。指向患者资源 | |
created | 1..1 | dateTime | 提交集的生成时间 | |
author | 1..* | Reference(Practitioner | Organization) | 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。 | |
source | 1..1 | uri | 标识来源系统。该提交集是由哪一个应用系统提交的。 | |
content | S | 1..* | Reference(文档元数据本地化定义) | 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用 |
Documentation for this format |
快照视图
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | 0..* | DocumentManifest | A list that defines a set of documents | |
id | Σ | 0..1 | string | 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: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
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 |
masterIdentifier | SΣ | 1..1 | Identifier | 提交集的唯一标识。在XDS规范一般为OID类型 |
identifier | Σ | 0..* | Identifier | Other identifiers for the manifest |
status | ?!Σ | 1..1 | code | 提交集的状态,默认取值为current。 Binding: DocumentReferenceStatus (required): The status of the document reference. |
type | Σ | 0..1 | CodeableConcept | 提交集的类型。 Binding: 共享文档类别代码表 (required) |
subject | Σ | 1..1 | Reference(Patient) | 提交集记录的患者。指向患者资源 |
created | 1..1 | dateTime | 提交集的生成时间 | |
author | Σ | 1..* | Reference(Practitioner | Organization) | 提交集的作者。视提交集中的文档、提交集的创建环境的不同而选择不同的引用资源。 |
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | |
source | 1..1 | uri | 标识来源系统。该提交集是由哪一个应用系统提交的。 | |
description | Σ | 0..1 | string | Human-readable description (title) |
content | SΣ | 1..* | Reference(文档元数据本地化定义) | 提交集中包含的DocumentReference。在Bundle资源中通过entry.fullUrl中的UUID标识进行引用 |
related | 0..* | BackboneElement | Related things | |
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 |
identifier | 0..1 | Identifier | Identifiers of things that are related | |
ref | 0..1 | Reference(Resource) | Related Resource | |
Documentation for this format |
本定义的其它表示法: Schematron
Path | Conformance | ValueSet |
DocumentManifest.language | preferred | CommonLanguages Max Binding: AllLanguages |
DocumentManifest.status | required | DocumentReferenceStatus |
DocumentManifest.type | required | DocumentCategory |
Id | Path | Details | Requirements |
dom-2 | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | DocumentManifest | 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 | DocumentManifest | 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 | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | DocumentManifest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | DocumentManifest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DocumentManifest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DocumentManifest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DocumentManifest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DocumentManifest.masterIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.related | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.related.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DocumentManifest.related.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DocumentManifest.related.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DocumentManifest.related.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DocumentManifest.related.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentManifest.related.ref | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |