2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

6.6.6 Resource SecurityEvent - Examples

Example Index:

General SecurityEvent ExampleXMLJSON
Login exampleXMLJSON
Logout exampleXMLJSON
RESTful OperationXMLJSON

6.6.6.1 General

XML

General SecurityEvent Example (id = "example")

Raw XML

<SecurityEvent xmlns="http://hl7.org/fhir">
  <id value="example"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <event>
    <type>
      <coding>
        <system value="http://nema.org/dicom/dicm"/>
        <code value="110100"/>
        <display value="Application Activity"/>
      </coding>
    </type>
    <subtype>
      <coding>
        <system value="http://nema.org/dicom/dicm"/>
        <code value="110120"/>
        <display value="Application Start"/>
      </coding>
    </subtype>
    <action value="E"/>
    <dateTime value="2012-10-25T22:04:27+11:00"/>
    <outcome value="0"/>
  </event>
  <participant>
    <role>
      <text value="Service User (Logon)"/>
    </role>
    <userId value="Grahame"/>
    <requestor value="false"/>
    <network>
      <identifier value="127.0.0.1"/>
      <type value="2"/>
    </network>
  </participant>
  <source>
    <site value="Development"/>
    <identifier value="Grahame's Laptop"/>
    <type>
      <system value="http://hl7.org/fhir/security-event-sub-type"/>
      <code value="1"/>
    </type>
  </source>
  <object>
    <identifier>
      <label value="Dell Serial Number"/>
      <value value="ABCDEF"/>
    </identifier>
    <type value="4"/>
    <role value="4"/>
    <lifecycle value="6"/>
    <name value="Grahame's Laptop"/>
  </object>
</SecurityEvent>

JSON

General SecurityEvent Example

Raw JSON (Canonical)

{
  "resourceType": "SecurityEvent",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "event": {
    "type": {
      "coding": [
        {
          "system": "http://nema.org/dicom/dicm",
          "code": "110100",
          "display": "Application Activity"
        }
      ]
    },
    "subtype": [
      {
        "coding": [
          {
            "system": "http://nema.org/dicom/dicm",
            "code": "110120",
            "display": "Application Start"
          }
        ]
      }
    ],
    "action": "E",
    "dateTime": "2012-10-25T22:04:27+11:00",
    "outcome": "0"
  },
  "participant": [
    {
      "role": [
        {
          "text": "Service User (Logon)"
        }
      ],
      "userId": "Grahame",
      "requestor": false,
      "network": {
        "identifier": "127.0.0.1",
        "type": "2"
      }
    }
  ],
  "source": {
    "site": "Development",
    "identifier": "Grahame's Laptop",
    "type": [
      {
        "system": "http://hl7.org/fhir/security-event-sub-type",
        "code": "1"
      }
    ]
  },
  "object": [
    {
      "identifier": {
        "label": "Dell Serial Number",
        "value": "ABCDEF"
      },
      "type": "4",
      "role": "4",
      "lifecycle": "6",
      "name": "Grahame's Laptop"
    }
  ]
}

6.6.6.2 Login

XML

Login example (id = "example-login")

Raw XML

<SecurityEvent xmlns="http://hl7.org/fhir">
 <id value="example-login"/>
  <event>
    <type>
      <coding>
        <system value="http://nema.org/dicom/dicm"/>
        <code value="110114"/>
        <display value="User Authentication"/>
      </coding>
    </type>
    <subtype>
      <coding>
        <system value="http://nema.org/dicom/dicm"/>
        <code value="110122"/>
        <display value="Login"/>
      </coding>
    </subtype>
    <action value="E"/>
    <dateTime value="2013-06-20T23:41:23Z"/>
    <outcome value="0"/>
  </event>
  <participant>
    <userId value="95"/>
    <altId value="601847123"/>
    <name value="Grahame Grieve"/>
    <requestor value="true"/>
    <network>
      <identifier value="127.0.0.1"/>
      <type value="2"/>
    </network>
  </participant>
  <source>
    <site value="Cloud"/>
    <identifier value="hl7connect.healthintersections.com.au"/>
    <type>
      <system value="http://hl7.org/fhir/security-source-type"/>
      <code value="3"/>
      <display value="Web Server"/>
    </type>
  </source>
</SecurityEvent>

JSON

Login example

Raw JSON (Canonical)

{
  "resourceType": "SecurityEvent",
  "id": "example-login",
  "event": {
    "type": {
      "coding": [
        {
          "system": "http://nema.org/dicom/dicm",
          "code": "110114",
          "display": "User Authentication"
        }
      ]
    },
    "subtype": [
      {
        "coding": [
          {
            "system": "http://nema.org/dicom/dicm",
            "code": "110122",
            "display": "Login"
          }
        ]
      }
    ],
    "action": "E",
    "dateTime": "2013-06-20T23:41:23Z",
    "outcome": "0"
  },
  "participant": [
    {
      "userId": "95",
      "altId": "601847123",
      "name": "Grahame Grieve",
      "requestor": true,
      "network": {
        "identifier": "127.0.0.1",
        "type": "2"
      }
    }
  ],
  "source": {
    "site": "Cloud",
    "identifier": "hl7connect.healthintersections.com.au",
    "type": [
      {
        "system": "http://hl7.org/fhir/security-source-type",
        "code": "3",
        "display": "Web Server"
      }
    ]
  }
}

