Basic Resource

Overview

The Basic resource handles concepts not yet defined in FHIR, narrative-only resources that don't map to existing resources, and custom resources not appropriate for inclusion in the FHIR specification. In the General Purpose R4 API, Basic resources enable specialized workflows like call intake management.

Before implementing, validate Basic resource support in the CapabilityStatement:

GET {base-url}/metadata

Check the rest.resource array for Basic resource support and available operations.

Reference: HL7 FHIR R4 Basic

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 Basic

Operations

The General Purpose FHIR R4 Basic resource supports the standard operations of Create, Read, Update, and Search, however, support of the Basic resource types varies by CareRecord.

Search

This resource supports a combination of standard and custom search parameters in addition to the common parameters.

Standard Parameters

Name	Type	Description
code	token	Kind of Resource
patient	reference	The focus of the resource
_id	id	The search parameter _id refers to the logical id of the resource, and can be used when the search context specifies a resource type.

Search Examples

The POST method is recommended as it keeps health information out of the URL.

Production

Search by Code and Extension

curl -X POST https://fhir.netsmartcloud.com/v4/Basic/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "code=callintake%20patient=Patient/P123"

Preview

Search by Date of Birth

curl -X POST https://fhirtest.netsmartcloud.com/v4/Basic/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "code=callintake%20patient=Patient/P123"

Supported Resource Types

Netsmart-defined

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

• Call Intake ("callintake") - myAvatar call intake workflow management

Integration Patterns

Basic Resource Workflow

1. Identify Resource Type

   • Determine appropriate Basic resource code
   • Validate CareRecord support
   • Check required extensions

2. Create/Update Resource

   • Include proper code and extensions
   • Reference related resources (Patient, etc.)
   • Validate against supported profiles

3. Search and Retrieve

   • Use code parameter for resource type filtering
   • Include patient references for context
   • Handle CareRecord-specific variations

Best Practices

• Always include the appropriate code for Basic resource type
• Use extensions to capture specialized data elements
• Reference related resources for proper context
• Validate CareRecord support before implementation

Relationships to Other Resources

• Patient Resource - Subject of Basic resources
• Extensions - Custom data elements
• Patient Assign MRN Operation - Call intake to permanent patient workflow

Error Handling

For comprehensive error handling information, see Common Errors.

Support

For technical support with Basic resources:

• Contact: Netsmart Technologies, Inc.
• Documentation: General Purpose R4 API
• CareRecord Support: Varies by resource type and CareRecord