Package ca.uhn.fhir.model.dstu2.valueset

Enum AuditEventObjectRoleEnum

java.lang.Object
java.lang.Enum<AuditEventObjectRoleEnum>
ca.uhn.fhir.model.dstu2.valueset.AuditEventObjectRoleEnum
All Implemented Interfaces:
Serializable, Comparable<AuditEventObjectRoleEnum>
public enum AuditEventObjectRoleEnum extends Enum<AuditEventObjectRoleEnum>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CUSTOMER
    Display: Customer
    Code Value: 19 An organization or person that is the recipient of services.
    DATA_DESTINATION
    Display: Data Destination
    Code Value: 16 The source or destination for data transfer, when it does not match some other role.
    DATA_REPOSITORY
    Display: Data Repository
    Code Value: 17 A source or destination for data transfer that acts as an archive, database, or similar role.
    DOCTOR
    Display: Doctor
    Code Value: 8 Typically a licensed person who is providing or performing care related to the event, generally a physician.
    DOMAIN_RESOURCE
    Display: Domain Resource
    Code Value: 4 A logical object related to a health record event.
    GUARANTOR
    Display: Guarantor
    Code Value: 10 Insurance company, or any other organization who accepts responsibility for paying for the healthcare event.
    JOB
    Display: Job
    Code Value: 20 An order, task, work item, procedure step, or other description of work to be performed; e.g.
    JOB_STREAM
    Display: Job Stream
    Code Value: 21 A list of jobs or a system that provides lists of jobs; e.g.
    LIST
    Display: List
    Code Value: 7 (deprecated)
    LOCATION
    Display: Location
    Code Value: 2 This is a location identified as related to the event.
    MASTER_FILE
    Display: Master file
    Code Value: 5 This is any configurable file used to control creation of documents.
    PATIENT
    Display: Patient
    Code Value: 1 This object is the patient that is the subject of care related to this event.
    PRACTITIONER
    Display: Practitioner
    Code Value: 15 Any person or organization responsible for providing care.
    QUERY
    Display: Query
    Code Value: 24 The contents of a query.
    REPORT
    Display: Report
    Code Value: 3 This object is any kind of persistent document created as a result of the event.
    ROUTING_CRITERIA
    Display: Routing Criteria
    Code Value: 23 An object that specifies or controls the routing or delivery of items.
    SCHEDULE
    Display: Schedule
    Code Value: 18 An object that holds schedule information.
    SECURITY_GRANULARITY_DEFINITION
    Display: Security Granularity Definition
    Code Value: 14 (deprecated) Relevant to certain RBAC security methodologies.
    SECURITY_RESOURCE
    Display: Security Resource
    Code Value: 13 A passive object, such as a role table, that is relevant to the event.
    SECURITY_USER_ENTITY
    Display: Security User Entity
    Code Value: 11 A person or active system object involved in the event with a security role.
    SECURITY_USER_GROUP
    Display: Security User Group
    Code Value: 12 A person or system object involved in the event with the authority to modify security roles of other objects.
    SUBSCRIBER
    Display: Subscriber
    Code Value: 9 A person or system that is being notified as part of the event.
    TABLE
    Display: Table
    Code Value: 22 (Deprecated)
    USER
    Display: User
    Code Value: 6 A human participant not otherwise identified by some other category.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ca.uhn.fhir.model.api.IValueSetEnumBinder<AuditEventObjectRoleEnum>
    VALUESET_BINDER
    Converts codes to their respective enumerated values
    static final String
    VALUESET_IDENTIFIER
    Identifier for this Value Set:
    static final String
    VALUESET_NAME
    Name for this Value Set: AuditEventObjectRole

  • Method Summary

    Modifier and Type
    Method
    Description
    static AuditEventObjectRoleEnum
    forCode(String theCode)
    Returns the enumerated value associated with this code
    String
    getCode()
    Returns the code associated with this enumerated value
    String
    getSystem()
    Returns the code system associated with this enumerated value
    static AuditEventObjectRoleEnum
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static AuditEventObjectRoleEnum[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PATIENT

      public static final AuditEventObjectRoleEnum PATIENT
      Display: Patient
      Code Value: 1 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.

    • LOCATION

      public static final AuditEventObjectRoleEnum LOCATION
      Display: Location
      Code Value: 2 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.

    • REPORT

      public static final AuditEventObjectRoleEnum REPORT
      Display: Report
      Code Value: 3 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.

    • DOMAIN_RESOURCE

      public static final AuditEventObjectRoleEnum DOMAIN_RESOURCE
      Display: Domain Resource
      Code Value: 4 A logical object related to a health record event. This is any healthcare specific resource (object) not restricted to FHIR defined Resources.

    • MASTER_FILE

      public static final AuditEventObjectRoleEnum MASTER_FILE
      Display: Master file
      Code Value: 5 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.

    • USER

      public static final AuditEventObjectRoleEnum USER
      Display: User
      Code Value: 6 A human participant not otherwise identified by some other category.

    • LIST

      public static final AuditEventObjectRoleEnum LIST
      Display: List
      Code Value: 7 (deprecated)

    • DOCTOR

      public static final AuditEventObjectRoleEnum DOCTOR
      Display: Doctor
      Code Value: 8 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.

    • SUBSCRIBER

      public static final AuditEventObjectRoleEnum SUBSCRIBER
      Display: Subscriber
      Code Value: 9 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.

    • GUARANTOR

      public static final AuditEventObjectRoleEnum GUARANTOR
      Display: Guarantor
      Code Value: 10 Insurance company, or any other organization who accepts responsibility for paying for the healthcare event.

    • SECURITY_USER_ENTITY

      public static final AuditEventObjectRoleEnum SECURITY_USER_ENTITY
      Display: Security User Entity
      Code Value: 11 A person or active system object involved in the event with a security role.

    • SECURITY_USER_GROUP

      public static final AuditEventObjectRoleEnum SECURITY_USER_GROUP
      Display: Security User Group
      Code Value: 12 A person or system object involved in the event with the authority to modify security roles of other objects.

    • SECURITY_RESOURCE

      public static final AuditEventObjectRoleEnum SECURITY_RESOURCE
      Display: Security Resource
      Code Value: 13 A passive object, such as a role table, that is relevant to the event.

    • SECURITY_GRANULARITY_DEFINITION

      public static final AuditEventObjectRoleEnum SECURITY_GRANULARITY_DEFINITION
      Display: Security Granularity Definition
      Code Value: 14 (deprecated) Relevant to certain RBAC security methodologies.

    • PRACTITIONER

      public static final AuditEventObjectRoleEnum PRACTITIONER
      Display: Practitioner
      Code Value: 15 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 practitioners and the doctor that actually provided the care to the patient.

    • DATA_DESTINATION

      public static final AuditEventObjectRoleEnum DATA_DESTINATION
      Display: Data Destination
      Code Value: 16 The source or destination for data transfer, when it does not match some other role.

    • DATA_REPOSITORY

      public static final AuditEventObjectRoleEnum DATA_REPOSITORY
      Display: Data Repository
      Code Value: 17 A source or destination for data transfer that acts as an archive, database, or similar role.

    • SCHEDULE

      public static final AuditEventObjectRoleEnum SCHEDULE
      Display: Schedule
      Code Value: 18 An object that holds schedule information. This could be an appointment book, availability information, etc.

    • CUSTOMER

      public static final AuditEventObjectRoleEnum CUSTOMER
      Display: Customer
      Code Value: 19 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.

    • JOB

      public static final AuditEventObjectRoleEnum JOB
      Display: Job
      Code Value: 20 An order, task, work item, procedure step, or other description of work to be performed; e.g. a particular instance of an MPPS.

    • JOB_STREAM

      public static final AuditEventObjectRoleEnum JOB_STREAM
      Display: Job Stream
      Code Value: 21 A list of jobs or a system that provides lists of jobs; e.g. an MWL SCP.

    • TABLE

      public static final AuditEventObjectRoleEnum TABLE
      Display: Table
      Code Value: 22 (Deprecated)

    • ROUTING_CRITERIA

      public static final AuditEventObjectRoleEnum ROUTING_CRITERIA
      Display: Routing Criteria
      Code Value: 23 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.

    • QUERY

      public static final AuditEventObjectRoleEnum QUERY
      Display: Query
      Code Value: 24 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.

  • Field Details

  • Method Details

    • values

      public static AuditEventObjectRoleEnum[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static AuditEventObjectRoleEnum valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public String getCode()
      Returns the code associated with this enumerated value

    • getSystem

      public String getSystem()
      Returns the code system associated with this enumerated value

    • forCode

      public static AuditEventObjectRoleEnum forCode(String theCode)
      Returns the enumerated value associated with this code