Skip to main content

QuestionnaireResponse

Overview​

The QuestionnaireResponse resource represents structured sets of questions and their answers, organized into coherent subsets that correspond to questionnaire groupings. This resource supports clinical assessments, intake forms, and patient-reported outcomes.

Important: Always validate QuestionnaireResponse resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.

Resource Schema​

The QuestionnaireResponse resource follows the HL7 FHIR R4 QuestionnaireResponse specification.

Key elements include:

  • identifier - Unique id for this set of answers
  • basedOn - Request fulfilled by this QuestionnaireResponse
  • partOf - Part of this action
  • questionnaire - Form being answered
  • status - In-progress, completed, amended, entered-in-error, stopped
  • subject - The subject of the questions
  • encounter - Encounter created as part of
  • authored - Date the answers were gathered
  • author - Person who received and recorded the answers
  • source - The person who answered the questions
  • item - Groups and questions

Example QuestionnaireResponse Resource​

{
  "resourceType": "QuestionnaireResponse",
  "id": "12345",
  "identifier": {
    "use": "official",
    "system": "http://hospital.example.org/questionnaire-responses",
    "value": "QR-2024-001"
  },
  "questionnaire": "http://hospital.example.org/questionnaires/intake-assessment",
  "status": "completed",
  "subject": {
    "reference": "Patient/12345"
  },
  "encounter": {
    "reference": "Encounter/67890"
  },
  "authored": "2024-01-15T14:30:00Z",
  "author": {
    "reference": "Practitioner/67890",
    "display": "Dr. John Smith"
  },
  "source": {
    "reference": "Patient/12345"
  },
  "item": [{
    "linkId": "1",
    "text": "General Health",
    "item": [{
      "linkId": "1.1",
      "text": "How would you rate your overall health?",
      "answer": [{
        "valueCoding": {
          "system": "http://loinc.org",
          "code": "LA13914-0",
          "display": "Good"
        }
      }]
    }, {
      "linkId": "1.2",
      "text": "Do you have any chronic conditions?",
      "answer": [{
        "valueBoolean": true
      }]
    }]
  }, {
    "linkId": "2",
    "text": "Medications",
    "item": [{
      "linkId": "2.1",
      "text": "Are you currently taking any medications?",
      "answer": [{
        "valueBoolean": true
      }]
    }, {
      "linkId": "2.2",
      "text": "Please list your current medications",
      "answer": [{
        "valueString": "Lisinopril 10mg daily, Metformin 500mg twice daily"
      }]
    }]
  }]
}

Supported Profiles​

This API supports the following FHIR profiles:

Operations​

The General Purpose FHIR R4 QuestionnaireResponse resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatarYesYesYesYes
myEvolv-Yes-Yes
myUnity-Yes-Yes
Referral Manager----
info

Not all Netsmart solutions support QuestionnaireResponse search. See supported operations table above and consult your target solution's documentation for more information.

This resource supports a combination of standard and custom search parameters in addition to the common parameters.

Standard Parameters​

NameTypeDescription
authorreferenceThe author of the questionnaire response.
authoreddateWhen the questionnaire response was last changed
encounterreferenceUnique identifier of the Encounter
patientreferenceUnique identifier of the patient

Custom Parameters​

NameTypeDescription
questionnaire_typereferenceREQUIRED Category of the Questionnaire. Possible values include: TreatmentPlan.
practitionerreferenceOPTIONAL Unique identifier of the Practitioner
enddateDeprecated. Use authored parameter with le prefix instead.
startdateDeprecated. Use authored parameter with ge prefix instead.

Search Examples​

The POST method is recommended as it keeps health information out of the URL.

Search EHR Assessment Results by Patient
curl -X POST https://fhir.netsmartcloud.com/v4/QuestionnaireResponse/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "questionnaire_type=intake"

Error Handling​

For information about error responses when working with QuestionnaireResponse resources, see Common Errors.

Common QuestionnaireResponse-related errors include:

  • Missing required patient reference
  • Invalid questionnaire type parameters
  • Malformed response dates
  • Invalid author or encounter references

Integration Patterns​

Clinical Assessments​

Retrieve patient assessment responses:

# Get assessment responses for patient
curl -X GET "https://fhir.netsmartcloud.com/v4/QuestionnaireResponse?patient=12345&questionnaire_type=intake" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Outcome Tracking​

Track responses over time:

# Get responses by date range
curl -X GET "https://fhir.netsmartcloud.com/v4/QuestionnaireResponse?patient=12345&authored=ge2024-01-01" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Provider Workflows​

Find responses by author:

# Get responses by practitioner
curl -X GET "https://fhir.netsmartcloud.com/v4/QuestionnaireResponse?author=Practitioner/67890" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Encounter-Based Assessments​

Retrieve responses from specific encounters:

# Get responses from encounter
curl -X GET "https://fhir.netsmartcloud.com/v4/QuestionnaireResponse?encounter=67890" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Relationships to Other Resources​

The QuestionnaireResponse resource connects to several clinical and administrative resources:

  • Patient - The individual who provided responses
  • Practitioner - Healthcare providers administering questionnaires
  • Encounter - Clinical encounters during which assessments occurred
  • Observation - Clinical observations derived from responses
  • Condition - Health conditions identified through assessments
  • CarePlan - Care plans informed by assessment responses

Support​

For questions about QuestionnaireResponse resource implementation or clinical assessment workflows, contact Netsmart support through your designated support channels.