QuestionnaireResponse (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.QuestionnaireResponse

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class QuestionnaireResponse
extends BaseResource
implements IResource
```
HAPI/FHIR QuestionnaireResponse Resource (infrastructure.information)
Definition: A structured set of questions and their answers. 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/QuestionnaireResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`QuestionnaireResponse.Group` Block class for child element: QuestionnaireResponse.group ()
`static class`	`QuestionnaireResponse.GroupQuestion` Block class for child element: QuestionnaireResponse.group.question ()
`static class`	`QuestionnaireResponse.GroupQuestionAnswer` Block class for child element: QuestionnaireResponse.group.question.answer ()

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 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_QUESTIONNAIRE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SOURCE` 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
`static ReferenceClientParam`	`QUESTIONNAIRE` Fluent Client search parameter constant for questionnaire
`static ReferenceClientParam`	`SOURCE` Fluent Client search parameter constant for source
`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_PATIENT` Search parameter constant for patient
`static String`	`SP_QUESTIONNAIRE` Search parameter constant for questionnaire
`static String`	`SP_SOURCE` Search parameter constant for source
`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.dstu2.resource.BaseResource
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

QuestionnaireResponse()

Constructors
Constructor and Description
`QuestionnaireResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAuthor()` Gets the value(s) for author (who.author).
`Date`	`getAuthored()` Gets the value(s) for authored (when.recorded).
`DateTimeDt`	`getAuthoredElement()` Gets the value(s) for authored (when.recorded).
`ResourceReferenceDt`	`getEncounter()` Gets the value(s) for encounter (context).
`QuestionnaireResponse.Group`	`getGroup()` Gets the value(s) for group ().
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier (id).
`ResourceReferenceDt`	`getQuestionnaire()` Gets the value(s) for questionnaire ().
`String`	`getResourceName()`
`ResourceReferenceDt`	`getSource()` Gets the value(s) for source (who.source).
`String`	`getStatus()` Gets the value(s) for status (status).
`BoundCodeDt<QuestionnaireResponseStatusEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (who.focus).
`boolean`	`isEmpty()`
`QuestionnaireResponse`	`setAuthor(ResourceReferenceDt theValue)` Sets the value(s) for author (who.author)
`QuestionnaireResponse`	`setAuthored(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for authored (when.recorded)
`QuestionnaireResponse`	`setAuthored(DateTimeDt theValue)` Sets the value(s) for authored (when.recorded)
`QuestionnaireResponse`	`setAuthoredWithSecondsPrecision(Date theDate)` Sets the value for authored (when.recorded)
`QuestionnaireResponse`	`setEncounter(ResourceReferenceDt theValue)` Sets the value(s) for encounter (context)
`QuestionnaireResponse`	`setGroup(QuestionnaireResponse.Group theValue)` Sets the value(s) for group ()
`QuestionnaireResponse`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier (id)
`QuestionnaireResponse`	`setQuestionnaire(ResourceReferenceDt theValue)` Sets the value(s) for questionnaire ()
`QuestionnaireResponse`	`setSource(ResourceReferenceDt theValue)` Sets the value(s) for source (who.source)
`QuestionnaireResponse`	`setStatus(BoundCodeDt<QuestionnaireResponseStatusEnum> theValue)` Sets the value(s) for status (status)
`QuestionnaireResponse`	`setStatus(QuestionnaireResponseStatusEnum theValue)` Sets the value(s) for status (status)
`QuestionnaireResponse`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (who.focus)

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

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

- Field Detail
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description: The status of the questionnaire response
    Type: token
    Path: QuestionnaireResponse.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 response
    Type: token
    Path: QuestionnaireResponse.status
  - SP_AUTHORED
```
public static final String SP_AUTHORED
```
    Search parameter constant for authored
    Description: When the questionnaire was authored
    Type: date
    Path: QuestionnaireResponse.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: QuestionnaireResponse.authored
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The subject of the questionnaire
    Type: reference
    Path: QuestionnaireResponse.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: QuestionnaireResponse.subject
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description: The author of the questionnaire
    Type: reference
    Path: QuestionnaireResponse.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: QuestionnaireResponse.author
  - SP_QUESTIONNAIRE
```
public static final String SP_QUESTIONNAIRE
```
    Search parameter constant for questionnaire
    Description: The questionnaire the answers are provided for
    Type: reference
    Path: QuestionnaireResponse.questionnaire
    
    See Also:
    
    Constant Field Values
  - QUESTIONNAIRE
```
public static final ReferenceClientParam QUESTIONNAIRE
```
    Fluent Client search parameter constant for questionnaire
    Description: The questionnaire the answers are provided for
    Type: reference
    Path: QuestionnaireResponse.questionnaire
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter constant for encounter
    Description: Encounter during which questionnaire was authored
    Type: reference
    Path: QuestionnaireResponse.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: QuestionnaireResponse.encounter
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The patient that is the subject of the questionnaire
    Type: reference
    Path: QuestionnaireResponse.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The patient that is the subject of the questionnaire
    Type: reference
    Path: QuestionnaireResponse.subject
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter constant for source
    Description:
    Type: reference
    Path: QuestionnaireResponse.source
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final ReferenceClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description:
    Type: reference
    Path: QuestionnaireResponse.source
  - INCLUDE_AUTHOR
```
public static final Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:author".
  - INCLUDE_ENCOUNTER
```
public static final Include INCLUDE_ENCOUNTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:encounter".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:patient".
  - INCLUDE_QUESTIONNAIRE
```
public static final Include INCLUDE_QUESTIONNAIRE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:questionnaire".
  - INCLUDE_SOURCE
```
public static final Include INCLUDE_SOURCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:source".
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:subject".
- Constructor Detail
  - QuestionnaireResponse
```
public QuestionnaireResponse()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: A business identifier assigned to a particular completed (or partially completed) questionnaire
  - setIdentifier
```
public QuestionnaireResponse setIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for identifier (id)
    Definition: A business identifier assigned to a particular completed (or partially completed) questionnaire
  - getQuestionnaire
```
public ResourceReferenceDt getQuestionnaire()
```
    Gets the value(s) for questionnaire (). creating it if it does not exist. Will not return null.
    Definition: Indicates the Questionnaire resource that defines the form for which answers are being provided
  - setQuestionnaire
```
public QuestionnaireResponse setQuestionnaire(ResourceReferenceDt theValue)
```
    Sets the value(s) for questionnaire ()
    Definition: Indicates the Questionnaire resource that defines the form for which answers are being provided
  - getStatusElement
```
public BoundCodeDt<QuestionnaireResponseStatusEnum> getStatusElement()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: The lifecycle status of the questionnaire response as a whole.
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: The lifecycle status of the questionnaire response as a whole.
  - setStatus
```
public QuestionnaireResponse setStatus(BoundCodeDt<QuestionnaireResponseStatusEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition: The lifecycle status of the questionnaire response as a whole.
  - setStatus
```
public QuestionnaireResponse setStatus(QuestionnaireResponseStatusEnum theValue)
```
    Sets the value(s) for status (status)
    Definition: The lifecycle status of the questionnaire response as a whole.
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.
    Definition: The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information
  - setSubject
```
public QuestionnaireResponse setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (who.focus)
    Definition: The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information
  - getAuthor
```
public ResourceReferenceDt getAuthor()
```
    Gets the value(s) for author (who.author). creating it if it does not exist. Will not return null.
    Definition: Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system
  - setAuthor
```
public QuestionnaireResponse setAuthor(ResourceReferenceDt theValue)
```
    Sets the value(s) for author (who.author)
    Definition: Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system
  - getAuthoredElement
```
public DateTimeDt getAuthoredElement()
```
    Gets the value(s) for authored (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date and/or time that this version of the questionnaire response was authored
  - getAuthored
```
public Date getAuthored()
```
    Gets the value(s) for authored (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date and/or time that this version of the questionnaire response was authored
  - setAuthored
```
public QuestionnaireResponse setAuthored(DateTimeDt theValue)
```
    Sets the value(s) for authored (when.recorded)
    Definition: The date and/or time that this version of the questionnaire response was authored
  - setAuthored
```
public QuestionnaireResponse setAuthored(Date theDate,
                                         TemporalPrecisionEnum thePrecision)
```
    Sets the value for authored (when.recorded)
    Definition: The date and/or time that this version of the questionnaire response was authored
  - setAuthoredWithSecondsPrecision
```
public QuestionnaireResponse setAuthoredWithSecondsPrecision(Date theDate)
```
    Sets the value for authored (when.recorded)
    Definition: The date and/or time that this version of the questionnaire response was authored
  - getSource
```
public ResourceReferenceDt getSource()
```
    Gets the value(s) for source (who.source). creating it if it does not exist. Will not return null.
    Definition: The person who answered the questions about the subject.
  - setSource
```
public QuestionnaireResponse setSource(ResourceReferenceDt theValue)
```
    Sets the value(s) for source (who.source)
    Definition: The person who answered the questions about the subject.
  - getEncounter
```
public ResourceReferenceDt getEncounter()
```
    Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.
    Definition: Encounter during which this set of questionnaire response were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.
  - setEncounter
```
public QuestionnaireResponse setEncounter(ResourceReferenceDt theValue)
```
    Sets the value(s) for encounter (context)
    Definition: Encounter during which this set of questionnaire response were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.
  - getGroup
```
public QuestionnaireResponse.Group getGroup()
```
    Gets the value(s) for group (). 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 response
  - setGroup
```
public QuestionnaireResponse setGroup(QuestionnaireResponse.Group theValue)
```
    Sets the value(s) for group ()
    Definition: A group of questions to a possibly similarly grouped set of questions in the questionnaire response
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class QuestionnaireResponse

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.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

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

Field Detail

SP_STATUS

STATUS

SP_AUTHORED

AUTHORED

SP_SUBJECT

SUBJECT

SP_AUTHOR

AUTHOR

SP_QUESTIONNAIRE

QUESTIONNAIRE

SP_ENCOUNTER

ENCOUNTER

SP_PATIENT

PATIENT

SP_SOURCE

SOURCE

INCLUDE_AUTHOR

INCLUDE_ENCOUNTER

INCLUDE_PATIENT

INCLUDE_QUESTIONNAIRE

INCLUDE_SOURCE

INCLUDE_SUBJECT

Constructor Detail

QuestionnaireResponse

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

getQuestionnaire

setQuestionnaire

getStatusElement

getStatus

setStatus

setStatus

getSubject

setSubject

getAuthor

setAuthor

getAuthoredElement

getAuthored

setAuthored

setAuthored

setAuthoredWithSecondsPrecision

getSource

setSource

getEncounter

setEncounter

getGroup

setGroup

getResourceName

getStructureFhirVersionEnum