HL7中国FHIR Connectathon测试实施指南-核心审计事件结构定义

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

Resource Profile: 核心审计事件结构定义

Defining URL:

http://hl7.org.cn/fhir/StructureDefinition/profile-core-auditevent

Version:

V20230304

Name:

CoreAuditEvent

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-core-auditevent

定义内容的视图

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

这种结构源自 AuditEvent

Summary

Mandatory: 4 elements

这种结构源自 AuditEvent

Name	Card.	Type	Description & Constraints
AuditEvent	0..*	AuditEvent	Event record kept for security purposes
type	1..1	Coding	审计事件类型（粗粒度） Binding: AuditEventID (required)
subtype	1..1	Coding	审计事件类型（细粒度） Binding: AuditEventSub-Type (required)
action	1..1	code	活动类型：创建、读取、更新、删除、执行
period	1..1	Period	活动发生时间
recorded	1..1	instant	审计记录时间
outcome	1..1	code	执行结果：成功、一般错误、严重错误、重大错误
agent	1..*	BackboneElement	事件参与者
type	0..1	CodeableConcept	事件参与者类型
who	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	参与者（可以是系统或者人员）
name	0..1	string	名称
requestor	1..1	boolean	是否为事件的发起者
network	0..1	BackboneElement	网络信息
address	0..1	string	网络地址
type	0..1	code	网络类型
source	1..1	BackboneElement	审计源，记录了提交审计事件的系统
site	0..1	string	审计源所处位置
observer	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	审计源系统标识
type	0..*	Coding	审计源类型
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
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
type	Σ	1..1	Coding	审计事件类型（粗粒度） Binding: AuditEventID (required)
subtype	Σ	1..1	Coding	审计事件类型（细粒度） Binding: AuditEventSub-Type (required)
action	Σ	1..1	code	活动类型：创建、读取、更新、删除、执行 Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period		1..1	Period	活动发生时间
recorded	Σ	1..1	instant	审计记录时间
outcome	Σ	1..1	code	执行结果：成功、一般错误、严重错误、重大错误 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	Σ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
agent		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
type		0..1	CodeableConcept	事件参与者类型 Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	参与者（可以是系统或者人员）
altId		0..1	string	Alternative User identity
name		0..1	string	名称
requestor	Σ	1..1	boolean	是否为事件的发起者
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..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
address		0..1	string	网络地址
type		0..1	code	网络类型 Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
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
site		0..1	string	审计源所处位置
observer	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	审计源系统标识
type		0..*	Coding	审计源类型 Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
entity	I	0..*	BackboneElement	Data or objects used sev-1: Either a name or a query (NOT both)
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
what	Σ	0..1	Reference(Resource)	Specific instance of resource
type		0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣI	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣI	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
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
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

这种结构源自 AuditEvent

Summary

Mandatory: 4 elements

差异视图

这种结构源自 AuditEvent

Name	Card.	Type	Description & Constraints
AuditEvent	0..*	AuditEvent	Event record kept for security purposes
type	1..1	Coding	审计事件类型（粗粒度） Binding: AuditEventID (required)
subtype	1..1	Coding	审计事件类型（细粒度） Binding: AuditEventSub-Type (required)
action	1..1	code	活动类型：创建、读取、更新、删除、执行
period	1..1	Period	活动发生时间
recorded	1..1	instant	审计记录时间
outcome	1..1	code	执行结果：成功、一般错误、严重错误、重大错误
agent	1..*	BackboneElement	事件参与者
type	0..1	CodeableConcept	事件参与者类型
who	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	参与者（可以是系统或者人员）
name	0..1	string	名称
requestor	1..1	boolean	是否为事件的发起者
network	0..1	BackboneElement	网络信息
address	0..1	string	网络地址
type	0..1	code	网络类型
source	1..1	BackboneElement	审计源，记录了提交审计事件的系统
site	0..1	string	审计源所处位置
observer	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	审计源系统标识
type	0..*	Coding	审计源类型
Documentation for this format

快照视图

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
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
type	Σ	1..1	Coding	审计事件类型（粗粒度） Binding: AuditEventID (required)
subtype	Σ	1..1	Coding	审计事件类型（细粒度） Binding: AuditEventSub-Type (required)
action	Σ	1..1	code	活动类型：创建、读取、更新、删除、执行 Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period		1..1	Period	活动发生时间
recorded	Σ	1..1	instant	审计记录时间
outcome	Σ	1..1	code	执行结果：成功、一般错误、严重错误、重大错误 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	Σ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
agent		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
type		0..1	CodeableConcept	事件参与者类型 Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	参与者（可以是系统或者人员）
altId		0..1	string	Alternative User identity
name		0..1	string	名称
requestor	Σ	1..1	boolean	是否为事件的发起者
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..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
address		0..1	string	网络地址
type		0..1	code	网络类型 Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
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
site		0..1	string	审计源所处位置
observer	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	审计源系统标识
type		0..*	Coding	审计源类型 Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
entity	I	0..*	BackboneElement	Data or objects used sev-1: Either a name or a query (NOT both)
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
what	Σ	0..1	Reference(Resource)	Specific instance of resource
type		0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣI	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣI	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
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
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

本定义的其它表示法: Schematron

Terminology Bindings

Path	Conformance	ValueSet
AuditEvent.language	preferred	CommonLanguages Max Binding: AllLanguages
AuditEvent.type	required	AuditEventID
AuditEvent.subtype	required	AuditEventSub-Type
AuditEvent.action	required	AuditEventAction
AuditEvent.outcome	required	AuditEventOutcome
AuditEvent.purposeOfEvent	extensible	PurposeOfUse
AuditEvent.agent.type	extensible	ParticipationRoleType
AuditEvent.agent.role	example	SecurityRoleType
AuditEvent.agent.media	extensible	MediaTypeCode
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse
AuditEvent.source.type	extensible	AuditEventSourceType
AuditEvent.entity.type	extensible	AuditEventEntityType
AuditEvent.entity.role	extensible	AuditEventEntityRole
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity.securityLabel	extensible	All Security Labels

Constraints

Id	Path	Details	Requirements
dom-2	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	AuditEvent	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	AuditEvent	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	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	AuditEvent.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.subtype	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.action	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.recorded	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.outcome	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.outcomeDesc	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.purposeOfEvent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.agent.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.agent.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.agent.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.agent.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.role	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.who	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.altId	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.requestor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.policy	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.media	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.network	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.network.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.agent.network.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.agent.network.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.agent.network.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.agent.network.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.network.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.agent.purposeOfUse	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.source	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.source.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.source.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.source.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.source.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.source.site	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.source.observer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.source.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
sev-1	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()
ele-1	AuditEvent.entity.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.entity.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.entity.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.entity.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.entity.what	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.role	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.lifecycle	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.securityLabel	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.query	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.detail	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.detail.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.entity.detail.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.entity.detail.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	AuditEvent.entity.detail.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	AuditEvent.entity.detail.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	AuditEvent.entity.detail.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())