臺灣社政領域基礎實作指引
0.0.1 - ci-build
臺灣社政領域基礎實作指引
0.0.1 - ci-build
臺灣社政領域基礎實作指引, published by 衛生福利部社會及家庭署. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/sfaassn2025-source/base/ and changes regularly. See the Directory of published versions
| Official URL: https://sfaa.gov.tw/base/StructureDefinition/AuditEvent-twss-base | Version: 0.0.1 | |||
| Draft as of 2026-10-20 | Computable Name: AuditEventTWSSBase | |||
本 Profile 繼承 FHIR R4 原生 AuditEvent。TW Core IG 0.3.2 未提供 AuditEvent Profile，因此以原生 AuditEvent 表達臺灣社政領域系統的資訊記錄與稽核軌跡。
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  AuditEvent |
0..* | AuditEvent | Event record kept for security purposes | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 type |
1..1 | Coding | 活動記錄類型 Binding: AuditEventID (extensible): Type of event. | |
| period |
0..1 | Period | 活動發生時間 | |
| recorded |
1..1 | instant | 事件被記錄時間 | |
  Slices for agent |
1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:network.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   agent:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 requestor |
1..1 | boolean | Whether user is initiator | |
  agent:ipAddress |
0..* | BackboneElement | Actor involved in the event | |
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| altId |
0..1 | string | 行為人識別碼 | |
| requestor |
1..1 | boolean | 是否為事件發起人 | |
 location |
0..1 | Reference(服務地點及托育地址-Location TWSS Base) | 行為人所在位置 | |
 network |
0..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| address |
0..1 | string | 行為人裝置網路識別碼 | |
 type |
1..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. Required Pattern: 2 (extensions allowed) | |
 source |
1..1 | BackboneElement | Audit Event Reporter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| observer |
1..1 | Reference(機構資料-Organization TWSS Base | Device) | 事件記錄來源 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | 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()
|
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AuditEvent |
0..* | AuditEvent | Event record kept for security purposes | |
| type |
1..1 | Coding | 活動記錄類型 | |
| period |
0..1 | Period | 活動發生時間 | |
| recorded |
1..1 | instant | 事件被記錄時間 | |
| Slices for agent |
1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:network.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:ipAddress |
0..* | BackboneElement | Actor involved in the event | |
| altId |
0..1 | string | 行為人識別碼 | |
| requestor |
1..1 | boolean | 是否為事件發起人 | |
| location |
0..1 | Reference(服務地點及托育地址-Location TWSS Base) | 行為人所在位置 | |
| network |
||||
| address |
0..1 | string | 行為人裝置網路識別碼 | |
| type |
1..1 | code | The type of network access point Required Pattern: 2 (extensions allowed) | |
| source |
||||
| observer |
1..1 | Reference(機構資料-Organization TWSS Base | Device) | 事件記錄來源 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent |
0..* | AuditEvent | Event record kept for security purposes | |||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 (extensible): Type of event. | |||||
| subtype |
0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. | |||||
| action |
0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. | |||||
| period |
0..1 | Period | 活動發生時間 | |||||
| recorded |
1..1 | instant | 事件被記錄時間 | |||||
| outcome |
0..1 | code | Whether the event succeeded or failed 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 (3.1.0) (extensible): The reason the activity took place. | |||||
| Slices for agent |
1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:network.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| agent:All Slices |
Content/Rules for all slices | |||||||
| 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 | How agent participated 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) | Identifier of who | |||||
| altId |
0..1 | string | Alternative User identity | |||||
| name |
0..1 | string | Human friendly name for the agent | |||||
| requestor |
1..1 | boolean | Whether user is initiator | |||||
| 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 | Logical network location for application activity | |||||
| 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 | Identifier for the network access point of the user device | |||||
| type |
0..1 | code | The type of network access point 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 (3.1.0) (extensible): The reason the activity took place. | |||||
| agent:ipAddress |
0..* | BackboneElement | Actor involved in the event | |||||
| 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 | How agent participated 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) | Identifier of who | |||||
| altId |
0..1 | string | 行為人識別碼 | |||||
| name |
0..1 | string | Human friendly name for the agent | |||||
| requestor |
1..1 | boolean | 是否為事件發起人 | |||||
| location |
0..1 | Reference(服務地點及托育地址-Location TWSS Base) | 行為人所在位置 | |||||
| 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 | Logical network location for application activity | |||||
 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 |
1..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. Required Pattern: 2 (extensions allowed) | |||||
 purposeOfUse |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place. | |||||