6.6.6.3 Logout

XML

Logout example (id = "example-logout")

Raw XML

<SecurityEvent xmlns="http://hl7.org/fhir">
 <id value="example-logout"/>
  <event>
    <type>
      <coding>
        <system value="http://nema.org/dicom/dicm"/>
        <code value="110114"/>
        <display value="User Authentication"/>
      </coding>
    </type>
    <subtype>
      <coding>
        <system value="http://nema.org/dicom/dicm"/>
        <code value="110123"/>
        <display value="Logout"/>
      </coding>
    </subtype>
    <action value="E"/>
    <dateTime value="2013-06-20T23:46:41Z"/>
    <outcome value="0"/>
  </event>
  <participant>
    <userId value="95"/>
    <altId value="601847123"/>
    <name value="Grahame Grieve"/>
    <requestor value="true"/>
    <network>
      <identifier value="127.0.0.1"/>
      <type value="2"/>
    </network>
  </participant>
  <source>
    <site value="Cloud"/>
    <identifier value="hl7connect.healthintersections.com.au"/>
    <type>
      <system value="http://hl7.org/fhir/security-source-type"/>
      <code value="3"/>
      <display value="Web Server"/>
    </type>
  </source>
</SecurityEvent>

JSON

Logout example

Raw JSON (Canonical)

{
  "resourceType": "SecurityEvent",
  "id": "example-logout",
  "event": {
    "type": {
      "coding": [
        {
          "system": "http://nema.org/dicom/dicm",
          "code": "110114",
          "display": "User Authentication"
        }
      ]
    },
    "subtype": [
      {
        "coding": [
          {
            "system": "http://nema.org/dicom/dicm",
            "code": "110123",
            "display": "Logout"
          }
        ]
      }
    ],
    "action": "E",
    "dateTime": "2013-06-20T23:46:41Z",
    "outcome": "0"
  },
  "participant": [
    {
      "userId": "95",
      "altId": "601847123",
      "name": "Grahame Grieve",
      "requestor": true,
      "network": {
        "identifier": "127.0.0.1",
        "type": "2"
      }
    }
  ],
  "source": {
    "site": "Cloud",
    "identifier": "hl7connect.healthintersections.com.au",
    "type": [
      {
        "system": "http://hl7.org/fhir/security-source-type",
        "code": "3",
        "display": "Web Server"
      }
    ]
  }
}

6.6.6.4 RESTful Operation

XML

RESTful Operation (id = "example-rest")

Raw XML

<SecurityEvent xmlns="http://hl7.org/fhir">
 <id value="example-rest"/>
  <event>
    <type>
      <coding>
        <system value="http://hl7.org/fhir/security-event-type"/>
        <code value="rest"/>
        <display value="Restful Operation"/>
      </coding>
    </type>
    <subtype>
      <coding>
        <system value="http://hl7.org/fhir/restful-interaction"/>
        <code value="vread"/>
        <display value="vread"/>
      </coding>
    </subtype>
    <action value="R"/>
    <dateTime value="2013-06-20T23:42:24Z"/>
    <outcome value="0"/>
  </event>
  <participant>
    <userId value="95"/>
    <altId value="601847123"/>
    <name value="Grahame Grieve"/>
    <requestor value="true"/>
  </participant>
  <source>
    <site value="Cloud"/>
    <identifier value="hl7connect.healthintersections.com.au"/>
    <type>
      <system value="http://hl7.org/fhir/security-source-type"/>
      <code value="3"/>
      <display value="Web Server"/>
    </type>
  </source>
  <object>
    <reference>
      <reference value="Patient/example/_history/1"/>
    </reference>
    <type value="2"/>
    <lifecycle value="6"/>
  </object>
</SecurityEvent>

JSON

RESTful Operation

Raw JSON (Canonical)

{
  "resourceType": "SecurityEvent",
  "id": "example-rest",
  "event": {
    "type": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/security-event-type",
          "code": "rest",
          "display": "Restful Operation"
        }
      ]
    },
    "subtype": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/restful-interaction",
            "code": "vread",
            "display": "vread"
          }
        ]
      }
    ],
    "action": "R",
    "dateTime": "2013-06-20T23:42:24Z",
    "outcome": "0"
  },
  "participant": [
    {
      "userId": "95",
      "altId": "601847123",
      "name": "Grahame Grieve",
      "requestor": true
    }
  ],
  "source": {
    "site": "Cloud",
    "identifier": "hl7connect.healthintersections.com.au",
    "type": [
      {
        "system": "http://hl7.org/fhir/security-source-type",
        "code": "3",
        "display": "Web Server"
      }
    ]
  },
  "object": [
    {
      "reference": {
        "reference": "Patient/example/_history/1"
      },
      "type": "2",
      "lifecycle": "6"
    }
  ]
}

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.