1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. QuestionnaireResponse

Update a questionnaire response

put

/QuestionnaireResponse/{id}

Updates a questionnaire response.

Note:

  • When an item is returned with the is-modifiable extension as false, that item cannot be updated unless the update is passed in without an ID.
  • An update should only be performed directly after a questionnaire response is retrieved. If an item.id is provided from the GET request, it must be provided on the subsequent update and must match the item.id returned from the GET.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : QuestionnaireResponseUpdateBody
Type: object
Show Source
Example:
{
    "resourceType":"QuestionnaireResponse",
    "id":"SH-12508041",
    "questionnaire":"https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041",
    "status":"in-progress",
    "subject":{
        "reference":"Patient/12508041"
    },
    "item":[
        {
            "id":"111",
            "linkId":"93",
            "extension":[
                {
                    "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/note",
                    "valueAnnotation":{
                        "text":"category/group comment"
                    }
                }
            ],
            "item":[
                {
                    "linkId":"93-123",
                    "answer":[
                        {
                            "valueQuantity":{
                                "value":"20",
                                "unit":"year (iso1000)",
                                "system":"http://unitsofmeasure.org",
                                "code":"a"
                            }
                        }
                    ]
                },
                {
                    "linkId":"93-456",
                    "answer":[
                        {
                            "valueString":"Answer text"
                        }
                    ]
                },
                {
                    "linkId":"93-789",
                    "extension":[
                        {
                            "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer",
                            "valueBoolean":true
                        }
                    ],
                    "answer":[
                        {
                            "valueCoding":{
                                "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature",
                                "code":"960439"
                            }
                        },
                        {
                            "valueString":"Other answer text"
                        }
                    ]
                }
            ]
        }
    ]
}
Nested Schema : item
Type: array

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

Show Source
Nested Schema : subject
Type: object

The subject of the questionnaire response. This subject is the patient that the answers apply to, but is not necessarily the source of information.

Show Source
Nested Schema : items
Type: object
Show Source
  • extension

    Additional details about a given questionnaire response group item.

    Note: Notes can only be added, not replaced or deleted.

  • Unique ID for inter-element referencing.

    Note: If an item.id is returned on a read, it must be provided on an update.

    Example: 111
  • item

    Questions nested beneath a group.

  • The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.

    Example: 93
Nested Schema : extension
Type: array

Additional details about a given questionnaire response group item.

Note: Notes can only be added, not replaced or deleted.

Show Source
Nested Schema : item
Type: array

Questions nested beneath a group.

Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : valueAnnotation
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • answer

    The respondent's answer to the question.

    Note: Only answer value types of String, Quantity, and Coding are supported.

  • extension

    Whether the answers come from a list of options.

    Note: Extension must be provided when answering a choice or open choice type of question.

  • The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.

    Example: 93-123
Nested Schema : answer
Type: array

The respondent's answer to the question.

Note: Only answer value types of String, Quantity, and Coding are supported.

Show Source
Nested Schema : extension
Type: array

Whether the answers come from a list of options.

Note: Extension must be provided when answering a choice or open choice type of question.

Show Source
Nested Schema : items
Type: object

Single-valued answer to the question.

Show Source
Nested Schema : valueCoding
Type: object
Show Source
Nested Schema : valueQuantity
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK

Headers

Default Response

An OperationOutcome describing any error that occurred.

Headers
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : issue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : location
Type: array
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top