HL7中国FHIR Connectathon测试实施指南-处方流转消息头结构定义

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

Resource Profile: 处方流转消息头结构定义

Defining URL:

http://hl7.org.cn/fhir/StructureDefinition/profile-rx-messageheader

Version:

V20230304

Name:

RxMessageHeader

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-rx-messageheader

定义内容的视图

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

这种结构源自 MessageHeader

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

The element MessageHeader.event[x] is sliced based on the value of type:$this

这种结构源自 MessageHeader

Name	Card.	Type	Description & Constraints
MessageHeader	0..*	MessageHeader	A resource that describes a message that is exchanged between systems
event[x]	1..1	(Slice Definition)	处方流转事件类型 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	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
event[x]	Σ	1..1	(Slice Definition)	处方流转事件类型 Slice: Unordered, Closed by type:$this Binding: MessageEvent (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
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
endpoint	Σ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Intended "real-world" recipient for the data
sender	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Real world sender of the message
enterer	Σ	0..1	Reference(Practitioner \| PractitionerRole)	The source of the data entry
author	Σ	0..1	Reference(Practitioner \| PractitionerRole)	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
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
endpoint	Σ	1..1	url	Actual message source address or id
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	id	Id 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

这种结构源自 MessageHeader

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

The element MessageHeader.event[x] is sliced based on the value of type:$this

差异视图

这种结构源自 MessageHeader

Name	Card.	Type	Description & Constraints
MessageHeader	0..*	MessageHeader	A resource that describes a message that is exchanged between systems
event[x]	1..1	(Slice Definition)	处方流转事件类型 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	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
event[x]	Σ	1..1	(Slice Definition)	处方流转事件类型 Slice: Unordered, Closed by type:$this Binding: MessageEvent (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
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
endpoint	Σ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Intended "real-world" recipient for the data
sender	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Real world sender of the message
enterer	Σ	0..1	Reference(Practitioner \| PractitionerRole)	The source of the data entry
author	Σ	0..1	Reference(Practitioner \| PractitionerRole)	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
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
endpoint	Σ	1..1	url	Actual message source address or id
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	id	Id 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

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.language	preferred	CommonLanguages Max Binding: AllLanguages
MessageHeader.event[x]	example	MessageEvent
MessageHeader.event[x]:eventCoding	required	SpecialRxEventTypeCodes
MessageHeader.reason	example	ExampleMessageReasonCodes
MessageHeader.response.code	required	ResponseType

Constraints

Id	Path	Details	Requirements
dom-2	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	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().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	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	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	MessageHeader.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.event[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.event[x]:eventCoding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.destination	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.destination.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.destination.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.destination.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.destination.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.destination.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.destination.target	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.destination.endpoint	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.destination.receiver	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.sender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.enterer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.author	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.source	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.source.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.source.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.source.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.source.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.source.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.source.software	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.source.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.source.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.source.endpoint	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.responsible	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.reason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.response	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.response.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.response.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.response.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	MessageHeader.response.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	MessageHeader.response.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.response.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.response.details	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.focus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	MessageHeader.definition	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())