Class Questionnaire.GroupQuestion

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    Questionnaire

    public static class Questionnaire.GroupQuestion
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: Questionnaire.group.question ()

    Definition: Set of questions within this group. The order of questions within the group is relevant

    See Also:
    Serialized Form
    • Method Detail

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

        public ca.uhn.fhir.model.primitive.StringDt getLinkIdElement()
        Gets the value(s) for linkId (). creating it if it does not exist. Will not return null.

        Definition: An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource.

      • getLinkId

        public String getLinkId()
        Gets the value(s) for linkId (). creating it if it does not exist. This method may return null.

        Definition: An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource.

      • setLinkId

        public Questionnaire.GroupQuestion setLinkId​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for linkId ()

        Definition: An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource.

      • setLinkId

        public Questionnaire.GroupQuestion setLinkId​(String theString)
        Sets the value for linkId ()

        Definition: An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource.

      • getConcept

        public List<CodingDtgetConcept()
        Gets the value(s) for concept (). creating it if it does not exist. Will not return null.

        Definition: Identifies a how this question is known in a particular terminology such as LOINC.

      • addConcept

        public CodingDt addConcept()
        Adds and returns a new value for concept ()

        Definition: Identifies a how this question is known in a particular terminology such as LOINC.

      • addConcept

        public Questionnaire.GroupQuestion addConcept​(CodingDt theValue)
        Adds a given new value for concept ()

        Definition: Identifies a how this question is known in a particular terminology such as LOINC.

        Parameters:
        theValue - The concept to add (must not be null)
      • getConceptFirstRep

        public CodingDt getConceptFirstRep()
        Gets the first repetition for concept (), creating it if it does not already exist.

        Definition: Identifies a how this question is known in a particular terminology such as LOINC.

      • getTextElement

        public ca.uhn.fhir.model.primitive.StringDt getTextElement()
        Gets the value(s) for text (). creating it if it does not exist. Will not return null.

        Definition: The actual question as shown to the user to prompt them for an answer.

      • getText

        public String getText()
        Gets the value(s) for text (). creating it if it does not exist. This method may return null.

        Definition: The actual question as shown to the user to prompt them for an answer.

      • setText

        public Questionnaire.GroupQuestion setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for text ()

        Definition: The actual question as shown to the user to prompt them for an answer.

      • getTypeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AnswerFormatEnumgetTypeElement()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected

      • getType

        public String getType()
        Gets the value(s) for type (). creating it if it does not exist. This method may return null.

        Definition: The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected

      • setType

        public Questionnaire.GroupQuestion setType​(ca.uhn.fhir.model.primitive.BoundCodeDt<AnswerFormatEnum> theValue)
        Sets the value(s) for type ()

        Definition: The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected

      • getRequiredElement

        public ca.uhn.fhir.model.primitive.BooleanDt getRequiredElement()
        Gets the value(s) for required (). creating it if it does not exist. Will not return null.

        Definition: If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.

      • getRequired

        public Boolean getRequired()
        Gets the value(s) for required (). creating it if it does not exist. This method may return null.

        Definition: If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.

      • setRequired

        public Questionnaire.GroupQuestion setRequired​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for required ()

        Definition: If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.

      • setRequired

        public Questionnaire.GroupQuestion setRequired​(boolean theBoolean)
        Sets the value for required ()

        Definition: If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.

      • getRepeatsElement

        public ca.uhn.fhir.model.primitive.BooleanDt getRepeatsElement()
        Gets the value(s) for repeats (). creating it if it does not exist. Will not return null.

        Definition: If true, the question may have more than one answer.

      • getRepeats

        public Boolean getRepeats()
        Gets the value(s) for repeats (). creating it if it does not exist. This method may return null.

        Definition: If true, the question may have more than one answer.

      • setRepeats

        public Questionnaire.GroupQuestion setRepeats​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for repeats ()

        Definition: If true, the question may have more than one answer.

      • getOptions

        public ResourceReferenceDt getOptions()
        Gets the value(s) for options (). creating it if it does not exist. Will not return null.

        Definition: Reference to a value set containing a list of codes representing permitted answers for the question

      • getOption

        public List<CodingDtgetOption()
        Gets the value(s) for option (). creating it if it does not exist. Will not return null.

        Definition: For a \"choice\" question, identifies one of the permitted answers for the question.

      • addOption

        public CodingDt addOption()
        Adds and returns a new value for option ()

        Definition: For a \"choice\" question, identifies one of the permitted answers for the question.

      • addOption

        public Questionnaire.GroupQuestion addOption​(CodingDt theValue)
        Adds a given new value for option ()

        Definition: For a \"choice\" question, identifies one of the permitted answers for the question.

        Parameters:
        theValue - The option to add (must not be null)
      • getOptionFirstRep

        public CodingDt getOptionFirstRep()
        Gets the first repetition for option (), creating it if it does not already exist.

        Definition: For a \"choice\" question, identifies one of the permitted answers for the question.

      • getGroup

        public List<Questionnaire.GroupgetGroup()
        Gets the value(s) for group (). creating it if it does not exist. Will not return null.

        Definition: Nested group, containing nested question for this question. The order of groups within the question is relevant

      • addGroup

        public Questionnaire.Group addGroup()
        Adds and returns a new value for group ()

        Definition: Nested group, containing nested question for this question. The order of groups within the question is relevant

      • addGroup

        public Questionnaire.GroupQuestion addGroup​(Questionnaire.Group theValue)
        Adds a given new value for group ()

        Definition: Nested group, containing nested question for this question. The order of groups within the question is relevant

        Parameters:
        theValue - The group to add (must not be null)
      • getGroupFirstRep

        public Questionnaire.Group getGroupFirstRep()
        Gets the first repetition for group (), creating it if it does not already exist.

        Definition: Nested group, containing nested question for this question. The order of groups within the question is relevant