HL7中国FHIR Connectathon测试实施指南
2024.5.5 - release
本指南适用于HL7中国的FHIR Connectathon测试。
Defining URL: | http://hl7.org.cn/fhir/StructureDefinition/profile-rx-messageheader |
Version: | 2024.5.5 |
Name: | RxMessageHeader |
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-rx-messageheader
这种结构源自 MessageHeader
Summary
Mandatory: 2 elements
Slices
This structure defines the following Slices:
这种结构源自 MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
event[x] | 1..1 | Coding | 处方流转事件类型 Slice: Unordered, Open by type:$this | |
eventCoding | 1..1 | Coding | 编码类型 Binding: 处方流转事件类型代码表 (required) | |
source | 1..1 | BackboneElement | 消息源应用 | |
name | 1..1 | string | 应用名称 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
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
| |||||
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 | ||||
Slices for event[x] | Σ | 1..1 | Coding | 处方流转事件类型 Slice: Unordered, Closed by type:$this Binding: (unbound) (example): One of the message events defined as part of this version of FHIR. | ||||
event[x]:eventCoding | Σ | 1..1 | Coding | 编码类型 Binding: 处方流转事件类型代码表 (required) | ||||
destination | Σ | 0..* | BackboneElement | Message destination application(s) | ||||
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 | ||||
endpoint[x] | Σ | 0..1 | Actual destination address or Endpoint resource | |||||
endpointUrl | url | |||||||
endpointReference | Reference(Endpoint) | |||||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
sender | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | Real world sender of the message | ||||
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | The source of the decision | ||||
source | Σ | 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 | ||||
endpoint[x] | Σ | 0..1 | Actual source address or Endpoint resource | |||||
endpointUrl | url | |||||||
endpointReference | Reference(Endpoint) | |||||||
name | Σ | 1..1 | string | 应用名称 | ||||
software | Σ | 0..1 | string | Name of software running the system | ||||
version | Σ | 0..1 | string | Version of software running | ||||
contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
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 | Σ | 1..1 | Identifier | Bundle.identifier of original message | ||||
code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
focus | Σ | 0..* | Reference(Resource) | The actual content of the message | ||||
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
Documentation for this format |
这种结构源自 MessageHeader
Summary
Mandatory: 2 elements
Slices
This structure defines the following Slices:
差异视图
这种结构源自 MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
event[x] | 1..1 | Coding | 处方流转事件类型 Slice: Unordered, Open by type:$this | |
eventCoding | 1..1 | Coding | 编码类型 Binding: 处方流转事件类型代码表 (required) | |
source | 1..1 | BackboneElement | 消息源应用 | |
name | 1..1 | string | 应用名称 | |
Documentation for this format |
快照视图
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
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
| |||||
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 | ||||
Slices for event[x] | Σ | 1..1 | Coding | 处方流转事件类型 Slice: Unordered, Closed by type:$this Binding: (unbound) (example): One of the message events defined as part of this version of FHIR. | ||||
event[x]:eventCoding | Σ | 1..1 | Coding | 编码类型 Binding: 处方流转事件类型代码表 (required) | ||||
destination | Σ | 0..* | BackboneElement | Message destination application(s) | ||||
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 | ||||
endpoint[x] | Σ | 0..1 | Actual destination address or Endpoint resource | |||||
endpointUrl | url | |||||||
endpointReference | Reference(Endpoint) | |||||||
name | Σ | 0..1 | string | Name of system | ||||
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
sender | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | Real world sender of the message | ||||
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | The source of the decision | ||||
source | Σ | 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 | ||||
endpoint[x] | Σ | 0..1 | Actual source address or Endpoint resource | |||||
endpointUrl | url | |||||||
endpointReference | Reference(Endpoint) | |||||||
name | Σ | 1..1 | string | 应用名称 | ||||
software | Σ | 0..1 | string | Name of software running the system | ||||
version | Σ | 0..1 | string | Version of software running | ||||
contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
response | Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
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 | Σ | 1..1 | Identifier | Bundle.identifier of original message | ||||
code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
focus | Σ | 0..* | Reference(Resource) | The actual content of the message | ||||
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
Documentation for this format |
本定义的其它表示法: Schematron
Path | Conformance | ValueSet | URI |
MessageHeader.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
MessageHeader.event[x] | example | ||
MessageHeader.event[x]:eventCoding | required | SpecialRxEventTypeCodes (a valid code from 处方流转事件类型代码表)http://hl7.org.cn/fhir/ValueSet/special-rx-event-type-codes from this IG | |
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard | |
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
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() |