Security
and
Privacy
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
| Responsible Owner: Security Work Group | Standards Status : Informative | Compartments : Device , Group , Patient , Practitioner |
Raw JSON ( canonical form + also see JSON Format Specification )
An AuditEvent recording a create of a List resource for a given Patient, Encounter, and CarePlan.
{
"resourceType" : "AuditEvent",
"id" : "example-advanced-create",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: AuditEvent</b><a name=\"example-advanced-create\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource AuditEvent "example-advanced-create" </p></div><p><b>category</b>: <span title=\" to include elements not typically populated, but for which there are query parameters &#10; derived off of example in IHE.BALP IG \">create <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-restful-interaction.html\">FHIR Restful Interactions</a>#create)</span></span></p><p><b>code</b>: Restful Operation <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-audit-event-type.html\">Audit Event ID</a>#rest)</span></p><p><b>action</b>: C</p><p><b>severity</b>: informational</p><p><b>occurred</b>: 2020-04-29T09:49:00Z</p><p><b>recorded</b>: 29 Apr 2020, 7:49:00 pm</p><h3>Outcomes</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td></tr><tr><td>*</td><td>Success (Details: http://terminology.hl7.org/CodeSystem/audit-event-outcome code 0 = 'Success', stated as 'Success')</td></tr></table><p><b>authorization</b>: treatment <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActReason.html\">ActReason</a>#TREAT)</span></p><p><b>basedOn</b>: <a href=\"careplan-example.html\">CarePlan/example</a></p><p><b>patient</b>: <a href=\"patient-example.html\">Patient/example</a> "Peter CHALMERS"</p><p><b>encounter</b>: <a href=\"encounter-example-home.html\">Encounter/home</a></p><blockquote><p><b>agent</b></p><p><b>type</b>: Source Role ID <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://dicom.nema.org/resources/ontology/DCM\">DICOM</a>#110153)</span></p><p><b>who</b>: <span>: myMachine.example.org</span></p><p><b>requestor</b>: false</p><p><b>network</b>: <code>urn:ipv6:2001:0db8:85a3:0000:0000:8a2e:0370:7334</code></p></blockquote><blockquote><p><b>agent</b></p><p><b>type</b>: Destination Role ID <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://dicom.nema.org/resources/ontology/DCM\">DICOM</a>#110152)</span></p><p><b>who</b>: <a href=\"device-example.html\">Device/example</a></p><p><b>requestor</b>: false</p><p><b>network</b>: <a href=\"http://server.example.com/fhir\">http://server.example.com/fhir</a></p></blockquote><blockquote><p><b>agent</b></p><p><b>type</b>: Informant <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ParticipationType.html\">ParticipationType</a>#INF)</span></p><p><b>who</b>: <span>: Betty Jones</span></p><p><b>requestor</b>: true</p></blockquote><h3>Sources</h3><table class=\"grid\"><tr><td>-</td><td><b>Site</b></td><td><b>Observer</b></td><td><b>Type</b></td></tr><tr><td>*</td><td><span/></td><td><a href=\"device-example.html\">Device/example</a></td><td>Application Server <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-security-source-type.html\">Audit Event Source Type</a>#4)</span></td></tr></table><h3>Entities</h3><table class=\"grid\"><tr><td>-</td><td><b>What</b></td><td><b>Role</b></td></tr><tr><td>*</td><td><a href=\"list-example.html\">List/example</a></td><td>Domain Resource <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-object-role.html\">AuditEventEntityRole</a>#4)</span></td></tr></table></div>"
},
"category" : [{
"type" : {
"coding" : [{
"system" : "http://hl7.org/fhir/restful-interaction",
"code" : "create",
"display" : "create"
}]
}],
"code" : {
},
"subtype" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest",
"display" : "Restful Operation"
}]
},
}],
"action" : "C",
"severity" : "informational",
"occurredDateTime" : "2020-04-29T09:49:00.000Z",
"recorded" : "2020-04-29T09:49:00.000Z",
"outcome" : {
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-outcome",
"code" : "0",
"display" : "Success"
}
},
"authorization" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActReason",
"code" : "TREAT"
}]
}],
"basedOn" : [{
"reference" : "CarePlan/example"
}],
"patient" : {
"reference" : "Patient/example"
},
"encounter" : {
"reference" : "Encounter/home"
},
"agent" : [{
"type" : {
"coding" : [{
"system" : "http://dicom.nema.org/resources/ontology/DCM",
"code" : "110153",
"display" : "Source Role ID"
}]
},
"who" : {
"display" : "myMachine.example.org"
},
"requestor" : false,
"networkUri" : "urn:ipv6:2001:0db8:85a3:0000:0000:8a2e:0370:7334"
},
{
"type" : {
"coding" : [{
"system" : "http://dicom.nema.org/resources/ontology/DCM",
"code" : "110152",
"display" : "Destination Role ID"
}]
},
"who" : {
"reference" : "Device/example"
},
"requestor" : false,
"networkUri" : "http://server.example.com/fhir"
},
{
"type" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "INF",
"display" : "Informant"
}]
},
"who" : {
"display" : "Betty Jones"
},
"requestor" : true
}],
"source" : {
"site" : {
"identifier" : {
"value" : "http://server.example.com"
}
},
"observer" : {
"reference" : "Device/example"
},
"type" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/security-source-type",
"code" : "4",
"display" : "Application Server"
}]
}]
},
"entity" : [{
"what" : {
"reference" : "List/example"
},
"role" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/object-role",
"code" : "4",
"display" : "Domain Resource"
}]
}
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Sun,
Mar
26,
2023
15:24+1100.
Mon,
Nov
24,
2025
20:50+0000.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change