Questionnaire (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Questionnaire

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Questionnaire
extends BaseResource
implements IResource
```
HAPI/FHIR Questionnaire Resource (A structured set of questions and their answers)
Definition: A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions

Requirements: To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Questionnaire.Group` Block class for child element: Questionnaire.group (Grouped questions)
`static class`	`Questionnaire.GroupQuestion` Block class for child element: Questionnaire.group.question (Questions in this group)

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`AUTHOR` Fluent Client search parameter constant for author
`static DateClientParam`	`AUTHORED` Fluent Client search parameter constant for authored
`static ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`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_SUBJECT` Constant for fluent queries to be used to add include statements.
`static TokenClientParam`	`NAME` Fluent Client search parameter constant for name
`static String`	`SP_AUTHOR` Search parameter constant for author
`static String`	`SP_AUTHORED` Search parameter constant for authored
`static String`	`SP_ENCOUNTER` Search parameter constant for encounter
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Questionnaire()

Constructors
Constructor and Description
`Questionnaire()`

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External Ids for this questionnaire)
`Questionnaire`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External Ids for this questionnaire)
`Questionnaire`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External Ids for this questionnaire)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`ResourceReferenceDt`	`getAuthor()` Gets the value(s) for author (Person who received and recorded the answers).
`DateTimeDt`	`getAuthored()` Gets the value(s) for authored (Date this version was authored).
`ResourceReferenceDt`	`getEncounter()` Gets the value(s) for encounter (Primary encounter during which the answers were collected).
`Questionnaire.Group`	`getGroup()` Gets the value(s) for group (Grouped questions).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (External Ids for this questionnaire).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (External Ids for this questionnaire), creating it if it does not already exist.
`BoundCodeableConceptDt<QuestionnaireNameEnum>`	`getName()` Gets the value(s) for name (Name/code for a predefined list of questions).
`ResourceReferenceDt`	`getSource()` Gets the value(s) for source (The person who answered the questions).
`BoundCodeDt<QuestionnaireStatusEnum>`	`getStatus()` Gets the value(s) for status (draft \| published \| retired \| in progress \| completed \| amended).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (The subject of the questions).
`boolean`	`isEmpty()`
`Questionnaire`	`setAuthor(ResourceReferenceDt theValue)` Sets the value(s) for author (Person who received and recorded the answers)
`Questionnaire`	`setAuthored(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for authored (Date this version was authored)
`Questionnaire`	`setAuthored(DateTimeDt theValue)` Sets the value(s) for authored (Date this version was authored)
`Questionnaire`	`setAuthoredWithSecondsPrecision(Date theDate)` Sets the value for authored (Date this version was authored)
`Questionnaire`	`setEncounter(ResourceReferenceDt theValue)` Sets the value(s) for encounter (Primary encounter during which the answers were collected)
`Questionnaire`	`setGroup(Questionnaire.Group theValue)` Sets the value(s) for group (Grouped questions)
`Questionnaire`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External Ids for this questionnaire)
`Questionnaire`	`setName(BoundCodeableConceptDt<QuestionnaireNameEnum> theValue)` Sets the value(s) for name (Name/code for a predefined list of questions)
`Questionnaire`	`setName(QuestionnaireNameEnum theValue)` Sets the value(s) for name (Name/code for a predefined list of questions)
`Questionnaire`	`setSource(ResourceReferenceDt theValue)` Sets the value(s) for source (The person who answered the questions)
`Questionnaire`	`setStatus(BoundCodeDt<QuestionnaireStatusEnum> theValue)` Sets the value(s) for status (draft \| published \| retired \| in progress \| completed \| amended)
`Questionnaire`	`setStatus(QuestionnaireStatusEnum theValue)` Sets the value(s) for status (draft \| published \| retired \| in progress \| completed \| amended)
`Questionnaire`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (The subject of the questions)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- Field Detail
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description: The status of the questionnaire
    Type: token
    Path: Questionnaire.status
    
    See Also:
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The status of the questionnaire
    Type: token
    Path: Questionnaire.status
  - SP_AUTHORED
```
public static final String SP_AUTHORED
```
    Search parameter constant for authored
    Description: When the questionnaire was authored
    Type: date
    Path: Questionnaire.authored
    
    See Also:
    Constant Field Values
  - AUTHORED
```
public static final DateClientParam AUTHORED
```
    Fluent Client search parameter constant for authored
    Description: When the questionnaire was authored
    Type: date
    Path: Questionnaire.authored
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The subject of the questionnaire
    Type: reference
    Path: Questionnaire.subject
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject of the questionnaire
    Type: reference
    Path: Questionnaire.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 "Questionnaire.subject".
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description: The author of the questionnaire
    Type: reference
    Path: Questionnaire.author
    
    See Also:
    Constant Field Values
  - AUTHOR
```
public static final ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description: The author of the questionnaire
    Type: reference
    Path: Questionnaire.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 "Questionnaire.author".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: An identifier for the questionnaire
    Type: token
    Path: Questionnaire.identifier
    
    See Also:
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: An identifier for the questionnaire
    Type: token
    Path: Questionnaire.identifier
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description: Name of the questionnaire
    Type: token
    Path: Questionnaire.name
    
    See Also:
    Constant Field Values
  - NAME
```
public static final TokenClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: Name of the questionnaire
    Type: token
    Path: Questionnaire.name
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter constant for encounter
    Description: Encounter during which questionnaire was authored
    Type: reference
    Path: Questionnaire.encounter
    
    See Also:
    Constant Field Values
  - ENCOUNTER
```
public static final ReferenceClientParam ENCOUNTER
```
    Fluent Client search parameter constant for encounter
    Description: Encounter during which questionnaire was authored
    Type: reference
    Path: Questionnaire.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 "Questionnaire.encounter".
- Constructor Detail
  - Questionnaire
```
public Questionnaire()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getStatus
```
public BoundCodeDt<QuestionnaireStatusEnum> getStatus()
```
    Gets the value(s) for status (draft | published | retired | in progress | completed | amended). creating it if it does not exist. Will not return null.
    Definition: The lifecycle status of the questionnaire as a whole.
  - setStatus
```
public Questionnaire setStatus(BoundCodeDt<QuestionnaireStatusEnum> theValue)
```
    Sets the value(s) for status (draft | published | retired | in progress | completed | amended)
    Definition: The lifecycle status of the questionnaire as a whole.
  - setStatus
```
public Questionnaire setStatus(QuestionnaireStatusEnum theValue)
```
    Sets the value(s) for status (draft | published | retired | in progress | completed | amended)
    Definition: The lifecycle status of the questionnaire as a whole.
  - getAuthored
```
public DateTimeDt getAuthored()
```
    Gets the value(s) for authored (Date this version was authored). creating it if it does not exist. Will not return null.
    Definition: The date and/or time that this version of the questionnaire was authored
  - setAuthored
```
public Questionnaire setAuthored(DateTimeDt theValue)
```
    Sets the value(s) for authored (Date this version was authored)
    Definition: The date and/or time that this version of the questionnaire was authored
  - setAuthoredWithSecondsPrecision
```
public Questionnaire setAuthoredWithSecondsPrecision(Date theDate)
```
    Sets the value for authored (Date this version was authored)
    Definition: The date and/or time that this version of the questionnaire was authored
  - setAuthored
```
public Questionnaire setAuthored(Date theDate,
                        TemporalPrecisionEnum thePrecision)
```
    Sets the value for authored (Date this version was authored)
    Definition: The date and/or time that this version of the questionnaire was authored
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (The subject of the questions). creating it if it does not exist. Will not return null.
    Definition: The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information
  - setSubject
```
public Questionnaire setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (The subject of the questions)
    Definition: The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information
  - getAuthor
```
public ResourceReferenceDt getAuthor()
```
    Gets the value(s) for author (Person who received and recorded the answers). creating it if it does not exist. Will not return null.
    Definition: Person who received the answers to the questions in the Questionnaire and recorded them in the system
  - setAuthor
```
public Questionnaire setAuthor(ResourceReferenceDt theValue)
```
    Sets the value(s) for author (Person who received and recorded the answers)
    Definition: Person who received the answers to the questions in the Questionnaire and recorded them in the system
  - getSource
```
public ResourceReferenceDt getSource()
```
    Gets the value(s) for source (The person who answered the questions). creating it if it does not exist. Will not return null.
    Definition: The person who answered the questions about the subject. Only used when this is not the subject him/herself
  - setSource
```
public Questionnaire setSource(ResourceReferenceDt theValue)
```
    Sets the value(s) for source (The person who answered the questions)
    Definition: The person who answered the questions about the subject. Only used when this is not the subject him/herself
  - getName
```
public BoundCodeableConceptDt<QuestionnaireNameEnum> getName()
```
    Gets the value(s) for name (Name/code for a predefined list of questions). creating it if it does not exist. Will not return null.
    Definition: Structured name for a predefined list of questions this questionnaire is responding to
  - setName
```
public Questionnaire setName(BoundCodeableConceptDt<QuestionnaireNameEnum> theValue)
```
    Sets the value(s) for name (Name/code for a predefined list of questions)
    Definition: Structured name for a predefined list of questions this questionnaire is responding to
  - setName
```
public Questionnaire setName(QuestionnaireNameEnum theValue)
```
    Sets the value(s) for name (Name/code for a predefined list of questions)
    Definition: Structured name for a predefined list of questions this questionnaire is responding to
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (External Ids for this questionnaire). creating it if it does not exist. Will not return null.
    Definition: This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - setIdentifier
```
public Questionnaire setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (External Ids for this questionnaire)
    Definition: This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (External Ids for this questionnaire)
    Definition: This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (External Ids for this questionnaire), creating it if it does not already exist.
    Definition: This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - addIdentifier
```
public Questionnaire addIdentifier(IdentifierUseEnum theUse,
                          String theSystem,
                          String theValue,
                          String theLabel)
```
    Adds a new value for identifier (External Ids for this questionnaire)
    Definition: This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Questionnaire addIdentifier(String theSystem,
                          String theValue)
```
    Adds a new value for identifier (External Ids for this questionnaire)
    Definition: This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getEncounter
```
public ResourceReferenceDt getEncounter()
```
    Gets the value(s) for encounter (Primary encounter during which the answers were collected). creating it if it does not exist. Will not return null.
    Definition: Encounter during which this questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.
  - setEncounter
```
public Questionnaire setEncounter(ResourceReferenceDt theValue)
```
    Sets the value(s) for encounter (Primary encounter during which the answers were collected)
    Definition: Encounter during which this questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.
  - getGroup
```
public Questionnaire.Group getGroup()
```
    Gets the value(s) for group (Grouped questions). creating it if it does not exist. Will not return null.
    Definition: A group of questions to a possibly similarly grouped set of questions in the questionnaire
  - setGroup
```
public Questionnaire setGroup(Questionnaire.Group theValue)
```
    Sets the value(s) for group (Grouped questions)
    Definition: A group of questions to a possibly similarly grouped set of questions in the questionnaire

Class Questionnaire

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SP_STATUS

STATUS

SP_AUTHORED

AUTHORED

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_AUTHOR

AUTHOR

INCLUDE_AUTHOR

SP_IDENTIFIER

IDENTIFIER

SP_NAME

NAME

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

Constructor Detail

Questionnaire

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getStatus

setStatus

setStatus

getAuthored

setAuthored

setAuthoredWithSecondsPrecision

setAuthored

getSubject

setSubject

getAuthor

setAuthor

getSource

setSource

getName

setName

setName

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getEncounter

setEncounter

getGroup

setGroup