Tiro.health Form SDK

Tiro.health's Form SDK backend is a set of services that enable you to integrate form response processing into your healthcare information system. It provides a FHIR-based API for

• Retrieving and search Questionnaire resources
• Creating an initial QuestionnaireResponse based on the configuration specified in a Questionnaire resource
• Validating QuestionnaireResponses against the Questionnaire resource
• Generating narrative text based for a QuestionnaireResponse
• Expanding ValueSets for use in Questionnaire items

These FHIR API's are conformant to the SDC Implementation Guide, which is a set of FHIR profiles and extensions that define how to create and manage forms and form responses in healthcare systems.

Form Population Service

This endpoint allows you to create an initial QuestionnaireResponse based on the configuration specified in a Questionnaire resource. It is typically used to pre-fill a form with data from the patient record or other sources.

The service accepts context information to pre-populate fields with data on the subject, encounter or other context related resources.

[!NOTE] The specification for this endpoint is defined in the SDC Implementation Guide. It is a part of the SDC (Structured Data Capture) standard, which is used to create and manage forms and form responses in healthcare applications.

Example context information:

curl -X POST https://{SDC_BACKEND_ADDRESS}/Questionnaire/$populate \
  -H "Content-Type: application/fhir+json" \
  -d '{
    "resourceType": "Parameters",
    "parameter": [{
      "name": "questionnaire",
      "resource": {
        "resourceType": "Questionnaire",
        // ... Questionnaire resource here
      }
    }, {
      "name": "context",
      "part": [
        {
            "name": "name"
            "valueString": "subject"
        },
        {
            "name": "content"
            "resource": {
                "resourceType": "Patient",
                "identifier": [{
                    "system": "http://example.com/mrn",
                    "value": "12345"
                }],
                "name": [{
                    "given": ["John"],
                    "family": "Doe"
                }],
            }

        }
      ]
    }]
  }'

Form Validation Service

This endpoint allows you to validate a QuestionnaireResponse against the Questionnaire resource. It checks if the response is valid according to the rules defined in the Questionnaire, such as required fields, value types, and constraints.

curl -X POST https://{SDC_BACKEND_ADDRESS}/QuestionnaireResponse/$validate \
  -H "Content-Type: application/fhir+json" \
  -d '{
    "resourceType": "QuestionnaireResponse",
    "questionnaire": "https://example.com/Questionnaire/123",
    "status": "in-progress",
    "item": [{
        "linkId": "1",
        "text": "Patient Name",
        "answer": [{
            "valueString": "John Doe"
         }]
        // ... other items here
     }],
    }
  }'

Text Narrative Generation Service

This endpoint allows you to generate a human readable narrative for a QuestionnaireResponse. It follows the configuration specified in the Questionnnaire and the data in the QuestionnaireResponse to create a narrative text that summarizes the information captured in the form.

curl -X POST https://{SDC_BACKEND_ADDRESS}/QuestionnaireResponse/$generate-narrative \
  -H "Content-Type: application/fhir+json" \
  -d '{
    "resourceType": "QuestionnaireResponse",
    "questionnaire": "https://example.com/Questionnaire/123",
    "status": "completed",
    "item": [{
        "linkId": "1",
        "text": "Patient Name",
        "answer": [{
            "valueString": "John Doe"
         }]
        // ... other items here
     }],
    }
  }'