Questionnaire (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.Questionnaire

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Questionnaire
extends BaseResource
implements IResource
```
HAPI/FHIR Questionnaire Resource (infrastructure.information)
Definition: A structured set of questions intended to guide the collection of 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/Questionnaire

See Also:

Serialized Form

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static StringClientParam`	`PUBLISHER` Fluent Client search parameter constant for publisher
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PUBLISHER` Search parameter constant for publisher
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_TITLE` Search parameter constant for title
`static String`	`SP_VERSION` Search parameter constant for version
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static StringClientParam`	`TITLE` Fluent Client search parameter constant for title
`static StringClientParam`	`VERSION` Fluent Client search parameter constant for version

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

Questionnaire()

Constructors
Constructor and Description
`Questionnaire()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Questionnaire`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`BoundCodeDt<ResourceTypeEnum>`	`addSubjectType()` Add a value for subjectType ()
`BoundCodeDt<ResourceTypeEnum>`	`addSubjectType(ResourceTypeEnum theValue)` Add a value for subjectType () using an enumerated type.
`ContactPointDt`	`addTelecom()` Adds and returns a new value for telecom ()
`Questionnaire`	`addTelecom(ContactPointDt theValue)` Adds a given new value for telecom ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Date`	`getDate()` Gets the value(s) for date (when.recorded).
`DateTimeDt`	`getDateElement()` Gets the value(s) for date (when.recorded).
`Questionnaire.Group`	`getGroup()` Gets the value(s) for group ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`String`	`getPublisher()` Gets the value(s) for publisher (who.witness).
`StringDt`	`getPublisherElement()` Gets the value(s) for publisher (who.witness).
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status (status).
`BoundCodeDt<QuestionnaireStatusEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<BoundCodeDt<ResourceTypeEnum>>`	`getSubjectType()` Gets the value(s) for subjectType ().
`BoundCodeDt<ResourceTypeEnum>`	`getSubjectTypeFirstRep()` Gets the first repetition for subjectType (), creating it if it does not already exist.
`List<ContactPointDt>`	`getTelecom()` Gets the value(s) for telecom ().
`ContactPointDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (), creating it if it does not already exist.
`String`	`getVersion()` Gets the value(s) for version (id.version).
`StringDt`	`getVersionElement()` Gets the value(s) for version (id.version).
`boolean`	`isEmpty()`
`Questionnaire`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (when.recorded)
`Questionnaire`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (when.recorded)
`Questionnaire`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (when.recorded)
`Questionnaire`	`setGroup(Questionnaire.Group theValue)` Sets the value(s) for group ()
`Questionnaire`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Questionnaire`	`setPublisher(String theString)` Sets the value for publisher (who.witness)
`Questionnaire`	`setPublisher(StringDt theValue)` Sets the value(s) for publisher (who.witness)
`Questionnaire`	`setStatus(BoundCodeDt<QuestionnaireStatusEnum> theValue)` Sets the value(s) for status (status)
`Questionnaire`	`setStatus(QuestionnaireStatusEnum theValue)` Sets the value(s) for status (status)
`Questionnaire`	`setSubjectType(List<BoundCodeDt<ResourceTypeEnum>> theValue)` Sets the value(s) for subjectType ()
`Questionnaire`	`setSubjectType(ResourceTypeEnum theValue)` Sets the value(s), and clears any existing value(s) for subjectType ()
`Questionnaire`	`setTelecom(List<ContactPointDt> theValue)` Sets the value(s) for telecom ()
`Questionnaire`	`setVersion(String theString)` Sets the value for version (id.version)
`Questionnaire`	`setVersion(StringDt theValue)` Sets the value(s) for version (id.version)

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
    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_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: When the questionnaire was last changed
    Type: date
    Path: Questionnaire.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: When the questionnaire was last changed
    Type: date
    Path: Questionnaire.date
  - SP_PUBLISHER
```
public static final String SP_PUBLISHER
```
    Search parameter constant for publisher
    Description: The author of the questionnaire
    Type: string
    Path: Questionnaire.publisher
    
    See Also:
    
    Constant Field Values
  - PUBLISHER
```
public static final StringClientParam PUBLISHER
```
    Fluent Client search parameter constant for publisher
    Description: The author of the questionnaire
    Type: string
    Path: Questionnaire.publisher
  - 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_VERSION
```
public static final String SP_VERSION
```
    Search parameter constant for version
    Description: The business version of the questionnaire
    Type: string
    Path: Questionnaire.version
    
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final StringClientParam VERSION
```
    Fluent Client search parameter constant for version
    Description: The business version of the questionnaire
    Type: string
    Path: Questionnaire.version
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description: A code that corresponds to the questionnaire or one of its groups
    Type: token
    Path: Questionnaire.group.concept
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: A code that corresponds to the questionnaire or one of its groups
    Type: token
    Path: Questionnaire.group.concept
  - SP_TITLE
```
public static final String SP_TITLE
```
    Search parameter constant for title
    Description: All or part of the name of the questionnaire (title for the root group of the questionnaire)
    Type: string
    Path: Questionnaire.group.title
    
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final StringClientParam TITLE
```
    Fluent Client search parameter constant for title
    Description: All or part of the name of the questionnaire (title for the root group of the questionnaire)
    Type: string
    Path: Questionnaire.group.title
- Constructor Detail
  - Questionnaire
```
public Questionnaire()
```
- 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 List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: This records identifiers associated with this question set that are defined by business processes 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 (id)
    Definition: This records identifiers associated with this question set that are defined by business processes 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 (id)
    Definition: This records identifiers associated with this question set that are defined by business processes 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(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: This records identifiers associated with this question set that are defined by business processes 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)
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition: This records identifiers associated with this question set that are defined by business processes 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)
  - getVersionElement
```
public StringDt getVersionElement()
```
    Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.
    Definition: The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated
  - getVersion
```
public String getVersion()
```
    Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.
    Definition: The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated
  - setVersion
```
public Questionnaire setVersion(StringDt theValue)
```
    Sets the value(s) for version (id.version)
    Definition: The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated
  - setVersion
```
public Questionnaire setVersion(String theString)
```
    Sets the value for version (id.version)
    Definition: The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated
  - getStatusElement
```
public BoundCodeDt<QuestionnaireStatusEnum> 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 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 as a whole.
  - setStatus
```
public Questionnaire setStatus(BoundCodeDt<QuestionnaireStatusEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition: The lifecycle status of the questionnaire as a whole.
  - setStatus
```
public Questionnaire setStatus(QuestionnaireStatusEnum theValue)
```
    Sets the value(s) for status (status)
    Definition: The lifecycle status of the questionnaire as a whole.
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date that this questionnaire was last changed
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date that this questionnaire was last changed
  - setDate
```
public Questionnaire setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (when.recorded)
    Definition: The date that this questionnaire was last changed
  - setDate
```
public Questionnaire setDate(Date theDate,
                             TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (when.recorded)
    Definition: The date that this questionnaire was last changed
  - setDateWithSecondsPrecision
```
public Questionnaire setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (when.recorded)
    Definition: The date that this questionnaire was last changed
  - getPublisherElement
```
public StringDt getPublisherElement()
```
    Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.
    Definition: Organization or person responsible for developing and maintaining the questionnaire
  - getPublisher
```
public String getPublisher()
```
    Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.
    Definition: Organization or person responsible for developing and maintaining the questionnaire
  - setPublisher
```
public Questionnaire setPublisher(StringDt theValue)
```
    Sets the value(s) for publisher (who.witness)
    Definition: Organization or person responsible for developing and maintaining the questionnaire
  - setPublisher
```
public Questionnaire setPublisher(String theString)
```
    Sets the value for publisher (who.witness)
    Definition: Organization or person responsible for developing and maintaining the questionnaire
  - getTelecom
```
public List<ContactPointDt> getTelecom()
```
    Gets the value(s) for telecom (). creating it if it does not exist. Will not return null.
    Definition: Contact details to assist a user in finding and communicating with the publisher
  - setTelecom
```
public Questionnaire setTelecom(List<ContactPointDt> theValue)
```
    Sets the value(s) for telecom ()
    Definition: Contact details to assist a user in finding and communicating with the publisher
  - addTelecom
```
public ContactPointDt addTelecom()
```
    Adds and returns a new value for telecom ()
    Definition: Contact details to assist a user in finding and communicating with the publisher
  - addTelecom
```
public Questionnaire addTelecom(ContactPointDt theValue)
```
    Adds a given new value for telecom ()
    Definition: Contact details to assist a user in finding and communicating with the publisher
    
    Parameters:
    
    theValue - The telecom to add (must not be null)
  - getTelecomFirstRep
```
public ContactPointDt getTelecomFirstRep()
```
    Gets the first repetition for telecom (), creating it if it does not already exist.
    Definition: Contact details to assist a user in finding and communicating with the publisher
  - getSubjectType
```
public List<BoundCodeDt<ResourceTypeEnum>> getSubjectType()
```
    Gets the value(s) for subjectType (). creating it if it does not exist. Will not return null.
    Definition: Identifies the types of subjects that can be the subject of the questionnaire.
  - setSubjectType
```
public Questionnaire setSubjectType(List<BoundCodeDt<ResourceTypeEnum>> theValue)
```
    Sets the value(s) for subjectType ()
    Definition: Identifies the types of subjects that can be the subject of the questionnaire.
  - addSubjectType
```
public BoundCodeDt<ResourceTypeEnum> addSubjectType(ResourceTypeEnum theValue)
```
    Add a value for subjectType () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addSubjectType() method.
    Definition: Identifies the types of subjects that can be the subject of the questionnaire.
  - getSubjectTypeFirstRep
```
public BoundCodeDt<ResourceTypeEnum> getSubjectTypeFirstRep()
```
    Gets the first repetition for subjectType (), creating it if it does not already exist.
    Definition: Identifies the types of subjects that can be the subject of the questionnaire.
  - addSubjectType
```
public BoundCodeDt<ResourceTypeEnum> addSubjectType()
```
    Add a value for subjectType ()
    Definition: Identifies the types of subjects that can be the subject of the questionnaire.
  - setSubjectType
```
public Questionnaire setSubjectType(ResourceTypeEnum theValue)
```
    Sets the value(s), and clears any existing value(s) for subjectType ()
    Definition: Identifies the types of subjects that can be the subject of the questionnaire.
  - getGroup
```
public Questionnaire.Group getGroup()
```
    Gets the value(s) for group (). creating it if it does not exist. Will not return null.
    Definition: A collection of related questions (or further groupings of questions)
  - setGroup
```
public Questionnaire setGroup(Questionnaire.Group theValue)
```
    Sets the value(s) for group ()
    Definition: A collection of related questions (or further groupings of questions)
  - 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 Questionnaire

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_DATE

DATE

SP_PUBLISHER

PUBLISHER

SP_IDENTIFIER

IDENTIFIER

SP_VERSION

VERSION

SP_CODE

CODE

SP_TITLE

TITLE

Constructor Detail

Questionnaire

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getVersionElement

getVersion

setVersion

setVersion

getStatusElement

getStatus

setStatus

setStatus

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision

getPublisherElement

getPublisher

setPublisher

setPublisher

getTelecom

setTelecom

addTelecom

addTelecom

getTelecomFirstRep

getSubjectType

setSubjectType

addSubjectType

getSubjectTypeFirstRep

addSubjectType

setSubjectType

getGroup

setGroup

getResourceName

getStructureFhirVersionEnum