Package ca.uhn.fhir.model.dstu2.resource

Class Questionnaire

  • 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 Questionnaire
extends BaseResource
implements ca.uhn.fhir.model.api.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

    • 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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

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

        Definition: The lifecycle status of the questionnaire as a whole.

      • setStatus

        public Questionnaire setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<QuestionnaireStatusEnum> theValue)
        Sets the value(s) for status (status)

        Definition: The lifecycle status of the questionnaire as a whole.

      • getDateElement

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

        Definition: The date that this questionnaire was last changed

      • setDate

        public Questionnaire setDate​(ca.uhn.fhir.model.primitive.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,
                             ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.recorded)

        Definition: The date that this questionnaire was last changed

      • getPublisherElement

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

        Definition: Organization or person responsible for developing and maintaining the questionnaire

      • setPublisher

        public Questionnaire setPublisher​(ca.uhn.fhir.model.primitive.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<ca.uhn.fhir.model.primitive.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<ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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)

      • 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