questionnaire-json-description 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. {
  2. "resourceType" : "Questionnaire",
  3. // from Resource: id, meta, implicitRules, and language
  4. // from DomainResource: text, contained, extension, and modifierExtension
  5. "url" : "<uri>", // Canonical identifier for this questionnaire, represented as a URI (globally unique)
  6. "identifier" : [{ Identifier }], // Additional identifier for the questionnaire
  7. "version" : "<string>", // Business version of the questionnaire
  8. "name" : "<string>", // C? Name for this questionnaire (computer friendly)
  9. "title" : "<string>", // Name for this questionnaire (human friendly)
  10. "derivedFrom" : [{ canonical(Questionnaire) }], // Instantiates protocol or definition
  11. "status" : "<code>", // R! draft | active | retired | unknown
  12. "experimental" : <boolean>, // For testing purposes, not real usage
  13. "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse
  14. "date" : "<dateTime>", // Date last changed
  15. "publisher" : "<string>", // Name of the publisher (organization or individual)
  16. "contact" : [{ ContactDetail }], // Contact details for the publisher
  17. "description" : "<markdown>", // Natural language description of the questionnaire
  18. "useContext" : [{ UsageContext }], // The context that the content is intended to support
  19. "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for questionnaire (if applicable)
  20. "purpose" : "<markdown>", // Why this questionnaire is defined
  21. "copyright" : "<markdown>", // Use and/or publishing restrictions
  22. "approvalDate" : "<date>", // When the questionnaire was approved by publisher
  23. "lastReviewDate" : "<date>", // When the questionnaire was last reviewed
  24. "effectivePeriod" : { Period }, // When the questionnaire is expected to be used
  25. "code" : [{ Coding }], // Concept that represents the overall questionnaire
  26. "item" : [{ // C? Questions and sections within the Questionnaire
  27. "linkId" : "<string>", // R! Unique id for item in questionnaire
  28. "definition" : "<uri>", // ElementDefinition - details for the item
  29. "code" : [{ Coding }], // C? Corresponding concept for this item in a terminology
  30. "prefix" : "<string>", // E.g. "1(a)", "2.5.3"
  31. "text" : "<string>", // Primary text for the item
  32. "type" : "<code>", // R! group | display | boolean | decimal | integer | date | dateTime +
  33. "enableWhen" : [{ // Only allow data when
  34. "question" : "<string>", // R! Question that determines whether item is enabled
  35. "operator" : "<code>", // R! exists | = | != | > | < | >= | <=
  36. // answer[x]: Value for question comparison based on operator. One of these 10:
  37. "answerBoolean" : <boolean>
  38. "answerDecimal" : <decimal>
  39. "answerInteger" : <integer>
  40. "answerDate" : "<date>"
  41. "answerDateTime" : "<dateTime>"
  42. "answerTime" : "<time>"
  43. "answerString" : "<string>"
  44. "answerCoding" : { Coding }
  45. "answerQuantity" : { Quantity }
  46. "answerReference" : { Reference(Any) }
  47. }],
  48. "enableBehavior" : "<code>", // C? all | any
  49. "required" : <boolean>, // C? Whether the item must be included in data results
  50. "repeats" : <boolean>, // C? Whether the item may repeat
  51. "readOnly" : <boolean>, // C? Don't allow human editing
  52. "maxLength" : <integer>, // C? No more than this many characters
  53. "answerValueSet" : { canonical(ValueSet) }, // C? Valueset containing permitted answers
  54. "answerOption" : [{ // C? Permitted answer
  55. // value[x]: Answer value. One of these 6:
  56. "valueInteger" : <integer>,
  57. "valueDate" : "<date>",
  58. "valueTime" : "<time>",
  59. "valueString" : "<string>",
  60. "valueCoding" : { Coding },
  61. "valueReference" : { Reference(Any) },
  62. "initialSelected" : <boolean> // Whether option is selected by default
  63. }],
  64. "initial" : [{ // C? Initial value(s) when item is first rendered
  65. // value[x]: Actual value for initializing the question. One of these 12:
  66. "valueBoolean" : <boolean>
  67. "valueDecimal" : <decimal>
  68. "valueInteger" : <integer>
  69. "valueDate" : "<date>"
  70. "valueDateTime" : "<dateTime>"
  71. "valueTime" : "<time>"
  72. "valueString" : "<string>"
  73. "valueUri" : "<uri>"
  74. "valueAttachment" : { Attachment }
  75. "valueCoding" : { Coding }
  76. "valueQuantity" : { Quantity }
  77. "valueReference" : { Reference(Any) }
  78. }],
  79. "item" : [{ Content as for Questionnaire.item }] // C? Nested questionnaire items
  80. }]
  81. }