Package org.hl7.fhir.dstu2.model

Class QuestionnaireResponse

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.model.QuestionnaireResponse

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class QuestionnaireResponse
extends DomainResource

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuestionnaireResponse.GroupComponent
static class	QuestionnaireResponse.QuestionAnswerComponent
static class	QuestionnaireResponse.QuestionComponent
static enum	QuestionnaireResponse.QuestionnaireResponseStatus
static class	QuestionnaireResponse.QuestionnaireResponseStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	author	Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
protected DateTimeType	authored	The date and/or time that this version of the questionnaire response was authored.
protected Resource	authorTarget	The actual object that is the target of the reference (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)
protected Reference	encounter	Encounter during which this set of questionnaire response were collected.
protected Encounter	encounterTarget	The actual object that is the target of the reference (Encounter during which this set of questionnaire response were collected.
protected QuestionnaireResponse.GroupComponent	group	A group of questions to a possibly similarly grouped set of questions in the questionnaire response.
protected Identifier	identifier	A business identifier assigned to a particular completed (or partially completed) questionnaire.
protected Reference	questionnaire	Indicates the Questionnaire resource that defines the form for which answers are being provided.
protected Questionnaire	questionnaireTarget	The actual object that is the target of the reference (Indicates the Questionnaire resource that defines the form for which answers are being provided.)
protected Reference	source	The person who answered the questions about the subject.
protected Resource	sourceTarget	The actual object that is the target of the reference (The person who answered the questions about the subject.)
static final String	SP_AUTHOR
static final String	SP_AUTHORED
static final String	SP_ENCOUNTER
static final String	SP_PATIENT
static final String	SP_QUESTIONNAIRE
static final String	SP_SOURCE
static final String	SP_STATUS
static final String	SP_SUBJECT
protected Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus>	status	The lifecycle status of the questionnaire response as a whole.
protected Reference	subject	The subject of the questionnaire response.
protected Resource	subjectTarget	The actual object that is the target of the reference (The subject of the questionnaire response.

Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2.model.Resource

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
QuestionnaireResponse()
QuestionnaireResponse(Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> status)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
QuestionnaireResponse	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Reference	getAuthor()
Date	getAuthored()
DateTimeType	getAuthoredElement()
Resource	getAuthorTarget()
Reference	getEncounter()
Encounter	getEncounterTarget()
QuestionnaireResponse.GroupComponent	getGroup()
Identifier	getIdentifier()
Reference	getQuestionnaire()
Questionnaire	getQuestionnaireTarget()
ResourceType	getResourceType()
Reference	getSource()
Resource	getSourceTarget()
QuestionnaireResponse.QuestionnaireResponseStatus	getStatus()
Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
boolean	hasAuthor()
boolean	hasAuthored()
boolean	hasAuthoredElement()
boolean	hasEncounter()
boolean	hasGroup()
boolean	hasIdentifier()
boolean	hasQuestionnaire()
boolean	hasSource()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
QuestionnaireResponse	setAuthor(Reference value)
QuestionnaireResponse	setAuthored(Date value)
QuestionnaireResponse	setAuthoredElement(DateTimeType value)
QuestionnaireResponse	setAuthorTarget(Resource value)
QuestionnaireResponse	setEncounter(Reference value)
QuestionnaireResponse	setEncounterTarget(Encounter value)
QuestionnaireResponse	setGroup(QuestionnaireResponse.GroupComponent value)
QuestionnaireResponse	setIdentifier(Identifier value)
void	setProperty(String name, Base value)
QuestionnaireResponse	setQuestionnaire(Reference value)
QuestionnaireResponse	setQuestionnaireTarget(Questionnaire value)
QuestionnaireResponse	setSource(Reference value)
QuestionnaireResponse	setSourceTarget(Resource value)
QuestionnaireResponse	setStatus(QuestionnaireResponse.QuestionnaireResponseStatus value)
QuestionnaireResponse	setStatusElement(Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> value)
QuestionnaireResponse	setSubject(Reference value)
QuestionnaireResponse	setSubjectTarget(Resource value)
protected QuestionnaireResponse	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected Identifier identifier

A business identifier assigned to a particular completed (or partially completed) questionnaire.

questionnaire

protected Reference questionnaire

Indicates the Questionnaire resource that defines the form for which answers are being provided.

questionnaireTarget

protected Questionnaire questionnaireTarget

The actual object that is the target of the reference (Indicates the Questionnaire resource that defines the form for which answers are being provided.)

status

protected Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> status

The lifecycle status of the questionnaire response as a whole.

subject

protected Reference subject

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.

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (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.)

author

protected Reference author

Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

authorTarget

protected Resource authorTarget

The actual object that is the target of the reference (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)

authored

protected DateTimeType authored

The date and/or time that this version of the questionnaire response was authored.

source

protected Reference source

The person who answered the questions about the subject.

sourceTarget

protected Resource sourceTarget

The actual object that is the target of the reference (The person who answered the questions about the subject.)

encounter

protected Reference encounter

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.

encounterTarget

protected Encounter encounterTarget

The actual object that is the target of the reference (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.)

group

protected QuestionnaireResponse.GroupComponent group

A group of questions to a possibly similarly grouped set of questions in the questionnaire response.

SP_AUTHORED

public static final String SP_AUTHORED

See Also:

• Constant Field Values

SP_QUESTIONNAIRE

public static final String SP_QUESTIONNAIRE

See Also:

• Constant Field Values

SP_SUBJECT

public static final String SP_SUBJECT

See Also:

• Constant Field Values

SP_AUTHOR

public static final String SP_AUTHOR

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_ENCOUNTER

public static final String SP_ENCOUNTER

See Also:

• Constant Field Values

SP_SOURCE

public static final String SP_SOURCE

See Also:

• Constant Field Values

SP_STATUS

public static final String SP_STATUS

See Also:

• Constant Field Values

Constructor Details

QuestionnaireResponse

public QuestionnaireResponse()

QuestionnaireResponse

public QuestionnaireResponse(Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> status)

Method Details

getIdentifier

public Identifier getIdentifier()

Returns:

identifier (A business identifier assigned to a particular completed (or partially completed) questionnaire.)

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public QuestionnaireResponse setIdentifier(Identifier value)

Parameters:

value - identifier (A business identifier assigned to a particular completed (or partially completed) questionnaire.)

getQuestionnaire

public Reference getQuestionnaire()

Returns:

questionnaire (Indicates the Questionnaire resource that defines the form for which answers are being provided.)

hasQuestionnaire

public boolean hasQuestionnaire()

setQuestionnaire

public QuestionnaireResponse setQuestionnaire(Reference value)

Parameters:

value - questionnaire (Indicates the Questionnaire resource that defines the form for which answers are being provided.)

getQuestionnaireTarget

public Questionnaire getQuestionnaireTarget()

Returns:

questionnaire The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates the Questionnaire resource that defines the form for which answers are being provided.)

setQuestionnaireTarget

public QuestionnaireResponse setQuestionnaireTarget(Questionnaire value)

Parameters:

value - questionnaire The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates the Questionnaire resource that defines the form for which answers are being provided.)

