ca.uhn.fhir.model.dstu2.resource

Class Flag

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.dstu2.resource.BaseResource

ca.uhn.fhir.model.dstu2.resource.Flag

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource

public class Flag
extends BaseResource
implements IResource

HAPI/FHIR Flag Resource (workflow.encounter)

Definition: Prospective warnings of potential issues when providing care to the patient.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Flag

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ReferenceClientParam	AUTHOR Fluent Client search parameter constant for author
static DateClientParam	DATE Fluent Client search parameter constant for date
static ReferenceClientParam	ENCOUNTER Fluent Client search parameter constant for encounter
static Include	INCLUDE_AUTHOR Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_ENCOUNTER Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static String	SP_AUTHOR Search parameter constant for author
static String	SP_DATE Search parameter constant for date
static String	SP_ENCOUNTER Search parameter constant for encounter
static String	SP_PATIENT Search parameter constant for patient
static String	SP_SUBJECT Search parameter constant for subject
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
Flag()

Method Summary

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (id)
Flag	addIdentifier(IdentifierDt theValue) Adds a given new value for identifier (id)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
ResourceReferenceDt	getAuthor() Gets the value(s) for author (who.author).
BoundCodeableConceptDt<FlagCategoryCodesEnum>	getCategory() Gets the value(s) for category (class).
CodeableConceptDt	getCode() Gets the value(s) for code (what).
ResourceReferenceDt	getEncounter() Gets the value(s) for encounter (context).
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (id).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (id), creating it if it does not already exist.
PeriodDt	getPeriod() Gets the value(s) for period (context).
String	getResourceName()
String	getStatus() Gets the value(s) for status (status).
BoundCodeDt<FlagStatusEnum>	getStatusElement() Gets the value(s) for status (status).
FhirVersionEnum	getStructureFhirVersionEnum()
ResourceReferenceDt	getSubject() Gets the value(s) for subject (who.focus).
boolean	isEmpty()
Flag	setAuthor(ResourceReferenceDt theValue) Sets the value(s) for author (who.author)
Flag	setCategory(BoundCodeableConceptDt<FlagCategoryCodesEnum> theValue) Sets the value(s) for category (class)
Flag	setCategory(FlagCategoryCodesEnum theValue) Sets the value(s) for category (class)
Flag	setCode(CodeableConceptDt theValue) Sets the value(s) for code (what)
Flag	setEncounter(ResourceReferenceDt theValue) Sets the value(s) for encounter (context)
Flag	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (id)
Flag	setPeriod(PeriodDt theValue) Sets the value(s) for period (context)
Flag	setStatus(BoundCodeDt<FlagStatusEnum> theValue) Sets the value(s) for status (status)
Flag	setStatus(FlagStatusEnum theValue) Sets the value(s) for status (status)
Flag	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (who.focus)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getIdElement, setId, setId

Field Detail

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter constant for subject

Description: The identity of a subject to list flags for
Type: reference
Path: Flag.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The identity of a subject to list flags for
Type: reference
Path: Flag.subject

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description: The identity of a subject to list flags for
Type: reference
Path: Flag.subject

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The identity of a subject to list flags for
Type: reference
Path: Flag.subject

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter constant for author

Description:
Type: reference
Path: Flag.author

See Also:

Constant Field Values

AUTHOR

public static final ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description:
Type: reference
Path: Flag.author

SP_DATE

public static final String SP_DATE

Search parameter constant for date

Description:
Type: date
Path: Flag.period

See Also:

Constant Field Values

DATE

public static final DateClientParam DATE

Fluent Client search parameter constant for date

Description:
Type: date
Path: Flag.period

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter constant for encounter

Description:
Type: reference
Path: Flag.encounter

See Also:

Constant Field Values

ENCOUNTER

public static final ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description:
Type: reference
Path: Flag.encounter

INCLUDE_AUTHOR

public static final Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:author".

INCLUDE_ENCOUNTER

public static final Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:encounter".

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:patient".

INCLUDE_SUBJECT

public static final Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:subject".

Constructor Detail

Flag

public Flag()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

Definition: Identifier assigned to the flag for external use (outside the FHIR environment)

setIdentifier

public Flag setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (id)

Definition: Identifier assigned to the flag for external use (outside the FHIR environment)

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (id)

Definition: Identifier assigned to the flag for external use (outside the FHIR environment)

addIdentifier

public Flag addIdentifier(IdentifierDt theValue)

Adds a given new value for identifier (id)

Definition: Identifier assigned to the flag for external use (outside the FHIR environment)

Parameters:

theValue - The identifier to add (must not be null)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (id), creating it if it does not already exist.

Definition: Identifier assigned to the flag for external use (outside the FHIR environment)

getCategory

public BoundCodeableConceptDt<FlagCategoryCodesEnum> getCategory()

Gets the value(s) for category (class). creating it if it does not exist. Will not return null.

Definition: Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

setCategory

public Flag setCategory(BoundCodeableConceptDt<FlagCategoryCodesEnum> theValue)

Sets the value(s) for category (class)

Definition: Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

setCategory

public Flag setCategory(FlagCategoryCodesEnum theValue)

Sets the value(s) for category (class)

Definition: Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

getStatusElement

public BoundCodeDt<FlagStatusEnum> getStatusElement()

Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

Definition: Supports basic workflow

getStatus

public String getStatus()

Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

Definition: Supports basic workflow

setStatus

public Flag setStatus(BoundCodeDt<FlagStatusEnum> theValue)

Sets the value(s) for status (status)

Definition: Supports basic workflow

setStatus

public Flag setStatus(FlagStatusEnum theValue)

Sets the value(s) for status (status)

Definition: Supports basic workflow

getPeriod

public PeriodDt getPeriod()

Gets the value(s) for period (context). creating it if it does not exist. Will not return null.

Definition: The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

setPeriod

public Flag setPeriod(PeriodDt theValue)

Sets the value(s) for period (context)

Definition: The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

Definition: The patient, location, group , organization , or practitioner this is about record this flag is associated with

setSubject

public Flag setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject (who.focus)

Definition: The patient, location, group , organization , or practitioner this is about record this flag is associated with

getEncounter

public ResourceReferenceDt getEncounter()

Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

Definition: This alert is only relevant during the encounter

setEncounter

public Flag setEncounter(ResourceReferenceDt theValue)

Sets the value(s) for encounter (context)

Definition: This alert is only relevant during the encounter

getAuthor

public ResourceReferenceDt getAuthor()

Gets the value(s) for author (who.author). creating it if it does not exist. Will not return null.

Definition: The person, organization or device that created the flag

setAuthor

public Flag setAuthor(ResourceReferenceDt theValue)

Sets the value(s) for author (who.author)

Definition: The person, organization or device that created the flag

getCode

public CodeableConceptDt getCode()

Gets the value(s) for code (what). creating it if it does not exist. Will not return null.

Definition: The coded value or textual component of the flag to display to the user

setCode

public Flag setCode(CodeableConceptDt theValue)

Sets the value(s) for code (what)

Definition: The coded value or textual component of the flag to display to the user

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface IResource

getStructureFhirVersionEnum

public FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface IResource

Specified by:

getStructureFhirVersionEnum in interface IBaseResource