Security
and
Privacy
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Responsible Owner: Security Work Group |
|
Compartments : Device , Group , Patient , Practitioner |
Raw JSON ( canonical form + also see JSON Format Specification )
Login example
{
"resourceType": "AuditEvent",
"id": "example-login",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example-login</p><p><b>type</b>: User Authentication (Details: DICOM code 110114 = 'User Authentication', stated as 'User Authentication')</p><p><b>subtype</b>: Login (Details: DICOM code 110122 = 'Login', stated as 'Login')</p><p><b>action</b>: E</p><p><b>recorded</b>: 20/06/2013 11:41:23 PM</p><p><b>outcome</b>: 0</p><blockquote><p><b>agent</b></p><p><b>userId</b>: 95</p><p><b>altId</b>: 601847123</p><p><b>name</b>: Grahame Grieve</p><p><b>requestor</b>: true</p><h3>Networks</h3><table><tr><td>-</td><td><b>Address</b></td><td><b>Type</b></td></tr><tr><td>*</td><td>127.0.0.1</td><td>2</td></tr></table></blockquote><blockquote><p><b>agent</b></p><p><b>role</b>: Source Role ID <span>(Details : {DICOM code '110153' = 'Source Role ID', given as 'Source Role ID'})</span></p><p><b>userId</b>: 2.16.840.1.113883.4.2|2.16.840.1.113883.4.2</p><p><b>altId</b>: 6580</p><p><b>requestor</b>: false</p><h3>Networks</h3><table><tr><td>-</td><td><b>Address</b></td><td><b>Type</b></td></tr><tr><td>*</td><td>Workstation1.ehr.familyclinic.com</td><td>1</td></tr></table></blockquote><h3>Sources</h3><table><tr><td>-</td><td><b>Site</b></td><td><b>Identifier</b></td><td><b>Type</b></td></tr><tr><td>*</td><td>Cloud</td><td>hl7connect.healthintersections.com.au</td><td>Web Server (Details: http://hl7.org/fhir/security-source-type code 3 = 'Web Server', stated as 'Web Server')</td></tr></table></div>"
},
"type": {
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110114",
"display": "User Authentication"
"resourceType" : "AuditEvent",
"id" : "example-login",
"type" : {
"coding" : [{
"system" : "http://dicom.nema.org/resources/ontology/DCM",
"code" : "110114",
"display" : "User Authentication"
}]
},
"subtype": [
{
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110122",
"display": "Login"
"subtype" : [{
"coding" : [{
"system" : "http://dicom.nema.org/resources/ontology/DCM",
"code" : "110122",
"display" : "Login"
}]
}],
"action" : "E",
"recorded" : "2013-06-20T23:41:23Z",
"outcome" : {
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-outcome",
"code" : "0",
"display" : "Success"
}
],
"action": "E",
"recorded": "2013-06-20T23:41:23Z",
"outcome": "0",
"agent": [
{
"userId": {
"value": "95"
},
"altId": "601847123",
"name": "Grahame Grieve",
"requestor": true,
"network": {
"address": "127.0.0.1",
"type": "2"
}
},
"agent" : [{
"type" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code" : "humanuser",
"display" : "human user"
}]
},
{
"role": [
{
"coding": [
{
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110153",
"display": "Source Role ID"
}
]
}
],
"userId": {
"value": "2.16.840.1.113883.4.2|2.16.840.1.113883.4.2"
"who" : {
"identifier" : {
"value" : "95"
},
"altId": "6580",
"requestor": false,
"network": {
"address": "Workstation1.ehr.familyclinic.com",
"type": "1"
"display" : "Grahame Grieve"
},
"requestor" : true
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID",
"valueIdentifier" : {
"type" : {
"text" : "process ID"
},
"value" : "6580"
}
}
],
"source": {
"site": "Cloud",
"identifier": {
"value": "hl7connect.healthintersections.com.au"
}],
"type" : {
"coding" : [{
"system" : "http://dicom.nema.org/resources/ontology/DCM",
"code" : "110153",
"display" : "Source Role ID"
}]
},
"type": [
{
"system": "http://hl7.org/fhir/security-source-type",
"code": "3",
"display": "Web Server"
"who" : {
"identifier" : {
"system" : "urn:oid:2.16.840.1.113883.4.2",
"value" : "2.16.840.1.113883.4.2"
}
]
},
"requestor" : false,
"networkString" : "Workstation1.ehr.familyclinic.com"
}],
"source" : {
"observer" : {
"identifier" : {
"value" : "hl7connect.healthintersections.com.au"
},
"display" : "Cloud"
},
"type" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/security-source-type",
"code" : "3",
"display" : "Web Server"
}]
}]
}
}
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
Release
3
(STU;
v3.0.2-11200)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Thu,
Nov
27,
2025
16:52+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change