getStatusElement

public Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> getStatusElement()

Returns:

status (The lifecycle status of the questionnaire response as a whole.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public QuestionnaireResponse setStatusElement(Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> value)

Parameters:

value - status (The lifecycle status of the questionnaire response as a whole.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public QuestionnaireResponse.QuestionnaireResponseStatus getStatus()

Returns:

The lifecycle status of the questionnaire response as a whole.

setStatus

public QuestionnaireResponse setStatus(QuestionnaireResponse.QuestionnaireResponseStatus value)

Parameters:

value - The lifecycle status of the questionnaire response as a whole.

getSubject

public Reference getSubject()

Returns:

subject (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.)

hasSubject

public boolean hasSubject()

setSubject

public QuestionnaireResponse setSubject(Reference value)

Parameters:

value - subject (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.)

getSubjectTarget

public Resource getSubjectTarget()

Returns:

subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)

setSubjectTarget

public QuestionnaireResponse setSubjectTarget(Resource value)

Parameters:

value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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 Reference getAuthor()

Returns:

author (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)

hasAuthor

public boolean hasAuthor()

setAuthor

public QuestionnaireResponse setAuthor(Reference value)

Parameters:

value - author (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)

getAuthorTarget

public Resource getAuthorTarget()

Returns:

author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)

setAuthorTarget

public QuestionnaireResponse setAuthorTarget(Resource value)

Parameters:

value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)

getAuthoredElement

public DateTimeType getAuthoredElement()

Returns:

authored (The date and/or time that this version of the questionnaire response was authored.). This is the underlying object with id, value and extensions. The accessor "getAuthored" gives direct access to the value

hasAuthoredElement

public boolean hasAuthoredElement()

hasAuthored

public boolean hasAuthored()

setAuthoredElement

public QuestionnaireResponse setAuthoredElement(DateTimeType value)

Parameters:

value - authored (The date and/or time that this version of the questionnaire response was authored.). This is the underlying object with id, value and extensions. The accessor "getAuthored" gives direct access to the value

getAuthored

public Date getAuthored()

Returns:

The date and/or time that this version of the questionnaire response was authored.

setAuthored

public QuestionnaireResponse setAuthored(Date value)

Parameters:

value - The date and/or time that this version of the questionnaire response was authored.

getSource

public Reference getSource()

Returns:

source (The person who answered the questions about the subject.)

hasSource

public boolean hasSource()

setSource

public QuestionnaireResponse setSource(Reference value)

Parameters:

value - source (The person who answered the questions about the subject.)

getSourceTarget

public Resource getSourceTarget()

Returns:

source The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person who answered the questions about the subject.)

setSourceTarget

public QuestionnaireResponse setSourceTarget(Resource value)

Parameters:

value - source The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person who answered the questions about the subject.)

getEncounter

public Reference getEncounter()

Returns:

encounter (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.)

hasEncounter

public boolean hasEncounter()

setEncounter

public QuestionnaireResponse setEncounter(Reference value)

Parameters:

value - encounter (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.)

getEncounterTarget

public Encounter getEncounterTarget()

Returns:

encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)

setEncounterTarget

public QuestionnaireResponse setEncounterTarget(Encounter value)

Parameters:

value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.GroupComponent getGroup()

Returns:

group (A group of questions to a possibly similarly grouped set of questions in the questionnaire response.)

hasGroup

public boolean hasGroup()

setGroup

public QuestionnaireResponse setGroup(QuestionnaireResponse.GroupComponent value)

Parameters:

value - group (A group of questions to a possibly similarly grouped set of questions in the questionnaire response.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public QuestionnaireResponse copy()

Specified by:

copy in class DomainResource

typedCopy

protected QuestionnaireResponse typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource