QuestionnaireResponse create

post/QuestionnaireResponse
Page View

This resource contains a healthcare questionnaire either fully or partially populated with answers. The questionnaire order and groupings are typically defined with a Questionnaire resource.

You can review or retrieve healthcare questionnaire responses.

create

Save a questionnaire with answers from a patient or provider in your connection’s system. The questionnaire may be partially or entirely filled out.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/QuestionnaireResponse' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
"resourceType": "QuestionnaireResponse",
7
"id": "redox-questionnaire-response-create-example",
8
"questionnaire": "https://fhir.redoxengine.com/Questionnaire/patient-intake-questionnaire",
9
"status": "completed",
10
"subject": {
11
"reference": "Patient/example"
12
},
13
"authored": "2025-03-27T10:00:00Z",
14
"item": [
15
{
16
"linkId": "LittleInterest",
17
"text": "Little interest or pleasure in doing things",
18
"answer": [
19
{
20
"valueCoding": {
21
"system": "http://loinc.org",
22
"code": "LA6568-5"
23
}
24
}
25
]
26
},
27
{
28
"linkId": "FeelingDown",
29
"text": "Feeling down, depressed, or hopeless",
30
"answer": [
31
{
32
"valueCoding": {
33
"system": "http://loinc.org",
34
"code": "LA6568-5"
35
}
36
}
37
]
38
},
39
{
40
"linkId": "TroubleSleeping",
41
"text": "Trouble falling or staying asleep",
42
"answer": [
43
{
44
"valueCoding": {
45
"system": "http://loinc.org",
46
"code": "LA6570-1"
47
}
48
}
49
]
50
},
51
{
52
"linkId": "FeelingTired",
53
"text": "Feeling tired or having little energy",
54
"answer": [
55
{
56
"valueCoding": {
57
"system": "http://loinc.org",
58
"code": "LA6571-3"
59
}
60
}
61
]
62
},
63
{
64
"linkId": "BadAppetite",
65
"text": "Poor appetite or overeating",
66
"answer": [
67
{
68
"valueCoding": {
69
"system": "http://loinc.org",
70
"code": "LA6568-5"
71
}
72
}
73
]
74
},
75
{
76
"linkId": "FeelingBadAboutSelf",
77
"text": "Feeling bad about yourself - or that you are a failure or have let yourself or your family down",
78
"answer": [
79
{
80
"valueCoding": {
81
"system": "http://loinc.org",
82
"code": "LA6569-3"
83
}
84
}
85
]
86
},
87
{
88
"linkId": "TroubleConcentrating",
89
"text": "Trouble concentrating on things, such as reading the newspaper or watching television",
90
"answer": [
91
{
92
"valueCoding": {
93
"system": "http://loinc.org",
94
"code": "LA6570-1"
95
}
96
}
97
]
98
},
99
{
100
"linkId": "MovingSpeaking",
101
"text": "Moving or speaking so slowly that other people could have noticed. Or the opposite - being so fidgety or restless that you have been moving around a lot more than usual",
102
"answer": [
103
{
104
"valueCoding": {
105
"system": "http://loinc.org",
106
"code": "LA6568-5"
107
}
108
}
109
]
110
},
111
{
112
"linkId": "TotalScore",
113
"text": "Total score",
114
"answer": [
115
{
116
"valueInteger": 10
117
}
118
]
119
},
120
{
121
"linkId": "Difficulty",
122
"text": "If you checked off any problems, how difficult have these problems made it for you to do your work, take care of things at home, or get along with other people",
123
"answer": [
124
{
125
"valueCoding": {
126
"system": "http://loinc.org",
127
"code": "LA6570-1"
128
}
129
}
130
]
131
}
132
]
133
}'