| source |
1..1 | BackboneElement | Audit Event Reporter | |||||
| 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 | Logical source location within the enterprise | |||||
| observer |
1..1 | Reference(機構資料-Organization TWSS Base | Device) | 事件記錄來源 | |||||
| type |
0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event. | |||||
| entity |
C | 0..* | BackboneElement | Data or objects used Constraints: sev-1 | ||||
| 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 |
C | 0..1 | string | Descriptor for entity | ||||
| description |
0..1 | string | Descriptive text | |||||
| query |
C | 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std. |
| AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍4.0.1 | FHIR Std. |
| AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std. |
| AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std. |
| AuditEvent.purposeOfEvent | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| AuditEvent.agent.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.purposeOfUse | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| AuditEvent.agent:ipAddress.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.purposeOfUse | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| AuditEvent.source.type | Base | extensible | Audit Event Source Type | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | 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()
|
| sev-1 | error | AuditEvent.entity | Either a name or a query (NOT both) |
name.empty() or query.empty()
|
This structure is derived from AuditEvent
Summary
Mandatory: 0 element(1 nested mandatory element)
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AuditEvent |
0..* | AuditEvent | Event record kept for security purposes | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| type |
1..1 | Coding | 活動記錄類型 Binding: AuditEventID (extensible): Type of event. | |
| period |
0..1 | Period | 活動發生時間 | |
| recorded |
1..1 | instant | 事件被記錄時間 | |
| Slices for agent |
1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:network.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| requestor |
1..1 | boolean | Whether user is initiator | |
| agent:ipAddress |
0..* | BackboneElement | Actor involved in the event | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| altId |
0..1 | string | 行為人識別碼 | |
| requestor |
1..1 | boolean | 是否為事件發起人 | |
| location |
0..1 | Reference(服務地點及托育地址-Location TWSS Base) | 行為人所在位置 | |
| network |
0..1 | BackboneElement | Logical network location for application activity | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| address |
0..1 | string | 行為人裝置網路識別碼 | |
| type |
1..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. Required Pattern: 2 (extensions allowed) | |
| source |
1..1 | BackboneElement | Audit Event Reporter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| observer |
1..1 | Reference(機構資料-Organization TWSS Base | Device) | 事件記錄來源 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | 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()
|
Differential View
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AuditEvent |
0..* | AuditEvent | Event record kept for security purposes | |
| type |
1..1 | Coding | 活動記錄類型 | |
| period |
0..1 | Period | 活動發生時間 | |
| recorded |
1..1 | instant | 事件被記錄時間 | |
| Slices for agent |
1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:network.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:ipAddress |
0..* | BackboneElement | Actor involved in the event | |
| altId |
0..1 | string | 行為人識別碼 | |
| requestor |
1..1 | boolean | 是否為事件發起人 | |
| location |
0..1 | Reference(服務地點及托育地址-Location TWSS Base) | 行為人所在位置 | |
| network |
||||
| address |
0..1 | string | 行為人裝置網路識別碼 | |
| type |
1..1 | code | The type of network access point Required Pattern: 2 (extensions allowed) | |
| source |
||||
| observer |
1..1 | Reference(機構資料-Organization TWSS Base | Device) | 事件記錄來源 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent |
0..* | AuditEvent | Event record kept for security purposes | |||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 (extensible): Type of event. | |||||
| subtype |
0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. | |||||
| action |
0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. | |||||
| period |
0..1 | Period | 活動發生時間 | |||||
| recorded |
1..1 | instant | 事件被記錄時間 | |||||
| outcome |
0..1 | code | Whether the event succeeded or failed 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 (3.1.0) (extensible): The reason the activity took place. | |||||
| Slices for agent |
1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:network.type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| agent:All Slices |
Content/Rules for all slices | |||||||
| 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 | How agent participated 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) | Identifier of who | |||||
| altId |
0..1 | string | Alternative User identity | |||||
| name |
0..1 | string | Human friendly name for the agent | |||||
| requestor |
1..1 | boolean | Whether user is initiator | |||||
| 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 | Logical network location for application activity | |||||
| 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 | Identifier for the network access point of the user device | |||||
| type |
0..1 | code | The type of network access point 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 (3.1.0) (extensible): The reason the activity took place. | |||||
| agent:ipAddress |
0..* | BackboneElement | Actor involved in the event | |||||
| 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 | How agent participated 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) | Identifier of who | |||||
| altId |
0..1 | string | 行為人識別碼 | |||||
| name |
0..1 | string | Human friendly name for the agent | |||||
| requestor |
1..1 | boolean | 是否為事件發起人 | |||||
| location |
0..1 | Reference(服務地點及托育地址-Location TWSS Base) | 行為人所在位置 | |||||
| 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 | Logical network location for application activity | |||||
| 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 |
1..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. Required Pattern: 2 (extensions allowed) | |||||
| purposeOfUse |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place. | |||||
| source |
1..1 | BackboneElement | Audit Event Reporter | |||||
| 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 | Logical source location within the enterprise | |||||
| observer |
1..1 | Reference(機構資料-Organization TWSS Base | Device) | 事件記錄來源 | |||||
| type |
0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event. | |||||
| entity |
C | 0..* | BackboneElement | Data or objects used Constraints: sev-1 | ||||
| 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 |
C | 0..1 | string | Descriptor for entity | ||||
| description |
0..1 | string | Descriptive text | |||||
| query |
C | 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std. |
| AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍4.0.1 | FHIR Std. |
| AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std. |
| AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std. |
| AuditEvent.purposeOfEvent | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| AuditEvent.agent.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent.purposeOfUse | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| AuditEvent.agent:ipAddress.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std. |
| AuditEvent.agent:ipAddress.purposeOfUse | Base | extensible | PurposeOfUse | 📍3.1.0 | THO v7.4 |
| AuditEvent.source.type | Base | extensible | Audit Event Source Type | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std. |
| AuditEvent.entity.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | 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()
|
| sev-1 | error | AuditEvent.entity | Either a name or a query (NOT both) |
name.empty() or query.empty()
|
This structure is derived from AuditEvent
Summary
Mandatory: 0 element(1 nested mandatory element)
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
此 Profile 使用 FHIR R4 AuditEvent Resource；伺服端可能可以（MAY）支援 FHIR R4 AuditEvent 所定義之查詢參數。完整定義請參考 FHIR R4 AuditEvent 原生查詢參數。
| 查詢參數 | 類型 | 說明 |
|---|---|---|
altid |
token | 依行為人識別碼查詢。 |
date |
date | 依事件被記錄時間查詢。 |
source |
reference | 依事件記錄來源查詢。 |
type |
token | 依活動記錄類型查詢。 |
address |
string | 依行為人裝置網路識別碼查詢。 |