HL7 Terminology
1.0.0 - Publication

This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. The current version which supercedes this version is 5.2.0. For a full list of available versions, see the Directory of published versions

AuditEventEntityRole - JSON Representation

(back to description)

Raw json

Source view

{
  "resourceType" : "CodeSystem",
  "id" : "object-role",
  "meta" : {
    "lastUpdated" : "2020-04-09T21:10:28.568+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            \n      <h2>AuditEventEntityRole</h2>\n            \n      <div>\n              \n        <p>Code representing the role the entity played in the audit event.</p>\n\n            \n      </div>\n            \n      <p>This code system http://terminology.hl7.org/CodeSystem/object-role defines the following codes:</p>\n            \n      <table class=\"codes\">\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">\n                  \n            <b>Code</b>\n                \n          </td>\n                \n          <td>\n                  \n            <b>Display</b>\n                \n          </td>\n                \n          <td>\n                  \n            <b>Definition</b>\n                \n          </td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">1\n                  \n            <a name=\"object-role-1\"> </a>\n                \n          </td>\n                \n          <td>Patient</td>\n                \n          <td>This object is the patient that is the subject of care related to this event.  It is identifiable by patient ID or equivalent.  The patient may be either human or animal.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">2\n                  \n            <a name=\"object-role-2\"> </a>\n                \n          </td>\n                \n          <td>Location</td>\n                \n          <td>This is a location identified as related to the event.  This is usually the location where the event took place.  Note that for shipping, the usual events are arrival at a location or departure from a location.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">3\n                  \n            <a name=\"object-role-3\"> </a>\n                \n          </td>\n                \n          <td>Report</td>\n                \n          <td>This object is any kind of persistent document created as a result of the event.  This could be a paper report, film, electronic report, DICOM Study, etc.  Issues related to medical records life cycle management are conveyed elsewhere.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">4\n                  \n            <a name=\"object-role-4\"> </a>\n                \n          </td>\n                \n          <td>Domain Resource</td>\n                \n          <td>A logical object related to a health record event.  This is any healthcare  specific resource (object) not restricted to FHIR defined Resources.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">5\n                  \n            <a name=\"object-role-5\"> </a>\n                \n          </td>\n                \n          <td>Master file</td>\n                \n          <td>This is any configurable file used to control creation of documents.  Examples include the objects maintained by the HL7 Master File transactions, Value Sets, etc.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">6\n                  \n            <a name=\"object-role-6\"> </a>\n                \n          </td>\n                \n          <td>User</td>\n                \n          <td>A human participant not otherwise identified by some other category.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">7\n                  \n            <a name=\"object-role-7\"> </a>\n                \n          </td>\n                \n          <td>List</td>\n                \n          <td>(deprecated).</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">8\n                  \n            <a name=\"object-role-8\"> </a>\n                \n          </td>\n                \n          <td>Doctor</td>\n                \n          <td>Typically, a licensed person who is providing or performing care related to the event, generally a physician.   The key distinction between doctor and practitioner is with regards to their role, not the licensing.  The doctor is the human who actually performed the work.  The practitioner is the human or organization that is responsible for the work.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">9\n                  \n            <a name=\"object-role-9\"> </a>\n                \n          </td>\n                \n          <td>Subscriber</td>\n                \n          <td>A person or system that is being notified as part of the event.  This is relevant in situations where automated systems provide notifications to other parties when an event took place.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">10\n                  \n            <a name=\"object-role-10\"> </a>\n                \n          </td>\n                \n          <td>Guarantor</td>\n                \n          <td>Insurance company, or any other organization who accepts responsibility for paying for the healthcare event.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">11\n                  \n            <a name=\"object-role-11\"> </a>\n                \n          </td>\n                \n          <td>Security User Entity</td>\n                \n          <td>A person or active system object involved in the event with a security role.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">12\n                  \n            <a name=\"object-role-12\"> </a>\n                \n          </td>\n                \n          <td>Security User Group</td>\n                \n          <td>A person or system object involved in the event with the authority to modify security roles of other objects.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">13\n                  \n            <a name=\"object-role-13\"> </a>\n                \n          </td>\n                \n          <td>Security Resource</td>\n                \n          <td>A passive object, such as a role table, that is relevant to the event.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">14\n                  \n            <a name=\"object-role-14\"> </a>\n                \n          </td>\n                \n          <td>Security Granularity Definition</td>\n                \n          <td>(deprecated)  Relevant to certain RBAC security methodologies.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">15\n                  \n            <a name=\"object-role-15\"> </a>\n                \n          </td>\n                \n          <td>Practitioner</td>\n                \n          <td>Any person or organization responsible for providing care.  This encompasses all forms of care, licensed or otherwise, and all sorts of teams and care groups. Note the distinction between practitioner and the doctor that actually provided the care to the patient.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">16\n                  \n            <a name=\"object-role-16\"> </a>\n                \n          </td>\n                \n          <td>Data Destination</td>\n                \n          <td>The source or destination for data transfer, when it does not match some other role.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">17\n                  \n            <a name=\"object-role-17\"> </a>\n                \n          </td>\n                \n          <td>Data Repository</td>\n                \n          <td>A source or destination for data transfer that acts as an archive, database, or similar role.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">18\n                  \n            <a name=\"object-role-18\"> </a>\n                \n          </td>\n                \n          <td>Schedule</td>\n                \n          <td>An object that holds schedule information.  This could be an appointment book, availability information, etc.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">19\n                  \n            <a name=\"object-role-19\"> </a>\n                \n          </td>\n                \n          <td>Customer</td>\n                \n          <td>An organization or person that is the recipient of services.  This could be an organization that is buying services for a patient, or a person that is buying services for an animal.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">20\n                  \n            <a name=\"object-role-20\"> </a>\n                \n          </td>\n                \n          <td>Job</td>\n                \n          <td>An order, task, work item, procedure step, or other description of work to be performed; e.g. a particular instance of an MPPS.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">21\n                  \n            <a name=\"object-role-21\"> </a>\n                \n          </td>\n                \n          <td>Job Stream</td>\n                \n          <td>A list of jobs or a system that provides lists of jobs; e.g. an MWL SCP.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">22\n                  \n            <a name=\"object-role-22\"> </a>\n                \n          </td>\n                \n          <td>Table</td>\n                \n          <td>(Deprecated).</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">23\n                  \n            <a name=\"object-role-23\"> </a>\n                \n          </td>\n                \n          <td>Routing Criteria</td>\n                \n          <td>An object that specifies or controls the routing or delivery of items.  For example, a distribution list is the routing criteria for mail.  The items delivered may be documents, jobs, or other objects.</td>\n              \n        </tr>\n              \n        <tr>\n                \n          <td style=\"white-space:nowrap\">24\n                  \n            <a name=\"object-role-24\"> </a>\n                \n          </td>\n                \n          <td>Query</td>\n                \n          <td>The contents of a query.  This is used to capture the contents of any kind of query.  For security surveillance purposes knowing the queries being made is very important.</td>\n              \n        </tr>\n            \n      </table>\n          \n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "sec"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3
    }
  ],
  "url" : "http://terminology.hl7.org/CodeSystem/object-role",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.1.1135"
    }
  ],
  "version" : "4.2.0",
  "name" : "AuditEventEntityRole",
  "title" : "AuditEventEntityRole",
  "status" : "draft",
  "experimental" : false,
  "date" : "2020-04-09T21:10:28+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/fhir"
        },
        {
          "system" : "email",
          "value" : "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "Code representing the role the entity played in the audit event.",
  "caseSensitive" : true,
  "valueSet" : "http://terminology.hl7.org/ValueSet/object-role",
  "content" : "complete",
  "concept" : [
    {
      "code" : "1",
      "display" : "Patient",
      "definition" : "This object is the patient that is the subject of care related to this event.  It is identifiable by patient ID or equivalent.  The patient may be either human or animal."
    },
    {
      "code" : "2",
      "display" : "Location",
      "definition" : "This is a location identified as related to the event.  This is usually the location where the event took place.  Note that for shipping, the usual events are arrival at a location or departure from a location."
    },
    {
      "code" : "3",
      "display" : "Report",
      "definition" : "This object is any kind of persistent document created as a result of the event.  This could be a paper report, film, electronic report, DICOM Study, etc.  Issues related to medical records life cycle management are conveyed elsewhere."
    },
    {
      "code" : "4",
      "display" : "Domain Resource",
      "definition" : "A logical object related to a health record event.  This is any healthcare  specific resource (object) not restricted to FHIR defined Resources."
    },
    {
      "code" : "5",
      "display" : "Master file",
      "definition" : "This is any configurable file used to control creation of documents.  Examples include the objects maintained by the HL7 Master File transactions, Value Sets, etc."
    },
    {
      "code" : "6",
      "display" : "User",
      "definition" : "A human participant not otherwise identified by some other category."
    },
    {
      "code" : "7",
      "display" : "List",
      "definition" : "(deprecated)."
    },
    {
      "code" : "8",
      "display" : "Doctor",
      "definition" : "Typically, a licensed person who is providing or performing care related to the event, generally a physician.   The key distinction between doctor and practitioner is with regards to their role, not the licensing.  The doctor is the human who actually performed the work.  The practitioner is the human or organization that is responsible for the work."
    },
    {
      "code" : "9",
      "display" : "Subscriber",
      "definition" : "A person or system that is being notified as part of the event.  This is relevant in situations where automated systems provide notifications to other parties when an event took place."
    },
    {
      "code" : "10",
      "display" : "Guarantor",
      "definition" : "Insurance company, or any other organization who accepts responsibility for paying for the healthcare event."
    },
    {
      "code" : "11",
      "display" : "Security User Entity",
      "definition" : "A person or active system object involved in the event with a security role."
    },
    {
      "code" : "12",
      "display" : "Security User Group",
      "definition" : "A person or system object involved in the event with the authority to modify security roles of other objects."
    },
    {
      "code" : "13",
      "display" : "Security Resource",
      "definition" : "A passive object, such as a role table, that is relevant to the event."
    },
    {
      "code" : "14",
      "display" : "Security Granularity Definition",
      "definition" : "(deprecated)  Relevant to certain RBAC security methodologies."
    },
    {
      "code" : "15",
      "display" : "Practitioner",
      "definition" : "Any person or organization responsible for providing care.  This encompasses all forms of care, licensed or otherwise, and all sorts of teams and care groups. Note the distinction between practitioner and the doctor that actually provided the care to the patient."
    },
    {
      "code" : "16",
      "display" : "Data Destination",
      "definition" : "The source or destination for data transfer, when it does not match some other role."
    },
    {
      "code" : "17",
      "display" : "Data Repository",
      "definition" : "A source or destination for data transfer that acts as an archive, database, or similar role."
    },
    {
      "code" : "18",
      "display" : "Schedule",
      "definition" : "An object that holds schedule information.  This could be an appointment book, availability information, etc."
    },
    {
      "code" : "19",
      "display" : "Customer",
      "definition" : "An organization or person that is the recipient of services.  This could be an organization that is buying services for a patient, or a person that is buying services for an animal."
    },
    {
      "code" : "20",

      "display" : "Job",
      "definition" : "An order, task, work item, procedure step, or other description of work to be performed; e.g. a particular instance of an MPPS."
    },
    {
      "code" : "21",
      "display" : "Job Stream",
      "definition" : "A list of jobs or a system that provides lists of jobs; e.g. an MWL SCP."
    },
    {
      "code" : "22",
      "display" : "Table",
      "definition" : "(Deprecated)."
    },
    {
      "code" : "23",
      "display" : "Routing Criteria",
      "definition" : "An object that specifies or controls the routing or delivery of items.  For example, a distribution list is the routing criteria for mail.  The items delivered may be documents, jobs, or other objects."
    },
    {
      "code" : "24",
      "display" : "Query",
      "definition" : "The contents of a query.  This is used to capture the contents of any kind of query.  For security surveillance purposes knowing the queries being made is very important."
    }
  ]
}