Skip to navigation

Result format

Every field of a result, and the FHIR extensions on a QuestionnaireResponse

GET /v1/jobs/{id}/result returns one of two shapes, told apart by type. The API reference has the full JSON Schema of each; this page explains what the fields mean.

Questionnaire result

{
"id": "job_8f2c1d0e9b7a6c5d4e3f2a1b",
"type": "questionnaire",
"questionnaire_response": { "resourceType": "QuestionnaireResponse", "...": "..." },
"stats": { "...": "..." },
"pipeline_version": "2026.10.12-1"
}
FieldMeaning
idThe job id
typequestionnaire
questionnaire_responseA FHIR R4 QuestionnaireResponse answering your Questionnaire; see below
statsCounts for the fill; see Stats
pipeline_versionThe API release that produced the result

The QuestionnaireResponse

ElementContent
resourceTypeQuestionnaireResponse
statuscompleted, or in-progress when a required item is unanswered (stats.required_missing lists them)
authoredWhen the response was produced (UTC)
questionnaireYour Questionnaire’s url, when it has one
itemOne node per answered item, nested as in your Questionnaire. Each node has the item’s linkId and text, its answer list, and its answered children in item. Items without an answer, and groups with no answered item inside, are left out

A repeating item holds one answer per value. A repeating group occurs once per entry: several sibling nodes that share the group’s linkId.

Each answer’s value[x] follows the item’s type:

Item typeAnswer
choice, coding, open-choice, or any item with answerOptionsThe chosen option as given in your Questionnaire: valueCoding with its system, code and display, or the option’s own valueString, valueInteger, valueDate or valueTime
Open items (open-choice, answerConstraint optionsOrString) when no option fitsvalueString: the value as the document states it
answerConstraint optionsOrType when no option fitsA value of the item’s type; for a coded item, a valueCoding with a display only, never an invented code
quantityvalueQuantity: value, plus unit, system and code from the item’s questionnaire-unit extension
string, textvalueString
decimal, integervalueDecimal, valueInteger
booleanvalueBoolean
date, dateTime, timevalueDate, valueDateTime, valueTime
urlvalueUri

Extensions

Answers carry emtelligent extensions alongside their value:

{
"valueCoding": { "system": "http://loinc.org", "code": "LA6560-2", "display": "Oriented" },
"extension": [
{ "url": "https://emtelligent.com/fhir/StructureDefinition/answer-confidence",
"valueDecimal": 0.9 },
{ "url": "https://emtelligent.com/fhir/StructureDefinition/answer-evidence",
"valueString": "A/O x3" }
]
}
Extension urlValuePresent onMeaning
https://emtelligent.com/fhir/StructureDefinition/answer-confidencevalueDecimal, 0 to 1Answers taken from the document, and calculated answersThe service’s estimate of how well the document supports the answer; see Confidence. On a calculated answer, the lowest confidence of the answers it was calculated from
https://emtelligent.com/fhir/StructureDefinition/answer-evidencevalueStringEvery answer taken from the documentThe verbatim quote the answer was taken from, without offsets; see Evidence
https://emtelligent.com/fhir/StructureDefinition/answer-derivationvalueCode: calculated or impliedAnswers the service derived, instead of answer-evidencecalculated: a score your form defines as a sum of option weights, calculated from the answers chosen. implied: a yes/no control implied by an answered item it gates. See Answers the service derives

Each extension appears at most once on an answer, and only on QuestionnaireResponse.item.answer. Software that does not know them can ignore them: the answers are complete without them.

Questions result

{
"id": "job_8f2c1d0e9b7a6c5d4e3f2a1b",
"type": "questions",
"answers": [ { "...": "..." } ],
"stats": { "...": "..." },
"pipeline_version": "2026.10.12-1"
}

answers holds one object per question, in the order you asked them:

FieldMeaning
idYour question’s id; where you gave none, q1, q2, … by its position
questionThe question text
typetext, number, boolean, date or choice
statusanswered, not_found or unmatched_option; see Questions
answerThe typed answer; null when not found. For a multiple question, a list of {answer, confidence, evidence} objects, one per value ([] when not found)
confidence0 to 1, when answered
evidence{quote, spans} when answered: the verbatim quote and where it occurs in document.text; see Evidence

Stats

Both result types carry the same stats:

FieldMeaning
answerableItems or questions that can hold an answer (not groups or display items)
answeredItems or questions that received at least one answer
answer_valuesTotal answers; a repeating item or multiple question may hold several
unmatched_optionCoded answers dropped because they matched none of your options
suppressedAnswers dropped because your form’s enableWhen logic disables the item
evidence_locatedAnswers whose evidence quote was found in the document
required_missinglinkIds of required items your form logic enables that the document does not answer. Always [] for a questions result
ungroundedFree-text answers dropped because the document does not support them