Request Body Schema

    A profile for creating a new QuestionnaireResponse resource in Redox workflows.

  • resourceType
    required, string

    Identifies the type of the resource

    Value: QuestionnaireResponse
  • status
    required, string

    The position of the questionnaire response within its overall lifecycle.

    Possible Values: in-progress, completed, amended, entered-in-error, stopped
  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • identifier
    object

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

    • extension
      Array of Boolean, String, CodeableConcept, Coding

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • url
        required, string

        Source of the definition for the extension code - a logical name or a URL.

      • valueBoolean
        boolean

        A single value for the extension.

    • use
      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • system
      string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    • value
      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • basedOn
    Array of object

    The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

    Must be a resource of type ServiceRequest.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • partOf
    Array of object

    A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

    Must reference one of the following types of resources:

    • Observation
    • Procedure
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • questionnaire
    string

    The Questionnaire that defines and organizes the questions for which answers are being provided.

  • subject
    object

    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.

    Must be a resource of type Resource.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • encounter
    object

    The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

    Must be a resource of type Encounter.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • authored
    string

    The date and/or time that this set of answers were last changed.

  • author
    object

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

    Must reference one of the following types of resources:

    • Practitioner
    • Patient
    • RelatedPerson
    • Device
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • source
    object

    The person who answered the questions about the subject.

    Must reference one of the following types of resources:

    • Patient
    • Practitioner
    • RelatedPerson
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • item
    Array of object

    A group or question item from the original questionnaire for which answers are provided.

    • The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

    • definition
      string

      A reference to an ElementDefinition that provides the details for the item.

    • text
      string

      Text that is displayed above the contents of the group or as the text of the question being answered.

    • answer
      Array of object

      The respondent's answer(s) to the question.

      • valueBoolean
        boolean

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueDecimal
        number

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueInteger
        number

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueDate
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueDateTime
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueTime
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueString
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueUri
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueAttachment
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • contentType
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _contentType
          object

          Extensions for contentType

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • language
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _language
          object

          Extensions for language

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • data
          string

          A stream of bytes

        • _data
          object

          Extensions for data

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • url
          string

          A URI that is a literal reference

        • _url
          object

          Extensions for url

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • size
          number

          An integer with a value that is not negative (e.g. >= 0)

        • _size
          object

          Extensions for size

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • hash
          string

          A stream of bytes

        • _hash
          object

          Extensions for hash

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • title
          string

          A sequence of Unicode characters

        • _title
          object

          Extensions for title

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • creation
          string

          A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

        • _creation
          object

          Extensions for creation

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • valueCoding
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • system
          string

          String of characters used to identify a name or a resource

        • _system
          object

          Extensions for system

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • version
          string

          A sequence of Unicode characters

        • _version
          object

          Extensions for version

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • code
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _code
          object

          Extensions for code

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • display
          string

          A sequence of Unicode characters

        • _display
          object

          Extensions for display

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • userSelected
          boolean

          Value of "true" or "false"

        • _userSelected
          object

          Extensions for userSelected

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • valueQuantity
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • value
          number

          A rational number with implicit precision

        • _value
          object

          Extensions for value

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • comparator

          How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

          Possible Values: <, <=, >=, >
        • _comparator
          object

          Extensions for comparator

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • unit
          string

          A sequence of Unicode characters

        • _unit
          object

          Extensions for unit

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • system
          string

          String of characters used to identify a name or a resource

        • _system
          object

          Extensions for system

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • code
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _code
          object

          Extensions for code

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • valueReference
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        Must be a resource of type Resource.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • reference
          string

          A sequence of Unicode characters

        • _reference
          object

          Extensions for reference

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • type
          string

          String of characters used to identify a name or a resource

        • _type
          object

          Extensions for type

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • identifier
          object

          An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • use

            The purpose of this identifier.

            Possible Values: usual, official, temp, secondary, old
          • _use
            object

            Extensions for use

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • type
            object

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • coding
              Array of object

              A reference to a code defined by a terminology system.

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • system
                string

                String of characters used to identify a name or a resource

              • _system
                object

                Extensions for system

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • version
                string

                A sequence of Unicode characters

              • _version
                object

                Extensions for version

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • code
                string

                A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

              • _code
                object

                Extensions for code

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • display
                string

                A sequence of Unicode characters

              • _display
                object

                Extensions for display

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • userSelected
                boolean

                Value of "true" or "false"

              • _userSelected
                object

                Extensions for userSelected

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • text
              string

              A sequence of Unicode characters

            • _text
              object

              Extensions for text

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • system
            string

            String of characters used to identify a name or a resource

          • _system
            object

            Extensions for system

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • value
            string

            A sequence of Unicode characters

          • _value
            object

            Extensions for value

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • period
            object

            Time period during which identifier is/was valid for use.

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • start
              string

              A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

            • _start
              object

              Extensions for start

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • end
              string

              A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

            • _end
              object

              Extensions for end

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • display
          string

          A sequence of Unicode characters

        • _display
          object

          Extensions for display

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Response fields and example

