Skip to main content

Call Intake Basic Resource

Overview​

The Call Intake Basic resource enables FHIR access to myAvatar's Call Intake functionality, supporting the initial patient contact and intake workflow. This resource captures essential information about incoming calls or walk-ins before formal patient admission.

System: https://fhir.netsmartcloud.com/v4/ValueSet/basic-resource-type

Code: callintake

Before implementing, validate Call Intake support in the CapabilityStatement:

GET {base-url}/metadata

Check Basic resource operations and search parameters for call intake support.

Resource Schema​

Call Intake resources use the Basic resource structure with specialized extensions:

Supported CareRecords​

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED----
myAvatarYesYesYesYes
myEvolv----
myUnity----
Referral Manager----

Extensions​

NameCard.Data TypeNotes
Caller1..1ComplexThis includes a code bound to a customizable dictionary configured in myAvatar and may vary by organization.
Date1..1datetime
Disposition1..1codeThis is bound to a customizable dictionary configured in myAvatar and may vary by organization.
Patient Name1..1HumanName
Program1..1codeThis is bound to a customizable dictionary configured in myAvatar and may vary by organization.
Remarks0..1string
Type1..1codeC | W
Call or Walk-In

Sample Payload​

{
  "resourceType": "Basic",
  "id": "P11||CAL66632.001",
  "meta": {
    "lastUpdated": "2023-05-10T14:52:36.789-05:00"
  },
  "extension": [
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-caller",
      "extension": [
        {
          "url": "type",
          "valueCode": "A"
        },
        {
          "url": "name",
          "valueHumanName": [
            {
              "family": "FAMILY",
              "given": [
                "GIVEN"
              ]
            }
          ]
        }
      ]
    },
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-date",
      "valueDateTime": "2023-05-10T11:22:00-05:00"
    },
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-disposition",
      "valueCode": "42"
    },
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-patient-name",
      "valueHumanName": {
        "family": "LAST",
        "given": [
          "FIRST"
        ]
      }
    },
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-program",
      "valueCode": "360"
    },
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-remarks",
      "valueString": "This is free text entered about this call intake.\nIt may include line breaks."
    },
    {
      "url": "https://fhir.netsmartcloud.com/v4/StructureDefinition/callintake-type",
      "valueCode": "C"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.netsmartcloud.com/v4/ValueSet/basic-resource-type",
        "code": "callintake"
      }
    ]
  },
  "subject": {
    "reference": "Patient/P11",
    "type": "Patient"
  }
}

Integration Patterns​

Call Intake Workflow​

  1. Receive Initial Contact

    • Create Basic resource with callintake code
    • Capture caller information and patient details
    • Include program and disposition codes

  2. Process Intake Information

    • Update intake with additional details
    • Link to existing or create new Patient resource
    • Track intake through disposition workflow

  3. Convert to Permanent Patient

Best Practices​

  • Always include required extensions (caller, date, disposition, patient name, program, type)
  • Use appropriate caller type codes (A, B, C, etc.)
  • Include remarks for additional context when needed
  • Link to Patient resource when available

Common Use Cases​

  • Crisis Hotline Calls: Capture immediate contact information and disposition
  • Walk-in Inquiries: Document in-person contacts and referral needs
  • Appointment Scheduling: Initial contact for service requests
  • Information Requests: Track community outreach and information sharing

Relationships to Other Resources​

Error Handling​

For comprehensive error handling information, see Common Errors.

Support​

For technical support with Call Intake resources:

  • Contact: Netsmart Technologies, Inc.
  • CareRecord: myAvatar specific functionality
  • Documentation: Basic Resources