AIST PICA Implementation Guide
0.1.0 - STU1
AIST PICA Implementation Guide
0.1.0 - STU1
AIST PICA Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Defining URL: | http://hl7.at/fhir/AISTPICA/R5/StructureDefinition/aist-pica-auditevent-carepathway |
| Version: | 0.1.0 |
| Name: | AISTPICAAuditEventCarePathway |
| Title: | AIST PICA Care Pathway AuditEvent Profile |
| Status: | Active as of 2023-09-06 14:46:21+0000 |
| Definition: | AIST PICA Care Pathway AuditEvent Profile enforcing the care plan |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.at/fhir/AISTPICA/R5/StructureDefinition/aist-pica-auditevent-carepathway
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AISTPICAAuditEventCore
Summary
Mandatory: 2 elements
Slices
This structure defines the following Slices:
This structure is derived from AISTPICAAuditEventCore
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent | 0..* | AISTPICAAuditEventCore | Record of an event | |
  Slices for basedOn | 1..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Reference to care plan identifying the process to be conformance checked. Slice: Unordered, Open by | |
   basedOn:carePlan | 1..* | Reference(CarePlan) | Workflow authorization within which this event occurred | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AISTPICAAuditEventCore | Record of an event | |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | Σ | 0..* | CodeableConcept | Type/identifier of event Binding: AuditEventID (example): Type of event. |
| code | Σ | 1..1 | CodeableConcept | Specific type of event Binding: AuditEventSubType (example): Specific type of event. |
| action | Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action |
| severity | Σ | 0..1 | code | emergency | 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..1 | dateTime | When the activity occurred Slice: Unordered, Closed by type:$this | |
 occurred[x]:occurredDateTime | 1..1 | dateTime | Documents when the event was conducted, not when it was audited. | |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| outcome | Σ | 0..1 | BackboneElement | Whether the event succeeded or failed |
| 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 |
| code | Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome |
 detail | Σ | 0..* | CodeableConcept | Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue. |
| authorization | Σ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. |
| Slices for basedOn | 1..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Reference to care plan identifying the process to be conformance checked. Slice: Unordered, Open by | |
| basedOn:carePlan | 1..* | Reference(CarePlan) | Workflow authorization within which this event occurred | |
 patient | 1..1 | Reference(Patient) | The patient this Audit event is for. | |
| encounter | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |
| agent | Σ | 1..* | 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 (preferred): 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 | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor | Σ | 0..1 | boolean | Whether user is initiator |
| location | 0..1 | Reference(Location) | The agent location when the event occurred | |
| policy | 0..* | uri | Policy that authorized the agent participation in the event | |
 network[x] | 0..1 | This agent network location for the activity | ||
| networkReference | Reference(Endpoint) | |||
| networkUri | uri | |||
| networkString | string | |||
| authorization | 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): 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 | Reference(Location) | Logical source location within the enterprise | |
| observer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event |
| type | 0..* | CodeableConcept | The type of source where event originated 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..* | BackboneElement | Data or objects used |
| 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 |
| role | 0..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |
| securityLabel | 0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |
| query | Σ | 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 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |
| value[x] | 1..1 | Property value | ||
| valueQuantity | Quantity | |||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueTime | time | |||
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| valueBase64Binary | base64Binary | |||
 agent | 0..* | See agent (AuditEvent) | Entity is attributed to this agent | |
| Documentation for this format | ||||
This structure is derived from AISTPICAAuditEventCore
Summary
Mandatory: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AISTPICAAuditEventCore
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AISTPICAAuditEventCore | Record of an event | |
| Slices for basedOn | 1..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Reference to care plan identifying the process to be conformance checked. Slice: Unordered, Open by | |
| basedOn:carePlan | 1..* | Reference(CarePlan) | Workflow authorization within which this event occurred | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AISTPICAAuditEventCore | Record of an event | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | Σ | 0..* | CodeableConcept | Type/identifier of event Binding: AuditEventID (example): Type of event. |
| code | Σ | 1..1 | CodeableConcept | Specific type of event Binding: AuditEventSubType (example): Specific type of event. |
| action | Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action |
| severity | Σ | 0..1 | code | emergency | 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..1 | dateTime | When the activity occurred Slice: Unordered, Closed by type:$this | |
| occurred[x]:occurredDateTime | 1..1 | dateTime | Documents when the event was conducted, not when it was audited. | |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| outcome | Σ | 0..1 | BackboneElement | Whether the event succeeded or failed |
| 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 |
| code | Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome |
| detail | Σ | 0..* | CodeableConcept | Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue. |
| authorization | Σ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. |
| Slices for basedOn | 1..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Reference to care plan identifying the process to be conformance checked. Slice: Unordered, Open by | |
| basedOn:carePlan | 1..* | Reference(CarePlan) | Workflow authorization within which this event occurred | |
| patient | 1..1 | Reference(Patient) | The patient this Audit event is for. | |
| encounter | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |
| agent | Σ | 1..* | 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 (preferred): 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 | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor | Σ | 0..1 | boolean | Whether user is initiator |
| location | 0..1 | Reference(Location) | The agent location when the event occurred | |
| policy | 0..* | uri | Policy that authorized the agent participation in the event | |
| network[x] | 0..1 | This agent network location for the activity | ||
| networkReference | Reference(Endpoint) | |||
| networkUri | uri | |||
| networkString | string | |||
| authorization | 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): 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 | Reference(Location) | Logical source location within the enterprise | |
| observer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event |
| type | 0..* | CodeableConcept | The type of source where event originated 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..* | BackboneElement | Data or objects used |
| 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 |
| role | 0..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |
| securityLabel | 0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |
| query | Σ | 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 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |
| value[x] | 1..1 | Property value | ||
| valueQuantity | Quantity | |||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueTime | time | |||
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| valueBase64Binary | base64Binary | |||
| agent | 0..* | See agent (AuditEvent) | Entity is attributed to this agent | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| AuditEvent.language | required | AllLanguages |
| AuditEvent.category | example | AuditEventID |
| AuditEvent.code | example | AuditEventSubType |
| AuditEvent.action | required | AuditEventAction |
| AuditEvent.severity | required | AuditEventSeverity |
| AuditEvent.outcome.code | preferred | AuditEventOutcome |
| AuditEvent.outcome.detail | example | AuditEventOutcomeDetail |
| AuditEvent.authorization | example | PurposeOfUse |
| AuditEvent.agent.type | preferred | ParticipationRoleType |
| AuditEvent.agent.role | example | SecurityRoleType |
| AuditEvent.agent.authorization | example | PurposeOfUse |
| AuditEvent.source.type | preferred | AuditEventSourceType |
| AuditEvent.entity.role | example | AuditEventEntityRole |
| AuditEvent.entity.securityLabel | example | SecurityLabelExamples |
| AuditEvent.entity.detail.type | example | AuditEventID |