PHQ-9 Questionnaire Response Example
json
1
{}

    A profile for creating a new QuestionnaireResponse resource in Redox workflows.

  • resourceType
    required, string

    Identifies the type of the resource

    Value: QuestionnaireResponse
  • status
    required, string

    The position of the questionnaire response within its overall lifecycle.

    Possible Values: in-progress, completed, amended, entered-in-error, stopped
  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • identifier
    object

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

    • extension
      Array of Boolean, String, CodeableConcept, Coding

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • url
        required, string

        Source of the definition for the extension code - a logical name or a URL.

      • valueBoolean
        boolean

        A single value for the extension.

    • use
      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • system
      string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    • value
      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • basedOn
    Array of object

    The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

    Must be a resource of type ServiceRequest.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • partOf
    Array of object

    A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

    Must reference one of the following types of resources:

    • Observation
    • Procedure
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • questionnaire
    string

    The Questionnaire that defines and organizes the questions for which answers are being provided.

  • subject
    object

    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.

    Must be a resource of type Resource.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • encounter
    object

    The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

    Must be a resource of type Encounter.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • authored
    string

    The date and/or time that this set of answers were last changed.

  • author
    object

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

    Must reference one of the following types of resources:

    • Practitioner
    • Patient
    • RelatedPerson
    • Device
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • source
    object

    The person who answered the questions about the subject.

    Must reference one of the following types of resources:

    • Patient
    • Practitioner
    • RelatedPerson
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • item
    Array of object

    A group or question item from the original questionnaire for which answers are provided.

    • The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

    • definition
      string

      A reference to an ElementDefinition that provides the details for the item.

    • text
      string

      Text that is displayed above the contents of the group or as the text of the question being answered.

    • answer
      Array of object

      The respondent's answer(s) to the question.

      • valueBoolean
        boolean

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueDecimal
        number

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueInteger
        number

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueDate
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueDateTime
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueTime
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueString
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueUri
        string

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

      • valueAttachment
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • contentType
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _contentType
          object

          Extensions for contentType

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • language
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _language
          object

          Extensions for language

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • data
          string

          A stream of bytes

        • _data
          object

          Extensions for data

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • url
          string

          A URI that is a literal reference

        • _url
          object

          Extensions for url

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • size
          number

          An integer with a value that is not negative (e.g. >= 0)

        • _size
          object

          Extensions for size

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • hash
          string

          A stream of bytes

        • _hash
          object

          Extensions for hash

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • title
          string

          A sequence of Unicode characters

        • _title
          object

          Extensions for title

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • creation
          string

          A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

        • _creation
          object

          Extensions for creation

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • valueCoding
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • system
          string

          String of characters used to identify a name or a resource

        • _system
          object

          Extensions for system

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • version
          string

          A sequence of Unicode characters

        • _version
          object

          Extensions for version

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • code
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _code
          object

          Extensions for code

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • display
          string

          A sequence of Unicode characters

        • _display
          object

          Extensions for display

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • userSelected
          boolean

          Value of "true" or "false"

        • _userSelected
          object

          Extensions for userSelected

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • valueQuantity
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • value
          number

          A rational number with implicit precision

        • _value
          object

          Extensions for value

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • comparator

          How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

          Possible Values: <, <=, >=, >
        • _comparator
          object

          Extensions for comparator

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • unit
          string

          A sequence of Unicode characters

        • _unit
          object

          Extensions for unit

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • system
          string

          String of characters used to identify a name or a resource

        • _system
          object

          Extensions for system

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • code
          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

        • _code
          object

          Extensions for code

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • valueReference
        object

        The answer (or one of the answers) provided by the respondent to the question.

        Only one of valueBoolean, valueDecimal, valueInteger, valueDate, valueDateTime, valueTime, valueString, valueUri, valueAttachment, valueCoding, valueQuantity, valueReference may be present.

        Must be a resource of type Resource.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • reference
          string

          A sequence of Unicode characters

        • _reference
          object

          Extensions for reference

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • type
          string

          String of characters used to identify a name or a resource

        • _type
          object

          Extensions for type

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • identifier
          object

          An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • use

            The purpose of this identifier.

            Possible Values: usual, official, temp, secondary, old
          • _use
            object

            Extensions for use

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • type
            object

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • coding
              Array of object

              A reference to a code defined by a terminology system.

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • system
                string

                String of characters used to identify a name or a resource

              • _system
                object

                Extensions for system

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • version
                string

                A sequence of Unicode characters

              • _version
                object

                Extensions for version

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • code
                string

                A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

              • _code
                object

                Extensions for code

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • display
                string

                A sequence of Unicode characters

              • _display
                object

                Extensions for display

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              • userSelected
                boolean

                Value of "true" or "false"

              • _userSelected
                object

                Extensions for userSelected

                • id
                  string

                  A sequence of Unicode characters

                • extension
                  Array of object

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  • id
                    string

                    A sequence of Unicode characters

                  • url
                    string

                    String of characters used to identify a name or a resource

                  • valueBase64Binary
                    string

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • text
              string

              A sequence of Unicode characters

            • _text
              object

              Extensions for text

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • system
            string

            String of characters used to identify a name or a resource

          • _system
            object

            Extensions for system

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • value
            string

            A sequence of Unicode characters

          • _value
            object

            Extensions for value

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • period
            object

            Time period during which identifier is/was valid for use.

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • start
              string

              A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

            • _start
              object

              Extensions for start

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • end
              string

              A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

            • _end
              object

              Extensions for end

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • display
          string

          A sequence of Unicode characters

        • _display
          object

          Extensions for display

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).