NAV
Ruby Shell

QuestionnaireResponse API v1

The Oracle Health Data Intelligence QuestionnaireResponse API allows systems to interact with questionnaire data in Health Data Intelligence.

Notes:

URL: https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1

QuestionnaireResponse

The QuestionnaireResponse resource provides a complete or partial list of answers to a set of questions filled when responding to a questionnaire. Questionnaire responses cover the need to communicate data from forms used in medical history examinations, research questionnaires, and sometimes full clinical specialty records.

Retrieve a Single Questionnaire Response

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/questionnaire-responses/9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/questionnaire-responses/9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "e6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d56",
  "code": {
    "codings": [
      {
        "code": "709952182",
        "system": "urn:cerner:coding:codingsystem:codeset:4002172",
        "display": "Exercise"
      },
      {
        "code": "256235009",
        "system": "2.16.840.1.113883.6.96",
        "display": "Exercise"
      }
    ],
    "text": "Exercise"
  },
  "status": {
    "codings": [
      {
        "code": "709952182",
        "system": "urn:cerner:coding:codingsystem:codeset:4002172",
        "display": "Exercise"
      },
      {
        "code": "256235009",
        "system": "2.16.840.1.113883.6.96",
        "display": "Exercise"
      }
    ],
    "text": "Exercise"
  },
  "encounter": {
    "id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
  },
  "authored": "2013-03-21T15:30:00Z",
  "author": {
    "patient": {
      "id": "1825933"
    },
    "provider": {
      "aliases": [
        {
          "type": "DEA"
        }
      ],
      "name": {
        "prefix": "Dr.",
        "given": [
          "Jane",
          "Susannah"
        ],
        "family": [
          "Smith"
        ],
        "suffix": "MD.",
        "formatted": "Dr. Jane Susannah Smith MD."
      }
    }
  },
  "items": [
    {
      "code": {
        "codings": [
          {
            "code": "709952182",
            "system": "urn:cerner:coding:codingsystem:codeset:4002172",
            "display": "Exercise"
          },
          {
            "code": "256235009",
            "system": "2.16.840.1.113883.6.96",
            "display": "Exercise"
          }
        ],
        "text": "Exercise"
      },
      "text": "Exercise Type",
      "type": "question",
      "answers": [
        {
          "valueQuantity": {
            "unit": {
              "codings": [
                {
                  "code": "709952182",
                  "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                  "display": "Exercise"
                },
                {
                  "code": "256235009",
                  "system": "2.16.840.1.113883.6.96",
                  "display": "Exercise"
                }
              ],
              "text": "Exercise"
            },
            "value": "120"
          },
          "valueDateTime": "2013-03-21T15:30:00Z",
          "valueString": "Once a day",
          "valueCodeableConcept": {
            "codings": [
              {
                "code": "709952182",
                "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                "display": "Exercise"
              },
              {
                "code": "256235009",
                "system": "2.16.840.1.113883.6.96",
                "display": "Exercise"
              }
            ],
            "text": "Exercise"
          }
        }
      ],
      "items": {
        "code": {
          "codings": [
            {
              "code": "709952182",
              "system": "urn:cerner:coding:codingsystem:codeset:4002172",
              "display": "Exercise"
            },
            {
              "code": "256235009",
              "system": "2.16.840.1.113883.6.96",
              "display": "Exercise"
            }
          ],
          "text": "Exercise"
        },
        "text": "Exercise Type",
        "type": "question",
        "answers": [
          {
            "valueQuantity": {
              "unit": {
                "codings": [
                  {
                    "code": "709952182",
                    "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                    "display": "Exercise"
                  },
                  {
                    "code": "256235009",
                    "system": "2.16.840.1.113883.6.96",
                    "display": "Exercise"
                  }
                ],
                "text": "Exercise"
              },
              "value": "120"
            },
            "valueDateTime": "2013-03-21T15:30:00Z",
            "valueString": "Once a day",
            "valueCodeableConcept": {
              "codings": [
                {
                  "code": "709952182",
                  "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                  "display": "Exercise"
                },
                {
                  "code": "256235009",
                  "system": "2.16.840.1.113883.6.96",
                  "display": "Exercise"
                }
              ],
              "text": "Exercise"
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "standardizedDataPartitionId": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
  }
}

GET /populations/{populationId}/patients/{patientId}/questionnaire-responses/{questionnaireResponseId}

Retrieves a single questionnaire response for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The ID of the patient who is the subject of the questionnaire response. -
populationId path string true N/A The ID of the population containing the patient who is the subject of the questionnaire response. -
questionnaireResponseId path string true N/A The ID that uniquely identifies the questionnaire response for the patient. -

Response Statuses

Status Meaning Description Schema
200 OK OK QuestionnaireResponse
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Retrieve a List of Questionnaire Responses

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/questionnaire-responses', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/questionnaire-responses \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "e6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d56",
      "code": {
        "codings": [
          {
            "code": "709952182",
            "system": "urn:cerner:coding:codingsystem:codeset:4002172",
            "display": "Exercise"
          },
          {
            "code": "256235009",
            "system": "2.16.840.1.113883.6.96",
            "display": "Exercise"
          }
        ],
        "text": "Exercise"
      },
      "status": {
        "codings": [
          {
            "code": "709952182",
            "system": "urn:cerner:coding:codingsystem:codeset:4002172",
            "display": "Exercise"
          },
          {
            "code": "256235009",
            "system": "2.16.840.1.113883.6.96",
            "display": "Exercise"
          }
        ],
        "text": "Exercise"
      },
      "encounter": {
        "id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
      },
      "authored": "2013-03-21T15:30:00Z",
      "author": {
        "patient": {
          "id": "1825933"
        },
        "provider": {
          "aliases": [
            {
              "type": "DEA"
            }
          ],
          "name": {
            "prefix": "Dr.",
            "given": [
              "Jane",
              "Susannah"
            ],
            "family": [
              "Smith"
            ],
            "suffix": "MD.",
            "formatted": "Dr. Jane Susannah Smith MD."
          }
        }
      },
      "items": [
        {
          "code": {
            "codings": [
              {
                "code": "709952182",
                "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                "display": "Exercise"
              },
              {
                "code": "256235009",
                "system": "2.16.840.1.113883.6.96",
                "display": "Exercise"
              }
            ],
            "text": "Exercise"
          },
          "text": "Exercise Type",
          "type": "question",
          "answers": [
            {
              "valueQuantity": {
                "unit": {
                  "codings": [
                    {
                      "code": "709952182",
                      "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                      "display": "Exercise"
                    },
                    {
                      "code": "256235009",
                      "system": "2.16.840.1.113883.6.96",
                      "display": "Exercise"
                    }
                  ],
                  "text": "Exercise"
                },
                "value": "120"
              },
              "valueDateTime": "2013-03-21T15:30:00Z",
              "valueString": "Once a day",
              "valueCodeableConcept": {
                "codings": [
                  {
                    "code": "709952182",
                    "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                    "display": "Exercise"
                  },
                  {
                    "code": "256235009",
                    "system": "2.16.840.1.113883.6.96",
                    "display": "Exercise"
                  }
                ],
                "text": "Exercise"
              }
            }
          ],
          "items": {
            "code": {
              "codings": [
                {
                  "code": "709952182",
                  "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                  "display": "Exercise"
                },
                {
                  "code": "256235009",
                  "system": "2.16.840.1.113883.6.96",
                  "display": "Exercise"
                }
              ],
              "text": "Exercise"
            },
            "text": "Exercise Type",
            "type": "question",
            "answers": [
              {
                "valueQuantity": {
                  "unit": {
                    "codings": [
                      {
                        "code": "709952182",
                        "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                        "display": "Exercise"
                      },
                      {
                        "code": "256235009",
                        "system": "2.16.840.1.113883.6.96",
                        "display": "Exercise"
                      }
                    ],
                    "text": "Exercise"
                  },
                  "value": "120"
                },
                "valueDateTime": "2013-03-21T15:30:00Z",
                "valueString": "Once a day",
                "valueCodeableConcept": {
                  "codings": [
                    {
                      "code": "709952182",
                      "system": "urn:cerner:coding:codingsystem:codeset:4002172",
                      "display": "Exercise"
                    },
                    {
                      "code": "256235009",
                      "system": "2.16.840.1.113883.6.96",
                      "display": "Exercise"
                    }
                  ],
                  "text": "Exercise"
                }
              }
            ]
          }
        }
      ],
      "meta": {
        "standardizedDataPartitionId": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
      }
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/questionnaire-responses?limit=20",
  "nextLink": "https://cernerdemo.api.us-1.healtheintent.com/questionnaire-response/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/questionnaire-responses?cursor=e6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d56&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/questionnaire-responses

Retrieves a list of the questionnaire responses for a given patient. The default sort order is descending by author.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The ID of the patient who is the subject of the questionnaire response. -
populationId path string true N/A The ID of the population containing the patient who is the subject of the questionnaire response. -
cursor query string false N/A The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK QuestionnaireResponses
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Schema Definitions

QuestionnaireResponse

Name Type Required Description Accepted Values
id string true The ID of the QuestionnaireResponse resource. -
code CodeableConcept false The concept that best represents the overall representation of the questionnaire. -
status CodeableConcept false The current status of the questionnaire (for example, in-progress, completed, amended, entered-in-error, or stopped). -
encounter Encounter false The encounter during which this questionnaire response was created or to which the creation of this record is associated. -
authored string false The date and time that the QuestionnaireResponse was last updated. The value adheres to the ISO-8601 international standard using the Extended Date/Time format, can vary in precision between YYYY and YYYY-MM-DDThh:mm:ss.SSSZ, and is in UTC when a time component is present. -
author Author false The individual who received and recorded the response answers. -
items [QuestionnaireResponseItem] false A group or question item from the original questionnaire for which answers are provided. -
meta Meta false The metadata about the resource -

CodeableConcept

Name Type Required Description Accepted Values
codings [Coding] false A list of codings representing the concept. -
text string false A localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

Coding

Name Type Required Description Accepted Values
code string true A symbol in syntax defined by the coding system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (for example, post-coordination). -
display string false A human-readable representation of the code. -
system string true The identifier of the coding system that gives meaning to the code. -

Encounter

Name Type Required Description Accepted Values
id string true The ID of the referenced Encounter resource. -

Author

Name Type Required Description Accepted Values
patient PatientReference false Valued when the author is a patient. -
provider Provider false Valued when the author is a human practitioner. -

PatientReference

Name Type Required Description Accepted Values
id string true The ID of the referenced Patient resource. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. -
name ProviderName false The attributes of the provider name. -

ProviderAlias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -
type string true The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
given [string] true A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. -
family [string] true A list of family (last) name portions of the person’s name. Some people have multiple family names. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
formatted string false The person’s fully-formatted name. -

QuestionnaireResponseItem

Name Type Required Description Accepted Values
code CodeableConcept false The concept that best represents the overall representation of the question or question group. -
text string false The primary text (display) of the group or question. -
type string true Indicates the type of the item (group or question). -
answers [QuestionnaireResponseItemAnswer] false The responses to the question. Only can be valued when the type is question. -
items [QuestionnaireResponseItem] false The nested items (nested questions or nested groups). Only can be valued when the type is group. -

QuestionnaireResponseItemAnswer

Name Type Required Description Accepted Values
valueQuantity Quantity false Valued when the answer is a numeric quantity value with an optional unit. -
valueDateTime string false Valued when the answer is a date and time value. The value adheres to the ISO-8601 international standard using the Extended Date/Time format, can vary in precision between YYYY and YYYY-MM-DDThh:mm:ss.SSSZ, and is in UTC when a time component is present. -
valueString string false Valued when the answer is a textual value. -
valueCodeableConcept CodeableConcept false Valued when the answer is a codeable concept. -

Quantity

Name Type Required Description Accepted Values
unit CodeableConcept false The unit of measure applicable to the quantity numeric value. -
value string true The numeric value of the quantity. -

Meta

Name Type Required Description Accepted Values
standardizedDataPartitionId string false The data partition containing the standardized record that this resource represents. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

QuestionnaireResponses

Name Type Required Description Accepted Values
items [QuestionnaireResponse] true [QuestionnaireResponse model] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -
Ruby Shell