CH ATC (R4)
3.3.0-ci-build - ci-build
CH ATC (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 3.3.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-atc/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-atc/StructureDefinition/AccessAuditTrailEvent | Version: 3.3.0-ci-build | |||
Active as of 2018-05-28 | Computable Name: AccessAuditTrailEvent | |||
Copyright/Legal: CC0-1.0 |
This profile defines the content of the access audit trail event which a community has to provide for a patients audit trail.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChEprFhirAuditEvent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | C | 0..* | ChEprFhirAuditEvent | Access Audit Trail Event Content Profile ch-atc-aae-1: subtype needs to be fixed to ATC_LOG_READ |
type | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
subtype | 1..1 | Coding | More specific type/id for the event Binding: AccessAuditTrailEventType (required): Audit Trail Event Type | |
recorded | 1..1 | instant | Time when the event was recorded | |
agent | 1..* | BackboneElement | Patient, repeated if representative | |
role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
who | ||||
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator | |
Slices for entity | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code | |
entity:Patient | 1..1 | BackboneElement | Patient | |
what | ||||
identifier | 1..1 | Identifier | Patient Id (EPR-SPID) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | |
AuditEvent.subtype | required | AccessAuditTrailEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/AccessAuditTrailEventType from this IG | |
AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipant from this IG |
Id | Grade | Path(s) | Details | Requirements |
ch-atc-aae-1 | error | AuditEvent | subtype needs to be fixed to ATC_LOG_READ : subtype.exists() and subtype.count()=1 and subtype.first().code='ATC_LOG_READ' |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | C | 0..* | ChEprFhirAuditEvent | Access Audit Trail Event Content Profile ch-atc-aae-1: subtype needs to be fixed to ATC_LOG_READ |
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 | Type/identifier of event Binding: AuditEventID (extensible): Type of event. |
subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AccessAuditTrailEventType (required): Audit Trail Event Type |
recorded | Σ | 1..1 | instant | Time when the event was recorded |
agent | 1..* | BackboneElement | Patient, repeated if representative | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | Σ | 1..1 | boolean | Whether user is initiator |
source | 1..1 | BackboneElement | Audit Event Reporter | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code sev-1: Either a name or a query (NOT both) |
entity:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
entity:Patient | C | 1..1 | BackboneElement | Patient sev-1: Either a name or a query (NOT both) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
what | Σ | 1..1 | Reference(Resource) | Specific instance of resource |
identifier | Σ | 1..1 | Identifier | Patient Id (EPR-SPID) |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
entity:TraceContext | C | 0..1 | BackboneElement | Trace Context sev-1: Either a name or a query (NOT both) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
what | Σ | 1..1 | Reference(Resource) | Specific instance of resource |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 4 |
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 26 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | |
AuditEvent.subtype | required | AccessAuditTrailEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/AccessAuditTrailEventType from this IG | |
AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipant from this IG | |
AuditEvent.entity:Patient.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | |
AuditEvent.entity:TraceContext.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AuditEvent.entity:TraceContext.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:TraceContext.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-atc-aae-1 | error | AuditEvent | subtype needs to be fixed to ATC_LOG_READ : subtype.exists() and subtype.count()=1 and subtype.first().code='ATC_LOG_READ' | |
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, AuditEvent.entity:Patient, AuditEvent.entity:TraceContext | Either a name or a query (NOT both) : name.empty() or query.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AuditEvent | C | 0..* | ChEprFhirAuditEvent | Access Audit Trail Event Content Profile ch-atc-aae-1: subtype needs to be fixed to ATC_LOG_READ | ||||
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 | |||||
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 | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | ||||
subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AccessAuditTrailEventType (required): Audit Trail Event Type | ||||
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 | When the activity occurred | |||||
recorded | Σ | 1..1 | instant | Time when the event was recorded | ||||
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 (extensible): The reason the activity took place. | ||||
agent | 1..* | BackboneElement | Patient, repeated if representative | |||||
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 | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |||||
who | Σ | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
altId | 0..1 | string | Alternative User identity | |||||
name | 1..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 (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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | ||||
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. | |||||
Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code sev-1: Either a name or a query (NOT both) | ||||
entity: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 | ||||
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 | |||||||
entity:Patient | C | 1..1 | BackboneElement | Patient 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 | Σ | 1..1 | Reference(Resource) | Specific instance of resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Patient Id (EPR-SPID) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | |||||||
entity:TraceContext | C | 0..1 | BackboneElement | Trace Context 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 | Σ | 1..1 | Reference(Resource) | Specific instance of resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 4 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 26 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | Conformance | ValueSet | URI | |||
AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | ||||
AuditEvent.subtype | required | AccessAuditTrailEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/AccessAuditTrailEventType from this IG | ||||
AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard | ||||
AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard | ||||
AuditEvent.purposeOfEvent | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipant from this IG | ||||
AuditEvent.agent.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.source.type | extensible | AuditEventSourceTypehttp://hl7.org/fhir/ValueSet/audit-source-type from the FHIR Standard | ||||
AuditEvent.entity.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
AuditEvent.entity:Patient.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.entity:Patient.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AuditEvent.entity:Patient.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity:Patient.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity:Patient.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity:TraceContext.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-atc-aae-1 | error | AuditEvent | subtype needs to be fixed to ATC_LOG_READ : subtype.exists() and subtype.count()=1 and subtype.first().code='ATC_LOG_READ' | |
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, AuditEvent.entity:Patient, AuditEvent.entity:TraceContext | Either a name or a query (NOT both) : name.empty() or query.empty() |
This structure is derived from ChEprFhirAuditEvent
Summary
Mandatory: 4 elements(1 nested mandatory element)
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ChEprFhirAuditEvent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | C | 0..* | ChEprFhirAuditEvent | Access Audit Trail Event Content Profile ch-atc-aae-1: subtype needs to be fixed to ATC_LOG_READ |
type | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
subtype | 1..1 | Coding | More specific type/id for the event Binding: AccessAuditTrailEventType (required): Audit Trail Event Type | |
recorded | 1..1 | instant | Time when the event was recorded | |
agent | 1..* | BackboneElement | Patient, repeated if representative | |
role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
who | ||||
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | 1..1 | boolean | Whether user is initiator | |
Slices for entity | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code | |
entity:Patient | 1..1 | BackboneElement | Patient | |
what | ||||
identifier | 1..1 | Identifier | Patient Id (EPR-SPID) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | |
AuditEvent.subtype | required | AccessAuditTrailEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/AccessAuditTrailEventType from this IG | |
AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipant from this IG |
Id | Grade | Path(s) | Details | Requirements |
ch-atc-aae-1 | error | AuditEvent | subtype needs to be fixed to ATC_LOG_READ : subtype.exists() and subtype.count()=1 and subtype.first().code='ATC_LOG_READ' |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | C | 0..* | ChEprFhirAuditEvent | Access Audit Trail Event Content Profile ch-atc-aae-1: subtype needs to be fixed to ATC_LOG_READ |
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 | Type/identifier of event Binding: AuditEventID (extensible): Type of event. |
subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AccessAuditTrailEventType (required): Audit Trail Event Type |
recorded | Σ | 1..1 | instant | Time when the event was recorded |
agent | 1..* | BackboneElement | Patient, repeated if representative | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
name | 1..1 | string | Human friendly name for the agent | |
requestor | Σ | 1..1 | boolean | Whether user is initiator |
source | 1..1 | BackboneElement | Audit Event Reporter | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code sev-1: Either a name or a query (NOT both) |
entity:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
entity:Patient | C | 1..1 | BackboneElement | Patient sev-1: Either a name or a query (NOT both) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
what | Σ | 1..1 | Reference(Resource) | Specific instance of resource |
identifier | Σ | 1..1 | Identifier | Patient Id (EPR-SPID) |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
entity:TraceContext | C | 0..1 | BackboneElement | Trace Context sev-1: Either a name or a query (NOT both) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
what | Σ | 1..1 | Reference(Resource) | Specific instance of resource |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 4 |
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 26 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | |
AuditEvent.subtype | required | AccessAuditTrailEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/AccessAuditTrailEventType from this IG | |
AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipant from this IG | |
AuditEvent.entity:Patient.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | |
AuditEvent.entity:TraceContext.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AuditEvent.entity:TraceContext.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:TraceContext.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-atc-aae-1 | error | AuditEvent | subtype needs to be fixed to ATC_LOG_READ : subtype.exists() and subtype.count()=1 and subtype.first().code='ATC_LOG_READ' | |
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, AuditEvent.entity:Patient, AuditEvent.entity:TraceContext | Either a name or a query (NOT both) : name.empty() or query.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AuditEvent | C | 0..* | ChEprFhirAuditEvent | Access Audit Trail Event Content Profile ch-atc-aae-1: subtype needs to be fixed to ATC_LOG_READ | ||||
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 | |||||
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 | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | ||||
subtype | Σ | 1..1 | Coding | More specific type/id for the event Binding: AccessAuditTrailEventType (required): Audit Trail Event Type | ||||
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 | When the activity occurred | |||||
recorded | Σ | 1..1 | instant | Time when the event was recorded | ||||
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 (extensible): The reason the activity took place. | ||||
agent | 1..* | BackboneElement | Patient, repeated if representative | |||||
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 | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |||||
who | Σ | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
altId | 0..1 | string | Alternative User identity | |||||
name | 1..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 (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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | ||||
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. | |||||
Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code sev-1: Either a name or a query (NOT both) | ||||
entity: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 | ||||
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 | |||||||
entity:Patient | C | 1..1 | BackboneElement | Patient 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 | Σ | 1..1 | Reference(Resource) | Specific instance of resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Patient Id (EPR-SPID) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | |||||||
entity:TraceContext | C | 0..1 | BackboneElement | Trace Context 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 | Σ | 1..1 | Reference(Resource) | Specific instance of resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 4 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 26 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
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 | Conformance | ValueSet | URI | |||
AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | ||||
AuditEvent.subtype | required | AccessAuditTrailEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/AccessAuditTrailEventType from this IG | ||||
AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard | ||||
AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard | ||||
AuditEvent.purposeOfEvent | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipant from this IG | ||||
AuditEvent.agent.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.source.type | extensible | AuditEventSourceTypehttp://hl7.org/fhir/ValueSet/audit-source-type from the FHIR Standard | ||||
AuditEvent.entity.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
AuditEvent.entity:Patient.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.entity:Patient.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AuditEvent.entity:Patient.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity:Patient.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity:Patient.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity:TraceContext.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity:TraceContext.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-atc-aae-1 | error | AuditEvent | subtype needs to be fixed to ATC_LOG_READ : subtype.exists() and subtype.count()=1 and subtype.first().code='ATC_LOG_READ' | |
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, AuditEvent.entity:Patient, AuditEvent.entity:TraceContext | Either a name or a query (NOT both) : name.empty() or query.empty() |
This structure is derived from ChEprFhirAuditEvent
Summary
Mandatory: 4 elements(1 nested mandatory element)
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron