ObjectRole (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- java.lang.Enum<ObjectRole>
- - org.hl7.fhir.r4.model.codesystems.ObjectRole

All Implemented Interfaces:

Serializable, Comparable<ObjectRole>
```
public enum ObjectRole
extends Enum<ObjectRole>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`_1` This object is the patient that is the subject of care related to this event.
`_10` Insurance company, or any other organization who accepts responsibility for paying for the healthcare event.
`_11` A person or active system object involved in the event with a security role.
`_12` A person or system object involved in the event with the authority to modify security roles of other objects.
`_13` A passive object, such as a role table, that is relevant to the event.
`_14` (deprecated) Relevant to certain RBAC security methodologies.
`_15` Any person or organization responsible for providing care.
`_16` The source or destination for data transfer, when it does not match some other role.
`_17` A source or destination for data transfer that acts as an archive, database, or similar role.
`_18` An object that holds schedule information.
`_19` An organization or person that is the recipient of services.
`_2` This is a location identified as related to the event.
`_20` An order, task, work item, procedure step, or other description of work to be performed; e.g.
`_21` A list of jobs or a system that provides lists of jobs; e.g.
`_22` (Deprecated).
`_23` An object that specifies or controls the routing or delivery of items.
`_24` The contents of a query.
`_3` This object is any kind of persistent document created as a result of the event.
`_4` A logical object related to a health record event.
`_5` This is any configurable file used to control creation of documents.
`_6` A human participant not otherwise identified by some other category.
`_7` (deprecated).
`_8` Typically, a licensed person who is providing or performing care related to the event, generally a physician.
`_9` A person or system that is being notified as part of the event.
`NULL` added to help the parsers

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ObjectRole`	`fromCode(String codeString)`
`String`	`getDefinition()`
`String`	`getDisplay()`
`String`	`getSystem()`
`String`	`toCode()`
`static ObjectRole`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ObjectRole[]`	`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 Detail
  - _1
```
public static final ObjectRole _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.
  - _2
```
public static final ObjectRole _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.
  - _3
```
public static final ObjectRole _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.
  - _4
```
public static final ObjectRole _4
```
    A logical object related to a health record event. This is any healthcare specific resource (object) not restricted to FHIR defined Resources.
  - _5
```
public static final ObjectRole _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.
  - _6
```
public static final ObjectRole _6
```
    A human participant not otherwise identified by some other category.
  - _7
```
public static final ObjectRole _7
```
    (deprecated).
  - _8
```
public static final ObjectRole _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.
  - _9
```
public static final ObjectRole _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.
  - _10
```
public static final ObjectRole _10
```
    Insurance company, or any other organization who accepts responsibility for paying for the healthcare event.
  - _11
```
public static final ObjectRole _11
```
    A person or active system object involved in the event with a security role.
  - _12
```
public static final ObjectRole _12
```
    A person or system object involved in the event with the authority to modify security roles of other objects.
  - _13
```
public static final ObjectRole _13
```
    A passive object, such as a role table, that is relevant to the event.
  - _14
```
public static final ObjectRole _14
```
    (deprecated) Relevant to certain RBAC security methodologies.
  - _15
```
public static final ObjectRole _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 practitioner and the doctor that actually provided the care to the patient.
  - _16
```
public static final ObjectRole _16
```
    The source or destination for data transfer, when it does not match some other role.
  - _17
```
public static final ObjectRole _17
```
    A source or destination for data transfer that acts as an archive, database, or similar role.
  - _18
```
public static final ObjectRole _18
```
    An object that holds schedule information. This could be an appointment book, availability information, etc.
  - _19
```
public static final ObjectRole _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.
  - _20
```
public static final ObjectRole _20
```
    An order, task, work item, procedure step, or other description of work to be performed; e.g. a particular instance of an MPPS.
  - _21
```
public static final ObjectRole _21
```
    A list of jobs or a system that provides lists of jobs; e.g. an MWL SCP.
  - _22
```
public static final ObjectRole _22
```
    (Deprecated).
  - _23
```
public static final ObjectRole _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.
  - _24
```
public static final ObjectRole _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.
  - NULL
```
public static final ObjectRole NULL
```
    added to help the parsers
- Method Detail
  - values
```
public static ObjectRole[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ObjectRole c : ObjectRole.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ObjectRole 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
  - fromCode
```
public static ObjectRole fromCode(String codeString)
                           throws org.hl7.fhir.exceptions.FHIRException
```
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - toCode
```
public String toCode()
```
  - getSystem
```
public String getSystem()
```
  - getDefinition
```
public String getDefinition()
```
  - getDisplay
```
public String getDisplay()
```

Enum ObjectRole

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

_1

_2

_3

_4

_5

_6

_7

_8

_9

_10

_11

_12

_13

_14

_15

_16

_17

_18

_19

_20

_21

_22

_23

_24

NULL

Method Detail

values

valueOf

fromCode

toCode

getSystem

getDefinition

getDisplay