HL7中国FHIR Connectathon测试实施指南
V20230304 - release
HL7中国FHIR Connectathon测试实施指南
V20230304 - release
本指南适用于HL7中国的FHIR Connectathon测试。
| Defining URL: | http://hl7.org.cn/fhir/StructureDefinition/profile-ProvideDocumentBundleResponse |
| Version: | V20230304 |
| Name: | ProvideDocumentBundleResponse |
| 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-ProvideDocumentBundleResponse
这种结构源自 Bundle
这种结构源自 Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  type | 1..1 | code | Bundle资源的类型。在本规范中必须为transaction-response。 Required Pattern: transaction-response | |
| total | 0..0 | |||
| link | 0..0 | |||
 entry | 1..* | BackboneElement | 记录对请求消息中资源执行的结果。注意：响应消息中资源的排序必须与请求消息中的资源排序一致。 | |
 fullUrl | 0..0 | |||
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 0..0 | |||
| response | 1..1 | BackboneElement | 记录了对单个资源的执行结果 | |
 status | 1..1 | string | 对单个资源执行的状态码 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
 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. | |
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
| type | Σ | 1..1 | code | Bundle资源的类型。在本规范中必须为transaction-response。 Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: transaction-response |
| timestamp | Σ | 0..1 | instant | When the bundle was assembled |
 entry | ΣI | 1..* | BackboneElement | 记录对请求消息中资源执行的结果。注意：响应消息中资源的排序必须与请求消息中的资源排序一致。 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
 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 |
| link | Σ | 0..* | See link (Bundle) | Links related to this entry |
| response | ΣI | 1..1 | 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 |
| status | Σ | 1..1 | string | 对单个资源执行的状态码 |
| location | Σ | 0..1 | uri | The location (if the operation returns a location) |
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| Documentation for this format | ||||
这种结构源自 Bundle
差异视图
这种结构源自 Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| type | 1..1 | code | Bundle资源的类型。在本规范中必须为transaction-response。 Required Pattern: transaction-response | |
| total | 0..0 | |||
| link | 0..0 | |||
| entry | 1..* | BackboneElement | 记录对请求消息中资源执行的结果。注意：响应消息中资源的排序必须与请求消息中的资源排序一致。 | |
| fullUrl | 0..0 | |||
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 0..0 | |||
| response | 1..1 | BackboneElement | 记录了对单个资源的执行结果 | |
| status | 1..1 | string | 对单个资源执行的状态码 | |
| Documentation for this format | ||||
快照视图
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| 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. | |
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
| type | Σ | 1..1 | code | Bundle资源的类型。在本规范中必须为transaction-response。 Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: transaction-response |
| timestamp | Σ | 0..1 | instant | When the bundle was assembled |
| entry | ΣI | 1..* | BackboneElement | 记录对请求消息中资源执行的结果。注意：响应消息中资源的排序必须与请求消息中的资源排序一致。 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| 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 |
| link | Σ | 0..* | See link (Bundle) | Links related to this entry |
| response | ΣI | 1..1 | 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 |
| status | Σ | 1..1 | string | 对单个资源执行的状态码 |
| location | Σ | 0..1 | uri | The location (if the operation returns a location) |
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
本定义的其它表示法: Schematron
| Path | Conformance | ValueSet / Code |
| Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Bundle.type | required | Pattern: transaction-response |
| Bundle.entry.search.mode | required | SearchEntryMode |
| Bundle.entry.request.method | required | HTTPVerb |
| Id | Path | Details | Requirements |
| bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-7 | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-9 | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | Bundle.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.timestamp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.link.relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.link.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-8 | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| ele-1 | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Bundle.entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Bundle.entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Bundle.signature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |