java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.Flag

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Flag
extends DomainResource
```
Prospective warnings of potential issues when providing care to the patient.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Flag.FlagStatus

static class Flag.FlagStatusEnumFactory

Field Summary

Fields
Modifier and Type	Field	Description
`protected Reference`	`author`	The person, organization or device that created the flag.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`AUTHOR`	Fluent Client search parameter constant for author
`protected Resource`	`authorTarget`	The actual object that is the target of the reference (The person, organization or device that created the flag.)
`protected CodeableConcept`	`category`	Allows an flag to be divided into different categories like clinical, administrative etc.
`protected CodeableConcept`	`code`	The coded value or textual component of the flag to display to the user.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`protected Reference`	`encounter`	This alert is only relevant during the encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENCOUNTER`	Fluent Client search parameter constant for encounter
`protected Encounter`	`encounterTarget`	The actual object that is the target of the reference (This alert is only relevant during the encounter.)
`protected List<Identifier>`	`identifier`	Identifier assigned to the flag for external use (outside the FHIR environment).
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_AUTHOR`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENCOUNTER`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT`	Fluent Client search parameter constant for patient
`protected Period`	`period`	The period of time from the activation of the flag to inactivation of the flag.
`static String`	`SP_AUTHOR`	Search parameter: author
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_ENCOUNTER`	Search parameter: encounter
`static String`	`SP_PATIENT`	Search parameter: patient
`static String`	`SP_SUBJECT`	Search parameter: subject
`protected Enumeration<Flag.FlagStatus>`	`status`	Supports basic workflow.
`protected Reference`	`subject`	The patient, location, group , organization , or practitioner this is about record this flag is associated with.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT`	Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget`	The actual object that is the target of the reference (The patient, location, group , organization , or practitioner this is about record this flag is associated with.)

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
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 Description

Flag()
Constructor

Flag(Enumeration<Flag.FlagStatus> status, Reference subject, CodeableConcept code)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Flag`	`addIdentifier(Identifier t)`
`Flag`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Reference`	`getAuthor()`
`Resource`	`getAuthorTarget()`
`CodeableConcept`	`getCategory()`
`CodeableConcept`	`getCode()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Identifier>`	`getIdentifier()`
`Period`	`getPeriod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`Flag.FlagStatus`	`getStatus()`
`Enumeration<Flag.FlagStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`boolean`	`hasAuthor()`
`boolean`	`hasCategory()`
`boolean`	`hasCode()`
`boolean`	`hasEncounter()`
`boolean`	`hasIdentifier()`
`boolean`	`hasPeriod()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`	make an instance of a property.
`Flag`	`setAuthor(Reference value)`
`Flag`	`setAuthorTarget(Resource value)`
`Flag`	`setCategory(CodeableConcept value)`
`Flag`	`setCode(CodeableConcept value)`
`Flag`	`setEncounter(Reference value)`
`Flag`	`setEncounterTarget(Encounter value)`
`Flag`	`setPeriod(Period value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Flag`	`setStatus(Flag.FlagStatus value)`
`Flag`	`setStatusElement(Enumeration<Flag.FlagStatus> value)`
`Flag`	`setSubject(Reference value)`
`Flag`	`setSubjectTarget(Resource value)`
`protected Flag`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifier assigned to the flag for external use (outside the FHIR environment).
  - category
```
protected CodeableConcept category
```
    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.
  - status
```
protected Enumeration<Flag.FlagStatus> status
```
    Supports basic workflow.
  - period
```
protected Period period
```
    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.
  - subject
```
protected Reference subject
```
    The patient, location, group , organization , or practitioner this is about record this flag is associated with.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (The patient, location, group , organization , or practitioner this is about record this flag is associated with.)
  - encounter
```
protected Reference encounter
```
    This alert is only relevant during the encounter.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (This alert is only relevant during the encounter.)
  - author
```
protected Reference author
```
    The person, organization or device that created the flag.
  - authorTarget
```
protected Resource authorTarget
```
    The actual object that is the target of the reference (The person, organization or device that created the flag.)
  - code
```
protected CodeableConcept code
```
    The coded value or textual component of the flag to display to the user.
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter: author
    Description: Flag creator
    Type: reference
    Path: Flag.author
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description: Flag creator
    Type: reference
    Path: Flag.author
  - INCLUDE_AUTHOR
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:author".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The identity of a subject to list flags for
    Type: reference
    Path: Flag.subject
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:patient".
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The identity of a subject to list flags for
    Type: reference
    Path: Flag.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:subject".
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter: encounter
    Description: Alert relevant during encounter
    Type: reference
    Path: Flag.encounter
    
    See Also:
    
    Constant Field Values
  - ENCOUNTER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
