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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	AuditEvent	This is a AuditEvent resource
type*	Coding		Identifier 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.
subtype	array(Coding)		Identifier for the category of event.
action	string	C\|R\|U\|D\|E	Indicator for type of action performed during the event that generated the audit.
recorded	string		The time when the event occurred on the source.
outcome	string	0\|4\|8\|12	Indicates whether the event succeeded or failed.
outcomeDesc	string		A free text description of the outcome of the event.
purposeOfEvent	array(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_Source		The system that is reporting the event.
entity	array(AuditEvent_Entity)		Specific instances of data or objects that have been accessed.

Response

201 400 401 404

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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	AuditEvent	This is a AuditEvent resource
type*	Coding		Identifier 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.
subtype	array(Coding)		Identifier for the category of event.
action	string	C\|R\|U\|D\|E	Indicator for type of action performed during the event that generated the audit.
recorded	string		The time when the event occurred on the source.
outcome	string	0\|4\|8\|12	Indicates whether the event succeeded or failed.
outcomeDesc	string		A free text description of the outcome of the event.
purposeOfEvent	array(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_Source		The system that is reporting the event.
entity	array(AuditEvent_Entity)		Specific instances of data or objects that have been accessed.

Response

200 201 400 401 404 409

Read Audit Event

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Audit Event

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Audit Event

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Audit Event

delete

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Audit Event

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
action	string
address	string
agent	string
agent-name	string
agent-role	string
altid	string
date	string
entity	string
entity-id	string
entity-name	string
entity-role	string
entity-type	string
outcome	string
patient	string
policy	string
site	string
source	string
subtype	string
type	string
user	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Audit Event

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
action	string
address	string
agent	string
agent-name	string
agent-role	string
altid	string
date	string
entity	string
entity-id	string
entity-name	string
entity-role	string
entity-type	string
outcome	string
patient	string
policy	string
site	string
source	string
subtype	string
type	string
user	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	AuditEvent	This is a AuditEvent resource
type*	Coding		Identifier 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.
subtype	array(Coding)		Identifier for the category of event.
action	string	C\|R\|U\|D\|E	Indicator for type of action performed during the event that generated the audit.
recorded	string		The time when the event occurred on the source.
outcome	string	0\|4\|8\|12	Indicates whether the event succeeded or failed.
outcomeDesc	string		A free text description of the outcome of the event.
purposeOfEvent	array(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_Source		The system that is reporting the event.
entity	array(AuditEvent_Entity)		Specific instances of data or objects that have been accessed.

Response

200 401 404

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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	AuditEvent	This is a AuditEvent resource
type*	Coding		Identifier 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.
subtype	array(Coding)		Identifier for the category of event.
action	string	C\|R\|U\|D\|E	Indicator for type of action performed during the event that generated the audit.
recorded	string		The time when the event occurred on the source.
outcome	string	0\|4\|8\|12	Indicates whether the event succeeded or failed.
outcomeDesc	string		A free text description of the outcome of the event.
purposeOfEvent	array(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_Source		The system that is reporting the event.
entity	array(AuditEvent_Entity)		Specific instances of data or objects that have been accessed.

Response

200 201 400 401 404 409