HL7中国FHIR Connectathon测试实施指南
2024.5.5 - release

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

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

Defining URL:http://hl7.org.cn/fhir/StructureDefinition/profile-core-auditevent
Version:2024.5.5
Name:CoreAuditEvent
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-core-auditevent

定义内容的视图

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

这种结构源自 AuditEvent

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

  • The element AuditEvent.occurred[x] is sliced based on the value of type:$this

这种结构源自 AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... category 1..1CodeableConcept审计事件分类（粗粒度）
Binding: AuditEventID (required)
... code 1..1CodeableConcept审计事件类型（细粒度）
Binding: AuditEventSubType (required)
... action 1..1code活动类型：创建、读取、更新、删除、执行
... occurredDateTime 1..1dateTime活动发生时间
... recorded 1..1instant审计记录时间
... outcome 1..1BackboneElement执行结果：成功、一般错误、严重错误、重大错误
... agent 1..*BackboneElement事件参与者
.... type 0..1CodeableConcept事件参与者类型
.... who 1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)参与者（可以是系统或者人员）
.... requestor 0..1boolean是否为事件的发起者
.... network[x] 1..1Reference(Endpoint), uri, string网络信息
... source 1..1BackboneElement审计源，记录了提交审计事件的系统
.... site 0..1Reference(Location)审计源所处位置
.... observer 1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)审计源系统标识
.... type 0..*CodeableConcept审计源类型

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... category Σ1..1CodeableConcept审计事件分类（粗粒度）
Binding: AuditEventID (required)
... code Σ1..1CodeableConcept审计事件类型（细粒度）
Binding: AuditEventSubType (required)
... action Σ1..1code活动类型：创建、读取、更新、删除、执行
Binding: AuditEventAction (required): DICOM Audit Event Action

... severity Σ0..1codeemergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3

... Slices for occurred[x] 1..1dateTimeWhen the activity occurred
Slice: Unordered, Closed by type:$this
.... occurred[x]:occurredDateTime 1..1dateTime活动发生时间
... recorded Σ1..1instant审计记录时间
... outcome Σ1..1BackboneElement执行结果：成功、一般错误、严重错误、重大错误
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodingWhether the event succeeded or failed
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome

.... detail Σ0..*CodeableConceptAdditional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.


... authorization Σ0..*CodeableConceptAuthorization related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.


... basedOn 0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task)Workflow authorization within which this event occurred
... patient 0..1Reference(Patient)The patient is the subject of the data used/created/updated/deleted during the activity
... encounter 0..1Reference(Encounter)Encounter within which this event occurred or which the event is tightly associated
... agent Σ1..*BackboneElement事件参与者
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConcept事件参与者类型
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.

.... role 0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


.... who Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)参与者（可以是系统或者人员）
.... requestor Σ0..1boolean是否为事件的发起者
.... location 0..1Reference(Location)The agent location when the event occurred
.... policy 0..*uriPolicy that authorized the agent participation in the event
.... network[x] 1..1网络信息
..... networkReferenceReference(Endpoint)
..... networkUriuri
..... networkStringstring
.... authorization 0..*CodeableConceptAllowable authorization for this agent
Binding: PurposeOfUse (example): The reason the activity took place.


... source Σ1..1BackboneElement审计源，记录了提交审计事件的系统
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site 0..1Reference(Location)审计源所处位置
.... observer Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)审计源系统标识
.... type 0..*CodeableConcept审计源类型
Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.


... entity Σ0..*BackboneElementData or objects used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what Σ0..1Reference(Resource)Specific instance of resource
.... role 0..1CodeableConceptWhat role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role

.... securityLabel 0..*CodeableConceptSecurity labels on the entity
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.


.... query Σ0..1base64BinaryQuery parameters
.... detail 0..*BackboneElementAdditional Information about the entity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptName of the property
Binding: AuditEventID (example): Additional detail about an entity used in an event.

..... value[x] 1..1Property value
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueBase64Binarybase64Binary
.... agent 0..*See agent (AuditEvent)Entity is attributed to this agent

doco Documentation for this format

这种结构源自 AuditEvent

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

  • The element AuditEvent.occurred[x] is sliced based on the value of type:$this

差异视图