```
    Fluent Client search parameter constant for encounter
    Description: Alert relevant during encounter
    Type: reference
    Path: Flag.encounter
  - INCLUDE_ENCOUNTER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Flag:encounter".
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Time period when flag is active
    Type: date
    Path: Flag.period
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Time period when flag is active
    Type: date
    Path: Flag.period
- Constructor Detail
  - Flag
```
public Flag()
```
    Constructor
  - Flag
```
public Flag(Enumeration<Flag.FlagStatus> status,
            Reference subject,
            CodeableConcept code)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifier assigned to the flag for external use (outside the FHIR environment).)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (Identifier assigned to the flag for external use (outside the FHIR environment).)
  - addIdentifier
```
public Flag addIdentifier(Identifier t)
```
  - getCategory
```
public CodeableConcept getCategory()
```
    Returns:
    
    category (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.)
  - hasCategory
```
public boolean hasCategory()
```
  - setCategory
```
public Flag setCategory(CodeableConcept value)
```
    Parameters:
    
    value - category (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 Enumeration<Flag.FlagStatus> getStatusElement()
```
    Returns:
    
    status (Supports basic workflow.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Flag setStatusElement(Enumeration<Flag.FlagStatus> value)
```
    Parameters:
    
    value - status (Supports basic workflow.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Flag.FlagStatus getStatus()
```
    Returns:
    
    Supports basic workflow.
  - setStatus
```
public Flag setStatus(Flag.FlagStatus value)
```
    Parameters:
    
    value - Supports basic workflow.
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (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.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public Flag setPeriod(Period value)
```
    Parameters:
    
    value - period (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 Reference getSubject()
```
    Returns:
    
    subject (The patient, location, group , organization , or practitioner this is about record this flag is associated with.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Flag setSubject(Reference value)
```
    Parameters:
    
    value - subject (The patient, location, group , organization , or practitioner this is about record this flag is associated with.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient, location, group , organization , or practitioner this is about record this flag is associated with.)
  - setSubjectTarget
```
public Flag setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient, location, group , organization , or practitioner this is about record this flag is associated with.)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (This alert is only relevant during the encounter.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public Flag setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (This alert is only relevant during the encounter.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (This alert is only relevant during the encounter.)
  - setEncounterTarget
```
public Flag setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (This alert is only relevant during the encounter.)
  - getAuthor
```
public Reference getAuthor()
```
    Returns:
    
    author (The person, organization or device that created the flag.)
  - hasAuthor
```
public boolean hasAuthor()
```
  - setAuthor
```
public Flag setAuthor(Reference value)
```
    Parameters:
    
    value - author (The person, organization or device that created the flag.)
  - getAuthorTarget
```
public Resource getAuthorTarget()
```
    Returns:
    
    author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person, organization or device that created the flag.)
  - setAuthorTarget
```
public Flag setAuthorTarget(Resource value)
```
    Parameters:
    
    value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person, organization or device that created the flag.)
  - getCode
```
public CodeableConcept getCode()
```
    Returns:
    
    code (The coded value or textual component of the flag to display to the user.)
  - hasCode
```
public boolean hasCode()
```
  - setCode
```
public Flag setCode(CodeableConcept value)
```
    Parameters:
    
    value - code (The coded value or textual component of the flag to display to the user.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Description copied from class: Base
    
    make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
    
    Overrides:
    
    makeProperty in class DomainResource
    
    Returns:
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Flag copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Flag typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Modifier and Type	Class	Description
`static class`	`Flag.FlagStatus`
`static class`	`Flag.FlagStatusEnumFactory`

Constructor	Description
`Flag()`	Constructor
`Flag(Enumeration<Flag.FlagStatus> status, Reference subject, CodeableConcept code)`	Constructor

Class Flag

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

category

status

period

subject

subjectTarget

encounter

encounterTarget

author

authorTarget

code

SP_AUTHOR

AUTHOR

INCLUDE_AUTHOR

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_DATE

DATE

Constructor Detail

Flag

Flag

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getCategory

hasCategory

setCategory

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getPeriod

hasPeriod

setPeriod

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getEncounter

hasEncounter

setEncounter

getEncounterTarget

setEncounterTarget

getAuthor

hasAuthor

setAuthor

getAuthorTarget

setAuthorTarget

getCode

hasCode