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:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Flag
extends BaseResource
implements ca.uhn.fhir.model.api.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 Details

    • 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 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

    • 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 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

    • 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
      Fluent Client search parameter constant for encounter

      Description:
      Type: reference
      Path: Flag.encounter

    • 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".
    • 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".
    • 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".
    • 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".
  • Constructor Details

    • Flag

      public Flag()
  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • 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

      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

      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

      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​(CodeableConceptDt 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 ca.uhn.fhir.model.primitive.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. This method may return null.

      Definition: Supports basic workflow

    • setStatus

      public Flag setStatus​(ca.uhn.fhir.model.primitive.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

      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

      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

      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

      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

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource