Edit

Share via


FollowupCommunicationInference

Back to overview of RI Inferences

This inference is created when the text indicates that findings or test results were communicated to a medical professional. The kind is followupCommunication. The wasAcknowledged field is set to true or false, depending on whether the communication was verbal. Nonverbal communication might not have reached the recipient yet and, therefore, can't be considered acknowledged. The dateTime field is set if the date and time of the communication are known. The recipient field is set if the recipient(s) are known. See the OpenAPI spec for its possible values.

Example without token extensions:

{
	"kind": "followupCommunication",
	"wasAcknowledged": true,
	"dateTime": [
		"2020-09-05T16:00:00Z"
	],
	"recipient": [
		"doctor"
	]
}

The possible values for recipient are: doctor, nurse, midwife, physician_assistant, and unknown.

Examples Request/Response JSON:

{
      "jobData": {
        "configuration": {
          "inferenceOptions": {
            "followupRecommendationOptions": {
              "includeRecommendationsWithNoSpecifiedModality": false,
              "includeRecommendationsInReferences": false,
              "provideFocusedSentenceEvidence": false
            },
            "findingOptions": {
              "provideFocusedSentenceEvidence": false
            }
          },
          "inferenceTypes": ["followupCommunication"],
          "locale": "en-US",
          "verbose": false,
          "includeEvidence": false
        },
        "patients": [
          {
            "id": "111111",
            "details": {
              "sex": "female",
			  "birthDate" : "1959-11-11T19:00:00+00:00",
              "clinicalInfo": [
                {
                  "resourceType": "Observation",
                  "status": "unknown",
                  "code": {
                    "coding": [
                      {
                        "system": "http://www.nlm.nih.gov/research/umls",
                        "code": "C0018802",
                        "display": "MalignantNeoplasms"
                      }
                    ]
                  },
                  "valueBoolean": "true"
                }
              ]
            },
            "encounters": [
              {
                "id": "encounterid1",
                "period": {
                  "start": "2021-8-28T00:00:00",
                  "end": "2021-8-28T00:00:00"
                },
                "class": "inpatient"
              }
            ],
            "patientDocuments": [
              {
                "type": "note",
                "clinicalType": "radiologyReport",
                "id": "docid1",
                "language": "en",
                "authors": [
                  {
                    "id": "authorid1",
                    "fullName": "authorname1"
                  }
                ],
                "specialtyType": "radiology",
                "createdAt": "2021-8-28T00:00:00",
                "administrativeMetadata": {
                  "orderedProcedures": [
                    {
                      "code": {
                        "coding": [
                          {
                            "system": "https://loinc.org",
                            "code": "36572-6",
                            "display": "XR CHEST AP"
                          }
                        ]
                      },
                      "description": "XR CHEST AP"
                    }
                  ],
                  "encounterId": "encounterid1"
                },
                "content": {
                  "sourceType": "inline",
                  "value" : "\r\n\r\n\r\n\nThe results were faxed to Julie Carter on July 6 2016 at 3 PM.\n\nThe results were sent via Powerscribe to George Brown, PA.\n\n\t\t"
				}
              }
            ]
          }
        ]
      }
    }
{
  "result": {
    "patientResults": [
      {
        "patientId": "111111",
        "inferences": [
          {
            "kind": "followupCommunication",
            "communicatedAt": [
              "2016-07-06T15:00:00"
            ],
            "recipient": [
              "unknown"
            ],
            "wasAcknowledged": false
          },
          {
            "kind": "followupCommunication",
            "recipient": [
              "physicianAssistant"
            ],
            "wasAcknowledged": false
          }
        ]
      }
    ],
    "modelVersion": "2025-03-17"
  },
  "id": "fca108",
  "createdAt": "2025-04-30T09:49:47Z",
  "expiresAt": "2025-05-01T09:49:47Z",
  "updatedAt": "2025-04-30T09:49:50Z",
  "status": "succeeded"
}