org.hl7.fhir.dstu3.model

Class Flag

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.Flag

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, 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 and Description
static class	Flag.FlagStatus
static class	Flag.FlagStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected Reference	author The person, organization or device that created the flag.
static 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 DateClientParam	DATE Fluent Client search parameter constant for date
protected Reference	encounter This alert is only relevant during the encounter.
static 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 TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
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
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_IDENTIFIER Search parameter: identifier
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, etc.
static 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, etc.

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

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.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 and Description
Flag() Constructor
Flag(Enumeration<Flag.FlagStatus> status, CodeableConcept code, Reference subject) Constructor

Method Summary

Modifier and Type	Method and 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()
Identifier	getIdentifierFirstRep()
Period	getPeriod()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Flag.FlagStatus	getStatus()
Enumeration<Flag.FlagStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
String[]	getTypesForProperty(int hash, String name)
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)
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	setIdentifier(List<Identifier> theIdentifier)
Flag	setPeriod(Period value)
Base	setProperty(int hash, String name, Base value)
Base	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.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, 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.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

identifier

protected List<Identifier> identifier

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

status

protected Enumeration<Flag.FlagStatus> status

Supports basic workflow.

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.

code

protected CodeableConcept code

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

subject

protected Reference subject

The patient, location, group , organization , or practitioner, etc. 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, etc. this is about record this flag is associated with.)

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.

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.)

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 DateClientParam DATE

Fluent Client search parameter constant for date

Description: Time period when flag is active
Type: date
Path: Flag.period

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Business identifier
Type: token
Path: Flag.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Business identifier
Type: token
Path: Flag.identifier

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 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 Include INCLUDE_SUBJECT

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

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 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 Include INCLUDE_PATIENT

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

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 ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description: Flag creator
Type: reference
Path: Flag.author

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".

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 ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Alert relevant during encounter
Type: reference
Path: Flag.encounter

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".

Constructor Detail

Flag

public Flag()

Constructor

Flag

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

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifier assigned to the flag for external use (outside the FHIR environment).)

setIdentifier

public Flag setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Flag addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

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.

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.)

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.)

getSubject

public Reference getSubject()

Returns:

subject (The patient, location, group , organization , or practitioner, etc. 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, etc. 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, etc. 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, etc. this is about record this flag is associated with.)

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.)

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.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException

Overrides:

getProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

FHIRException

addChild

public Base addChild(String name)
              throws FHIRException

Overrides:

addChild in class DomainResource

Throws:

FHIRException

fhirType

public String fhirType()

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 IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource