Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Valueset-security-role-type.json

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Value SetSecurityRoleType

{
  "resourceType" : "ValueSet",
  "id" : "security-role-type",
  "meta" : {
    "lastUpdated" : "2021-04-15T12:25:09.461+10:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-extensible",
    "valueBoolean" : true
  },
  {
    "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" : 2
  }],
  "url" : "http://hl7.org/fhir/ValueSet/security-role-type",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.978"
  }],
  "version" : "4.6.0",
  "name" : "SecurityRoleType",
  "title" : "SecurityRoleType",
  "status" : "draft",
  "experimental" : false,
  "date" : "2017-07-28T18:00:00+01:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "This example FHIR value set is comprised of example Actor Type codes, which can be used to value FHIR agents, actors, and other role         elements such as those specified in financial transactions. The FHIR Actor value set is based on    DICOM Audit Message, C402;   ASTM Standard, E1762-95 [2013]; selected codes and          derived actor roles from HL7 RoleClass OID 2.16.840.1.113883.5.110;    HL7 Role Code 2.16.840.1.113883.5.111, including AgentRoleType;          HL7 ParticipationType OID: 2.16.840.1.113883.5.90; and    HL7 ParticipationFunction codes OID: 2.16.840.1.113883.5.88.           This value set includes, by reference, role codes from external code systems: NUCC Health Care Provider Taxonomy OID: 2.16.840.1.113883.6.101;          North American Industry Classification System [NAICS]OID: 2.16.840.1.113883.6.85; IndustryClassificationSystem 2.16.840.1.113883.1.11.16039;          and US Census Occupation Code OID: 2.16.840.1.113883.6.243 for relevant recipient or custodian codes not included in this value set.            If no source is indicated in the definition comments, then these are example FHIR codes.          It can be extended with appropriate roles described by SNOMED as well as those described in the HL7 Role Based Access Control Catalog and the          HL7 Healthcare (Security and Privacy) Access Control Catalog.            In Role-Based Access Control (RBAC), permissions are operations on an object that a user wishes to access. Permissions are grouped into roles.          A role characterizes the functions a user is allowed to perform. Roles are assigned to users. If the user's role has the appropriate permissions          to access an object, then that user is granted access to the object. FHIR readily enables RBAC, as FHIR Resources are object types and the CRUDE          events (the FHIR equivalent to permissions in the RBAC scheme) are operations on those objects.          In Attribute-Based Access Control (ABAC), a user requests to perform operations on objects. That user's access request is granted or denied          based on a set of access control policies that are specified in terms of attributes and conditions. FHIR readily enables ABAC, as instances of          a Resource in FHIR (again, Resources are object types) can have attributes associated with them. These attributes include security tags,          environment conditions, and a host of user and object characteristics, which are the same attributes as those used in ABAC. Attributes help          define the access control policies that determine the operations a user may perform on a Resource (in FHIR) or object (in ABAC). For example,          a tag (or attribute) may specify that the identified Resource (object) is not to be further disclosed without explicit consent from the patient.",
  "copyright" : "This is an example FHIR value set based on ASTM Standard, E1762-95 (2013) HL7 RoleClass OID 2.16.840.1.113883.5.110,          HL7 Role Code 2.16.840.1.113883.5.111, HL7 ParticipationType OID: 2.16.840.1.113883.5.90, HL7 ParticipationFunction codes at OID: 2.16.840.1.113883.5.88,          and HL7 Security and Privacy Domain Analysis Model roles classes.   These codes are excerpted from Digital Imaging and Communications in Medicine (DICOM) Standard, Part 16: Content Mapping Resource, Copyright © 2011 by the National Electrical Manufacturers Association.",
  "compose" : {
    "include" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
      "concept" : [{
        "code" : "AMENDER"
      },
      {
        "code" : "COAUTH"
      },
      {
        "code" : "CONT"
      },
      {
        "code" : "EVTWIT"
      },
      {
        "code" : "PRIMAUTH"
      },
      {
        "code" : "REVIEWER"
      },
      {
        "code" : "SOURCE"
      },
      {
        "code" : "TRANS"
      },
      {
        "code" : "VALID"
      },
      {
        "code" : "VERF"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "concept" : [{
        "code" : "AFFL"
      },
      {
        "code" : "AGNT"
      },
      {
        "code" : "ASSIGNED"
      },
      {
        "code" : "CLAIM"
      },
      {
        "code" : "COVPTY"
      },
      {
        "code" : "DEPEN"
      },
      {
        "code" : "ECON"
      },
      {
        "code" : "EMP"
      },
      {
        "code" : "GUARD"
      },
      {
        "code" : "INVSBJ"
      },
      {
        "code" : "NAMED"
      },
      {
        "code" : "NOK"
      },
      {
        "code" : "PAT"
      },
      {
        "code" : "PROV"
      },
      {
        "code" : "NOT"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "concept" : [{
        "code" : "CLASSIFIER"
      },
      {
        "code" : "CONSENTER"
      },
      {
        "code" : "CONSWIT"
      },
      {
        "code" : "COPART"
      },
      {
        "code" : "DECLASSIFIER"
      },
      {
        "code" : "DELEGATEE"
      },
      {
        "code" : "DELEGATOR"
      },
      {
        "code" : "DOWNGRDER"
      },
      {
        "code" : "DPOWATT"
      },
      {
        "code" : "EXCEST"
      },
      {
        "code" : "GRANTEE"
      },
      {
        "code" : "GRANTOR"
      },
      {
        "code" : "GT"
      },
      {
        "code" : "GUADLTM"
      },
      {
        "code" : "HPOWATT"
      },
      {
        "code" : "INTPRTER"
      },
      {
        "code" : "POWATT"
      },
      {
        "code" : "RESPRSN"
      },
      {
        "code" : "SPOWATT"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "filter" : [{
        "property" : "concept",
        "op" : "is-a",
        "value" : "_CitizenRoleType"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "concept" : [{
        "code" : "AUCG"
      },
      {
        "code" : "AULR"
      },
      {
        "code" : "AUTM"
      },
      {
        "code" : "AUWA"
      },
      {
        "code" : "PROMSK"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
      "concept" : [{
        "code" : "AUT"
      },
      {
        "code" : "CST"
      },
      {
        "code" : "INF"
      },
      {
        "code" : "IRCP"
      },
      {
        "code" : "LA"
      },
      {
        "code" : "IRCP"
      },
      {
        "code" : "TRC"
      },
      {
        "code" : "WIT"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type"
    }]
  }
}

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.