这种结构源自 AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... category 1..1CodeableConcept审计事件分类（粗粒度）
Binding: AuditEventID (required)
... code 1..1CodeableConcept审计事件类型（细粒度）
Binding: AuditEventSubType (required)
... action 1..1code活动类型：创建、读取、更新、删除、执行
... occurredDateTime 1..1dateTime活动发生时间
... recorded 1..1instant审计记录时间
... outcome 1..1BackboneElement执行结果：成功、一般错误、严重错误、重大错误
... agent 1..*BackboneElement事件参与者
.... type 0..1CodeableConcept事件参与者类型
.... who 1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)参与者（可以是系统或者人员）
.... requestor 0..1boolean是否为事件的发起者
.... network[x] 1..1Reference(Endpoint), uri, string网络信息
... source 1..1BackboneElement审计源，记录了提交审计事件的系统
.... site 0..1Reference(Location)审计源所处位置
.... observer 1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)审计源系统标识
.... type 0..*CodeableConcept审计源类型

doco Documentation for this format

快照视图

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... category Σ1..1CodeableConcept审计事件分类（粗粒度）
Binding: AuditEventID (required)
... code Σ1..1CodeableConcept审计事件类型（细粒度）
Binding: AuditEventSubType (required)
... action Σ1..1code活动类型：创建、读取、更新、删除、执行
Binding: AuditEventAction (required): DICOM Audit Event Action

... severity Σ0..1codeemergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3

... Slices for occurred[x] 1..1dateTimeWhen the activity occurred
Slice: Unordered, Closed by type:$this
.... occurred[x]:occurredDateTime 1..1dateTime活动发生时间
... recorded Σ1..1instant审计记录时间
... outcome Σ1..1BackboneElement执行结果：成功、一般错误、严重错误、重大错误
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodingWhether the event succeeded or failed
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome

.... detail Σ0..*CodeableConceptAdditional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.


... authorization Σ0..*CodeableConceptAuthorization related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.


... basedOn 0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task)Workflow authorization within which this event occurred
... patient 0..1Reference(Patient)The patient is the subject of the data used/created/updated/deleted during the activity
... encounter 0..1Reference(Encounter)Encounter within which this event occurred or which the event is tightly associated
... agent Σ1..*BackboneElement事件参与者
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConcept事件参与者类型
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.

.... role 0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


.... who Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)参与者（可以是系统或者人员）
.... requestor Σ0..1boolean是否为事件的发起者
.... location 0..1Reference(Location)The agent location when the event occurred
.... policy 0..*uriPolicy that authorized the agent participation in the event
.... network[x] 1..1网络信息
..... networkReferenceReference(Endpoint)
..... networkUriuri
..... networkStringstring
.... authorization 0..*CodeableConceptAllowable authorization for this agent
Binding: PurposeOfUse (example): The reason the activity took place.


... source Σ1..1BackboneElement审计源，记录了提交审计事件的系统
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site 0..1Reference(Location)审计源所处位置
.... observer Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)审计源系统标识
.... type 0..*CodeableConcept审计源类型
Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.


... entity Σ0..*BackboneElementData or objects used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what Σ0..1Reference(Resource)Specific instance of resource
.... role 0..1CodeableConceptWhat role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role

.... securityLabel 0..*CodeableConceptSecurity labels on the entity
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.


.... query Σ0..1base64BinaryQuery parameters
.... detail 0..*BackboneElementAdditional Information about the entity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptName of the property
Binding: AuditEventID (example): Additional detail about an entity used in an event.

..... value[x] 1..1Property value
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueBase64Binarybase64Binary
.... agent 0..*See agent (AuditEvent)Entity is attributed to this agent

doco Documentation for this format

 

本定义的其它表示法: Schematron

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AuditEvent.categoryrequiredAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.coderequiredAuditEventSubType
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|5.0.0
from the FHIR Standard
AuditEvent.severityrequiredAuditEventSeverity
http://hl7.org/fhir/ValueSet/audit-event-severity|5.0.0
from the FHIR Standard
AuditEvent.outcome.codepreferredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome
from the FHIR Standard
AuditEvent.outcome.detailexampleAuditEventOutcomeDetail
http://hl7.org/fhir/ValueSet/audit-event-outcome-detail
from the FHIR Standard
AuditEvent.authorizationexamplePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.typepreferredParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.authorizationexamplePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typepreferredAuditEventSourceType
http://hl7.org/fhir/ValueSet/security-source-type
from the FHIR Standard
AuditEvent.entity.roleexampleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
from the FHIR Standard
AuditEvent.entity.detail.typeexampleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()