org.hl7.fhir.r4.model.codesystems

Enum ResourceSecurityCategory

java.lang.Object

java.lang.Enum<ResourceSecurityCategory>

org.hl7.fhir.r4.model.codesystems.ResourceSecurityCategory

All Implemented Interfaces:

Serializable, Comparable<ResourceSecurityCategory>

public enum ResourceSecurityCategory
extends Enum<ResourceSecurityCategory>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANONYMOUS These resources tend to not contain any individual data, or business sensitive data.
BUSINESS These Resources tend to not contain any individual data, but do have data that describe business or service sensitive data.
INDIVIDUAL These Resources do NOT contain Patient data, but do contain individual information about other participants.
NOTCLASSIFIED Some Resources can be used for a wide scope of use-cases that span very sensitive to very non-sensitive.
NULL added to help the parsers
PATIENT These Resources make up the bulk of FHIR and therefore are the most commonly understood.

Method Summary

Modifier and Type	Method and Description
static ResourceSecurityCategory	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static ResourceSecurityCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResourceSecurityCategory[]	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

ANONYMOUS

public static final ResourceSecurityCategory ANONYMOUS

These resources tend to not contain any individual data, or business sensitive data. Most often these Resources will be available for anonymous access, meaning there is no access control based on the user or system requesting. However these Resources do tend to contain important information that must be authenticated back to the source publishing them, and protected from integrity failures in communication. For this reason server authenticated https (TLS) is recommended to provide authentication of the server and integrity protection in transit. This is normal web-server use of https.

BUSINESS

public static final ResourceSecurityCategory BUSINESS

These Resources tend to not contain any individual data, but do have data that describe business or service sensitive data. The use of the term Business is not intended to only mean an incorporated business, but rather the more broad concept of an organization, location, or other group that is not identifable as individuals. Often these resources will require some for of client authentication to assure that only authorized access is given. The client access control may be to individuals, or may be to system identity. For this purpose possible client authentication methods such as: mutual-authenticated-TLS, APIKey, App signed JWT, or App OAuth client-id JWT For example: a App that uses a Business protected Provider Directory to determine other business endpoint details.

INDIVIDUAL

public static final ResourceSecurityCategory INDIVIDUAL

These Resources do NOT contain Patient data, but do contain individual information about other participants. These other individuals are Practitioners, PractionerRole, CareTeam, or other users. These identities are needed to enable the practice of healthcare. These identities are identities under general privacy regulations, and thus must consider Privacy risk. Often access to these other identities are covered by business relationships. For this purpose access to these Resources will tend to be Role specific using methods such as RBAC or ABAC.

PATIENT

public static final ResourceSecurityCategory PATIENT

These Resources make up the bulk of FHIR and therefore are the most commonly understood. These Resources contain highly sesitive health information, or are closely linked to highly sensitive health information. These Resources will often use the security labels to differentiate various confidentiality levels within this broad group of Patient Sensitive data. Access to these Resources often requires a declared Purpose Of Use. Access to these Resources is often controlled by a Privacy Consent.

NOTCLASSIFIED

public static final ResourceSecurityCategory NOTCLASSIFIED

Some Resources can be used for a wide scope of use-cases that span very sensitive to very non-sensitive. These Resources do not fall into any of the above classifications, as their sensitivity is highly variable. These Resources will need special handling. These Resources often contain metadata that describes the content in a way that can be used for Access Control decisions.

NULL

public static final ResourceSecurityCategory NULL

added to help the parsers

Method Detail

values

public static ResourceSecurityCategory[] 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 (ResourceSecurityCategory c : ResourceSecurityCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResourceSecurityCategory 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 ResourceSecurityCategory 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()