Class QuestionnaireResponse

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class QuestionnaireResponse
    extends BaseResource
    implements ca.uhn.fhir.model.api.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
    • 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
        Fluent Client search parameter constant for source

        Description:
        Type: reference
        Path: QuestionnaireResponse.source

      • INCLUDE_AUTHOR

        public static final ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "QuestionnaireResponse:subject".
    • 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
      • 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

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<QuestionnaireResponseStatusEnumgetStatusElement()
        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. This method may return null.

        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 ca.uhn.fhir.model.primitive.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. This method may return null.

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

      • setAuthored

        public QuestionnaireResponse setAuthored​(ca.uhn.fhir.model.primitive.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,
                                                 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        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.

      • 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

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource