AuditEvent - FHIR v6.0.0-ballot1

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

6.4.14 Resource AuditEvent - Search Parameters

Security

Work Group

Maturity Level: N/A

Trial Use

Security Category: Not Classified

Compartments: Device, Patient, Practitioner

Search parameters for the Resource AuditEvent - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/AuditEvent-action

6.4.15 action

Parameter action:token

Type of action performed during the event

Resource AuditEvent

Expression AuditEvent.action

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-agent

6.4.16 agent

Parameter agent:reference

Identifier of who

Resource AuditEvent

Expression AuditEvent.agent.who

Processing Mode Normal

Target Resources Organization, CareTeam, Device, RelatedPerson, PractitionerRole, Practitioner, Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-agent-role

6.4.17 agent-role

Parameter agent-role:token

Agent role in the event

Resource AuditEvent

Expression AuditEvent.agent.role

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-based-on

6.4.18 based-on

Parameter based-on:reference

Reference to the service request.

Resource AuditEvent

Expression AuditEvent.basedOn

Processing Mode Normal

Target Resources DeviceRequest, ServiceRequest, CarePlan, Task, MedicationRequest, ImmunizationRecommendation, NutritionOrder

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-category

6.4.19 category

Parameter category:token

Category of event

Resource AuditEvent

Expression AuditEvent.category

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-code

This search parameter is part of the common search parameter clinical-code

6.4.20 code

Parameter code:token

AuditEvent: More specific code for the event

Resource AuditEvent

Expression AuditEvent.code

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-date

This search parameter is part of the common search parameter clinical-date

6.4.21 date

Parameter date:date

AuditEvent: Time when the event was recorded

Resource AuditEvent

Expression AuditEvent.recorded

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/clinical-encounter

6.4.22 encounter

Parameter encounter:reference

Multiple Resources:

AuditEvent: Encounter related to the activity recorded in the AuditEvent
CarePlan: The Encounter during which this CarePlan was created
ChargeItem: Encounter associated with event
Claim: Encounters associated with a billed line item
ClinicalImpression: The Encounter during which this ClinicalImpression was created
Communication: The Encounter during which this Communication was created
CommunicationRequest: The Encounter during which this CommunicationRequest was created
Composition: Context of the Composition
Condition: The Encounter during which this Condition was created
DeviceRequest: Encounter during which request was created
DiagnosticReport: The Encounter when the order was made
EncounterHistory: The Encounter associated with this set of history values
ExplanationOfBenefit: Encounters associated with a billed line item
Flag: Alert relevant during encounter
ImagingStudy: The context of the study
List: Context in which list created
MedicationDispense: Returns dispenses with a specific encounter
MedicationStatement: Returns statements for a specific encounter
NutritionIntake: Returns statements for a specific encounter
NutritionOrder: Return nutrition orders with this encounter identifier
Observation: Encounter related to the observation
Procedure: The Encounter during which this Procedure was created
Provenance: Encounter related to the Provenance
QuestionnaireResponse: Encounter associated with the questionnaire response
RequestOrchestration: The encounter the request orchestration applies to
RiskAssessment: Where was assessment performed?
ServiceRequest: An encounter in which this request is made
Task: Search by encounter
VisionPrescription: Return prescriptions with this encounter identifier

Resources AuditEvent, CarePlan, ChargeItem, Claim, ClinicalImpression, Communication, CommunicationRequest, Composition, Condition, DeviceRequest, DiagnosticReport, EncounterHistory, ExplanationOfBenefit, Flag, ImagingStudy, List, MedicationDispense, MedicationStatement, NutritionIntake, NutritionOrder, Observation, Procedure, Provenance, QuestionnaireResponse, RequestOrchestration, RiskAssessment, ServiceRequest, Task, VisionPrescription

Processing Mode Normal

Target Resources Encounter

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-entity

6.4.23 entity

Parameter entity:reference

Specific instance of resource

Resource AuditEvent

Expression AuditEvent.entity.what

Processing Mode Normal

Target Resources Account, ActivityDefinition, ActorDefinition, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, Binary, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, ChargeItem, ChargeItemDefinition, Citation, Claim, ClaimResponse, ClinicalImpression, ClinicalUseDefinition, CodeSystem, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, ConditionDefinition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceAssociation, DeviceDefinition, DeviceDispense, DeviceMetric, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, Encounter, EncounterHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, FormularyItem, GenomicStudy, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingSelection, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, Ingredient, InsurancePlan, InventoryItem, InventoryReport, Invoice, Library, Linkage, List, Location, ManufacturedItemDefinition, Measure, MeasureReport, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProductDefinition, MessageDefinition, MessageHeader, MolecularSequence, NamingSystem, NutritionIntake, NutritionOrder, NutritionProduct, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PackagedProductDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RegulatedAuthorization, RelatedPerson, RequestOrchestration, Requirements, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Subscription, SubscriptionStatus, SubscriptionTopic, Substance, SubstanceDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, TestPlan, TestReport, TestScript, Transport, ValueSet, VerificationResult, VisionPrescription

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-entity-role

6.4.24 entity-role

Parameter entity-role:token

What role the entity played

Resource AuditEvent

Expression AuditEvent.entity.role

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-outcome

6.4.25 outcome

Parameter outcome:token

Whether the event succeeded or failed

Resource AuditEvent

Expression AuditEvent.outcome.code

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-patient

This search parameter is part of the common search parameter clinical-patient

6.4.26 patient

Parameter patient:reference

AuditEvent: Where the activity involved patient data

Resource AuditEvent

Expression AuditEvent.patient

Processing Mode Normal

Target Resources Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-policy

6.4.27 policy

Parameter policy:uri

Policy that authorized event

Resource AuditEvent

Expression AuditEvent.agent.policy

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-purpose

6.4.28 purpose

Parameter purpose:token

The authorization (purposeOfUse) of the event

Resource AuditEvent

Expression AuditEvent.authorization | AuditEvent.agent.authorization

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/AuditEvent-source

6.4.29 source

Parameter source:reference

The identity of source detecting the event

Resource AuditEvent

Expression AuditEvent.source.observer

Processing Mode Normal

Target Resources Organization, CareTeam, Device, RelatedPerson, PractitionerRole, Practitioner, Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true