audit events

Create Audit Event

post
/organizations/{organizationId}/fhir/3/AuditEvent

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringAuditEventThis is a AuditEvent resource
type*CodingIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
subtypearray(Coding)Identifier for the category of event.
actionstringC|R|U|D|EIndicator for type of action performed during the event that generated the audit.
recordedstringThe time when the event occurred on the source.
outcomestring0|4|8|12Indicates whether the event succeeded or failed.
outcomeDescstringA free text description of the outcome of the event.
purposeOfEventarray(CodeableConcept)The purposeOfUse (reason) that was used during the event being recorded.
agent*array(AuditEvent_Agent)An actor taking an active role in the event or activity that is logged.
source*AuditEvent_SourceThe system that is reporting the event.
entityarray(AuditEvent_Entity)Specific instances of data or objects that have been accessed.

Response

Patch Audit Event

patch
/organizations/{organizationId}/fhir/3/AuditEvent/{resourceId}

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAuditEventThis is a AuditEvent resource
type*CodingIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
subtypearray(Coding)Identifier for the category of event.
actionstringC|R|U|D|EIndicator for type of action performed during the event that generated the audit.
recordedstringThe time when the event occurred on the source.
outcomestring0|4|8|12Indicates whether the event succeeded or failed.
outcomeDescstringA free text description of the outcome of the event.
purposeOfEventarray(CodeableConcept)The purposeOfUse (reason) that was used during the event being recorded.
agent*array(AuditEvent_Agent)An actor taking an active role in the event or activity that is logged.
source*AuditEvent_SourceThe system that is reporting the event.
entityarray(AuditEvent_Entity)Specific instances of data or objects that have been accessed.

Response

Read Audit Event

get
/organizations/{organizationId}/fhir/3/AuditEvent/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Audit Event

get
/organizations/{organizationId}/fhir/3/AuditEvent/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Audit Event

get
/organizations/{organizationId}/fhir/3/AuditEvent/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Audit Event

delete
/organizations/{organizationId}/fhir/3/AuditEvent/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Audit Event

get
/organizations/{organizationId}/fhir/3/AuditEvent

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actionstring
addressstring
agentstring
agent-namestring
agent-rolestring
altidstring
datestring
entitystring
entity-idstring
entity-namestring
entity-rolestring
entity-typestring
outcomestring
patientstring
policystring
sitestring
sourcestring
subtypestring
typestring
userstring

Params

organizationId*string|stringid|slug

Response

Search History Audit Event

get
/organizations/{organizationId}/fhir/3/AuditEvent/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Audit Event

post
/organizations/{organizationId}/fhir/3/AuditEvent/_search

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actionstring
addressstring
agentstring
agent-namestring
agent-rolestring
altidstring
datestring
entitystring
entity-idstring
entity-namestring
entity-rolestring
entity-typestring
outcomestring
patientstring
policystring
sitestring
sourcestring
subtypestring
typestring
userstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringAuditEventThis is a AuditEvent resource
type*CodingIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
subtypearray(Coding)Identifier for the category of event.
actionstringC|R|U|D|EIndicator for type of action performed during the event that generated the audit.
recordedstringThe time when the event occurred on the source.
outcomestring0|4|8|12Indicates whether the event succeeded or failed.
outcomeDescstringA free text description of the outcome of the event.
purposeOfEventarray(CodeableConcept)The purposeOfUse (reason) that was used during the event being recorded.
agent*array(AuditEvent_Agent)An actor taking an active role in the event or activity that is logged.
source*AuditEvent_SourceThe system that is reporting the event.
entityarray(AuditEvent_Entity)Specific instances of data or objects that have been accessed.

Response

Update Audit Event

put
/organizations/{organizationId}/fhir/3/AuditEvent/{resourceId}

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAuditEventThis is a AuditEvent resource
type*CodingIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
subtypearray(Coding)Identifier for the category of event.
actionstringC|R|U|D|EIndicator for type of action performed during the event that generated the audit.
recordedstringThe time when the event occurred on the source.
outcomestring0|4|8|12Indicates whether the event succeeded or failed.
outcomeDescstringA free text description of the outcome of the event.
purposeOfEventarray(CodeableConcept)The purposeOfUse (reason) that was used during the event being recorded.
agent*array(AuditEvent_Agent)An actor taking an active role in the event or activity that is logged.
source*AuditEvent_SourceThe system that is reporting the event.
entityarray(AuditEvent_Entity)Specific instances of data or objects that have been accessed.

Response