Forms

GET Get a Questionnaire record

GET /Questionnaire/{questionnaireId}

Gets the Questionnaire for the given Questionnaire Id

Parameters

• questionnaireId (path, string, required)
• Access-Token (header, string) Salesforce org access token
  Example: Bearer asvg473tebdjebdsakl!jsjndkcmldcmdcmedj3o9.asd.
• Instance-Domain-Name (header, string) Instance domain name of the salesforce org
  Example: orgid.salesforce.com.

Responses

• 200

  Media type: application/fhir+json. Schema: Questionnaire.

  Example

  {
    "resourceType" : "Questionnaire",
    "id" : "3141",
    "text" : {
      "status" : "generated",
      "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      \n      <pre>\n            1.Comorbidity?\n              1.1 Cardial Comorbidity\n                1.1.1 Angina?\n                1.1.2 MI?\n              1.2 Vascular Comorbidity?\n              ...\n            Histopathology\n              Abdominal\n                pT category?\n              ...\n          </pre>\n    \n    </div>"
    },
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    }],
    "url" : "http://hl7.org/fhir/Questionnaire/3141",
    "identifier" : [{
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.20.2"
    }],
    "name" : "CancerQualityForumQuestionnaire2012",
    "title" : "Cancer Quality Forum Questionnaire 2012",
    "status" : "draft",
    "subjectType" : ["Patient"],
    "date" : "2012-01",
    "publisher" : "HL7 International / FHIR Infrastructure",
    "contact" : [{
      "telecom" : [{
        "system" : "url",
        "value" : "http://www.hl7.org/Special/committees/fiwg"
      }]
    }],
    "description" : "Cancer Quality Forum Questionnaire 2012",
    "item" : [{
      "linkId" : "1",
      "code" : [{
        "system" : "http://example.org/system/code/sections",
        "code" : "COMORBIDITY"
      }],
      "type" : "group",
      "item" : [{
        "linkId" : "1.1",
        "code" : [{
          "system" : "http://example.org/system/code/questions",
          "code" : "COMORB"
        }],
        "prefix" : "1",
        "type" : "coding",
        "answerValueSet" : "http://hl7.org/fhir/ValueSet/yesnodontknow",
        "item" : [{
          "linkId" : "1.1.1",
          "code" : [{
            "system" : "http://example.org/system/code/sections",
            "code" : "CARDIAL"
          }],
          "type" : "group",
          "enableWhen" : [{
            "question" : "1.1",
            "operator" : "=",
            "answerCoding" : {
              "system" : "http://terminology.hl7.org/CodeSystem/v2-0136",
              "code" : "Y"
            }
          }],
          "item" : [{
            "linkId" : "1.1.1.1",
            "code" : [{
              "system" : "http://example.org/system/code/questions",
              "code" : "COMORBCAR"
            }],
            "prefix" : "1.1",
            "type" : "coding",
            "answerValueSet" : "http://hl7.org/fhir/ValueSet/yesnodontknow",
            "item" : [{
              "linkId" : "1.1.1.1.1",
              "code" : [{
                "system" : "http://example.org/system/code/questions",
                "code" : "COMCAR00",
                "display" : "Angina Pectoris"
              },
              {
                "system" : "http://snomed.info/sct",
                "code" : "194828000",
                "display" : "Angina (disorder)"
              }],
              "prefix" : "1.1.1",
              "type" : "coding",
              "answerValueSet" : "http://hl7.org/fhir/ValueSet/yesnodontknow"
            },
            {
              "linkId" : "1.1.1.1.2",
              "code" : [{
                "system" : "http://snomed.info/sct",
                "code" : "22298006",
                "display" : "Myocardial infarction (disorder)"
              }],
              "prefix" : "1.1.2",
              "type" : "coding",
              "answerValueSet" : "http://hl7.org/fhir/ValueSet/yesnodontknow"
            }]
          },
          {
            "linkId" : "1.1.1.2",
            "code" : [{
              "system" : "http://example.org/system/code/questions",
              "code" : "COMORBVAS"
            }],
            "prefix" : "1.2",
            "type" : "coding",
            "answerValueSet" : "http://hl7.org/fhir/ValueSet/yesnodontknow"
          }]
        }]
      }]
    },
    {
      "linkId" : "2",
      "code" : [{
        "system" : "http://example.org/system/code/sections",
        "code" : "HISTOPATHOLOGY"
      }],
      "type" : "group",
      "item" : [{
        "linkId" : "2.1",
        "code" : [{
          "system" : "http://example.org/system/code/sections",
          "code" : "ABDOMINAL"
        }],
        "type" : "group",
        "item" : [{
          "linkId" : "2.1.2",
          "code" : [{
            "system" : "http://example.org/system/code/questions",
            "code" : "STADPT",
            "display" : "pT category"
          }],
          "type" : "coding"
        }]
      }]
    }]
  }

• 404

  Media type: application/json. Schema: object.

  • issue (array of object, required)
    • severity (string, required) Severity of the issue. Options are fatal, error, warning, information, success.
      Allowed values: fatal, error, warning, information, success.
    • code (string, required) Error or warning code.
    • details (object) Additional details about the error.
      • coding (array of object) Code defined by a terminology system.
        • system (string) Code system for this code.
        • version (string) Version of the system - if relevant
        • code (string) Code for what is being represented.
        • display (string) A short, human-readable label to display. REQUIRED for Override Reasons provided by the CDS Service, OPTIONAL for Topic.
        • userSelected (boolean) Whether this coding was chosen directly by the user.
      • text (string) Plain text representation of the concept.
    • diagnostics (string) Additional diagnostic information about the issue.
    • location (array of string) Path of element(s) related to the issue.
    • expression (array of string) FHIRPath of element(s) related to the issue.

  Example

  resourceType: OperationOutcome
  issue:
    -
      severity: error
      code: code-invalid
      details:
        text: Unknown resource.

• 500

  Media type: application/json. Schema: object.

  • issue (array of object, required)
    • severity (string, required) Severity of the issue. Options are fatal, error, warning, information, success.
      Allowed values: fatal, error, warning, information, success.
    • code (string, required) Error or warning code.
    • details (object) Additional details about the error.
      • coding (array of object) Code defined by a terminology system.
        • system (string) Code system for this code.
        • version (string) Version of the system - if relevant
        • code (string) Code for what is being represented.
        • display (string) A short, human-readable label to display. REQUIRED for Override Reasons provided by the CDS Service, OPTIONAL for Topic.
        • userSelected (boolean) Whether this coding was chosen directly by the user.
      • text (string) Plain text representation of the concept.
    • diagnostics (string) Additional diagnostic information about the issue.
    • location (array of string) Path of element(s) related to the issue.
    • expression (array of string) FHIRPath of element(s) related to the issue.

  Example

  resourceType: OperationOutcome
  issue:
    -
      severity: error
      code: code-invalid
      details:
        text: Unknown resource.