CH EPR FHIR (R4)
4.0.0-ballot - ballot
This page is part of the CH EPR FHIR (R4) (v4.0.0-ballot: DSTU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-updatedocumentmetadata-audit-recipient | Version: 4.0.0-ballot | |||
Active as of 2024-05-16 | Computable Name: AuditUpdatedDcumentMetadataRecipient | |||
Copyright/Legal: CC0-1.0 |
Defines constraints on the AuditEvent Resource to record when a Update Document Metadata Transaction happens at the Recipient.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
modifierExtension | 0..0 | |||
type | 1..1 | Coding | Type/identifier of event Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110107 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Import | |
Slices for subtype | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this | |
subtype:chmhd1 | 1..1 | Coding | More specific type/id for the event Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH-MHD-1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Update Document Metadata | |
action | 0..1 | code | Type of action performed during the event Required Pattern: C | |
outcome | 1..1 | code | Whether the event succeeded or failed | |
outcomeDesc | S | 0..1 | string | Description of the event outcome |
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
agent:documentSource | 1..1 | BackboneElement | Document Source | |
type | 1..1 | CodeableConcept | How agent participated Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
agent:documentRecipient | C | 1..1 | BackboneElement | Document Recipient val-audit-source: The Audit Source is this agent too. |
type | 1..1 | CodeableConcept | How agent participated Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
Slices for entity | 2..2 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type | |
entity:patient | 1..1 | BackboneElement | Patient | |
what | 1..1 | Reference(Patient) | Specific instance of resource | |
type | 1..1 | Coding | Type of entity involved Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
role | 0..1 | Coding | What role the entity played Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
entity:documentReference | 1..1 | BackboneElement | DocumentReference | |
what | 1..1 | Reference(DocumentReference) | Specific instance of resource | |
type | 1..1 | Coding | Type of entity involved Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
role | 0..1 | Coding | What role the entity played Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 20 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Job | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
val-audit-source | error | AuditEvent.agent:documentRecipient | The Audit Source is this agent too. : $this.who = %resource.source.observer |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110107 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Import | |
Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. |
subtype:chmhd1 | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH-MHD-1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Update Document Metadata | |
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. Required Pattern: C |
recorded | Σ | 1..1 | instant | Time when the event was recorded |
outcome | Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. |
outcomeDesc | SΣ | 0..1 | string | Description of the event outcome |
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
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:documentSource | 1..1 | BackboneElement | Document Source | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
requestor | Σ | 1..1 | boolean | Whether user is initiator |
network | 1..1 | BackboneElement | Logical network location for application activity | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
agent:documentRecipient | C | 1..1 | BackboneElement | Document Recipient val-audit-source: The Audit Source is this agent too. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
requestor | Σ | 1..1 | boolean | Whether user is initiator |
network | 1..1 | BackboneElement | Logical network location for application activity | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 | 2..2 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type 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(Patient) | Specific instance of resource |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
entity:documentReference | C | 1..1 | BackboneElement | DocumentReference 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(DocumentReference) | Specific instance of resource |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 20 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Job | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
AuditEvent.type | extensible | Pattern: 110107("Import")http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | |
AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | |
AuditEvent.subtype:chmhd1 | extensible | Pattern: CH-MHD-1("Update Document Metadata")http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | |
AuditEvent.action | required | Pattern: Chttp://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.agent:documentSource.type | extensible | Pattern: 110153("Source Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | |
AuditEvent.agent:documentRecipient.type | extensible | Pattern: 110152("Destination Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | |
AuditEvent.entity:patient.type | extensible | Pattern: 1("Person")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:patient.role | extensible | Pattern: 1("Patient")http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | |
AuditEvent.entity:documentReference.type | extensible | Pattern: 2("System Object")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:documentReference.role | extensible | Pattern: 20("Job")http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:documentReference | Either a name or a query (NOT both) : name.empty() or query.empty() | |
val-audit-source | error | AuditEvent.agent:documentRecipient | The Audit Source is this agent too. : $this.who = %resource.source.observer |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110107 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Import | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
subtype:chmhd1 | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH-MHD-1 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Update Document Metadata | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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. Required Pattern: C | ||||
period | 0..1 | Period | When the activity occurred | |||||
recorded | Σ | 1..1 | instant | Time when the event was recorded | ||||
outcome | Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. | ||||
outcomeDesc | SΣ | 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. | ||||
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |||||
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 (extensible): The reason the activity took place. | |||||
agent:documentSource | 1..1 | BackboneElement | Document Source | |||||
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 | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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(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 | 1..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. | |||||
agent:documentRecipient | C | 1..1 | BackboneElement | Document Recipient val-audit-source: The Audit Source is this agent too. | ||||
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 | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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(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 | 1..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 | 2..2 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type 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(Patient) | Specific instance of resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |||||
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 | 1..1 | string | Representation defined by the system Fixed Value: Person | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |||||
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 | 1..1 | string | Representation defined by the system Fixed Value: Patient | |||||
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:documentReference | C | 1..1 | BackboneElement | DocumentReference 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(DocumentReference) | Specific instance of resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 20 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Job | |||||
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 / Code | URI | |||
AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AuditEvent.type | extensible | Pattern: 110107("Import")http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | ||||
AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | ||||
AuditEvent.subtype:chmhd1 | extensible | Pattern: CH-MHD-1("Update Document Metadata")http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | ||||
AuditEvent.action | required | Pattern: Chttp://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 | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type 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.agent:documentSource.type | extensible | Pattern: 110153("Source Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentSource.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentSource.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent:documentSource.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:documentSource.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:documentRecipient.type | extensible | Pattern: 110152("Destination Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.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.type | extensible | Pattern: 1("Person")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:patient.role | extensible | Pattern: 1("Patient")http://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:documentReference.type | extensible | Pattern: 2("System Object")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:documentReference.role | extensible | Pattern: 20("Job")http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity:documentReference.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity:documentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:documentReference | Either a name or a query (NOT both) : name.empty() or query.empty() | |
val-audit-source | error | AuditEvent.agent:documentRecipient | The Audit Source is this agent too. : $this.who = %resource.source.observer |
This structure is derived from AuditEvent
Summary
Mandatory: 17 elements
Must-Support: 1 element
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AuditEvent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
modifierExtension | 0..0 | |||
type | 1..1 | Coding | Type/identifier of event Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110107 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Import | |
Slices for subtype | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this | |
subtype:chmhd1 | 1..1 | Coding | More specific type/id for the event Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH-MHD-1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Update Document Metadata | |
action | 0..1 | code | Type of action performed during the event Required Pattern: C | |
outcome | 1..1 | code | Whether the event succeeded or failed | |
outcomeDesc | S | 0..1 | string | Description of the event outcome |
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
agent:documentSource | 1..1 | BackboneElement | Document Source | |
type | 1..1 | CodeableConcept | How agent participated Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
agent:documentRecipient | C | 1..1 | BackboneElement | Document Recipient val-audit-source: The Audit Source is this agent too. |
type | 1..1 | CodeableConcept | How agent participated Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
who | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
network | 1..1 | BackboneElement | Logical network location for application activity | |
Slices for entity | 2..2 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type | |
entity:patient | 1..1 | BackboneElement | Patient | |
what | 1..1 | Reference(Patient) | Specific instance of resource | |
type | 1..1 | Coding | Type of entity involved Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
role | 0..1 | Coding | What role the entity played Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
entity:documentReference | 1..1 | BackboneElement | DocumentReference | |
what | 1..1 | Reference(DocumentReference) | Specific instance of resource | |
type | 1..1 | Coding | Type of entity involved Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
role | 0..1 | Coding | What role the entity played Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 20 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Job | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
val-audit-source | error | AuditEvent.agent:documentRecipient | The Audit Source is this agent too. : $this.who = %resource.source.observer |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110107 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Import | |
Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. |
subtype:chmhd1 | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH-MHD-1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Update Document Metadata | |
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. Required Pattern: C |
recorded | Σ | 1..1 | instant | Time when the event was recorded |
outcome | Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. |
outcomeDesc | SΣ | 0..1 | string | Description of the event outcome |
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |
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:documentSource | 1..1 | BackboneElement | Document Source | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
requestor | Σ | 1..1 | boolean | Whether user is initiator |
network | 1..1 | BackboneElement | Logical network location for application activity | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
agent:documentRecipient | C | 1..1 | BackboneElement | Document Recipient val-audit-source: The Audit Source is this agent too. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |
who | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who |
requestor | Σ | 1..1 | boolean | Whether user is initiator |
network | 1..1 | BackboneElement | Logical network location for application activity | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 | 2..2 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type 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(Patient) | Specific instance of resource |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Person | |
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Patient | |
entity:documentReference | C | 1..1 | BackboneElement | DocumentReference 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(DocumentReference) | Specific instance of resource |
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 20 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Job | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
AuditEvent.type | extensible | Pattern: 110107("Import")http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | |
AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | |
AuditEvent.subtype:chmhd1 | extensible | Pattern: CH-MHD-1("Update Document Metadata")http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | |
AuditEvent.action | required | Pattern: Chttp://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.agent:documentSource.type | extensible | Pattern: 110153("Source Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | |
AuditEvent.agent:documentRecipient.type | extensible | Pattern: 110152("Destination Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | |
AuditEvent.entity:patient.type | extensible | Pattern: 1("Person")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:patient.role | extensible | Pattern: 1("Patient")http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | |
AuditEvent.entity:documentReference.type | extensible | Pattern: 2("System Object")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | |
AuditEvent.entity:documentReference.role | extensible | Pattern: 20("Job")http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:documentReference | Either a name or a query (NOT both) : name.empty() or query.empty() | |
val-audit-source | error | AuditEvent.agent:documentRecipient | The Audit Source is this agent too. : $this.who = %resource.source.observer |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110107 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Import | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
subtype:chmhd1 | Σ | 1..1 | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH-MHD-1 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Update Document Metadata | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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. Required Pattern: C | ||||
period | 0..1 | Period | When the activity occurred | |||||
recorded | Σ | 1..1 | instant | Time when the event was recorded | ||||
outcome | Σ | 1..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. | ||||
outcomeDesc | SΣ | 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. | ||||
Slices for agent | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | |||||
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 (extensible): The reason the activity took place. | |||||
agent:documentSource | 1..1 | BackboneElement | Document Source | |||||
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 | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Source Role ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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(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 | 1..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. | |||||
agent:documentRecipient | C | 1..1 | BackboneElement | Document Recipient val-audit-source: The Audit Source is this agent too. | ||||
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 | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Destination Role ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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(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 | 1..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 | 2..2 | BackboneElement | Data or objects used Slice: Unordered, Closed by pattern:type 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(Patient) | Specific instance of resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |||||
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 | 1..1 | string | Representation defined by the system Fixed Value: Person | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |||||
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 | 1..1 | string | Representation defined by the system Fixed Value: Patient | |||||
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:documentReference | C | 1..1 | BackboneElement | DocumentReference 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(DocumentReference) | Specific instance of resource | ||||
type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: System Object | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 20 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Job | |||||
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 / Code | URI | |||
AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AuditEvent.type | extensible | Pattern: 110107("Import")http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard | ||||
AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | ||||
AuditEvent.subtype:chmhd1 | extensible | Pattern: CH-MHD-1("Update Document Metadata")http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard | ||||
AuditEvent.action | required | Pattern: Chttp://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 | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type 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.agent:documentSource.type | extensible | Pattern: 110153("Source Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentSource.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentSource.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent:documentSource.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:documentSource.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:documentRecipient.type | extensible | Pattern: 110152("Destination Role ID")http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:documentRecipient.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.type | extensible | Pattern: 1("Person")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:patient.role | extensible | Pattern: 1("Patient")http://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:documentReference.type | extensible | Pattern: 2("System Object")http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard | ||||
AuditEvent.entity:documentReference.role | extensible | Pattern: 20("Job")http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard | ||||
AuditEvent.entity:documentReference.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-events | ||||
AuditEvent.entity:documentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:documentReference | Either a name or a query (NOT both) : name.empty() or query.empty() | |
val-audit-source | error | AuditEvent.agent:documentRecipient | The Audit Source is this agent too. : $this.who = %resource.source.observer |
This structure is derived from AuditEvent
Summary
Mandatory: 17 elements
Must-Support: 1 element
Prohibited: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron