Skip to main content

Resources

Overview​

The General Purpose FHIR STU3 endpoint supports multiple FHIR resources for healthcare data exchange. Each resource provides standardized access to clinical and administrative data through RESTful operations.

Purpose: Enable secure access to FHIR STU3 resources for healthcare applications and integrations.

Use Cases:

  • Clinical data retrieval and updates
  • Patient information management
  • Healthcare workflow integration
  • Administrative data access

Relationships: Resources are interconnected through FHIR references, enabling comprehensive healthcare data modeling.

Resource Schema​

All resources follow FHIR STU3 specifications with common elements:

{
  "resourceType": "[ResourceType]",
  "id": "unique-identifier",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-05-01T10:00:00Z"
  },
  "text": {
    "status": "generated",
    "div": "<div>Human readable content</div>"
  }
}

Key Fields:

  • resourceType: FHIR resource type identifier
  • id: Unique resource identifier
  • meta: Metadata including version and last updated timestamp
  • text: Human-readable narrative

Supported Headers:

HeaderDirectionDescription
AuthorizationRequestRequired. Bearer token for request authorization
Content-TypeRequest & ResponseFormat preference. Default: application/fhir+xml;charset=UTF-8
X-Correlation-IdResponseRequester's transaction ID when not accepted for logging
X-Request-IDRequest & ResponseUnique transaction ID for logging (typically UUID)

Content-Type Support:

JSONXML
application/fhir+jsonapplication/fhir+xml
application/jsonapplication/xml

Operations​

Supported operations vary by resource. Consult resource-specific documentation for availability.

Read​

Retrieve a specific resource by ID.

Query resources using FHIR search parameters.

Common Search Parameters:

NameTypeDescription
pagestringPage index (one-based). Default: 1
_countspecialResults per page. Default: 100. Max: 500
_sortspecialSort specification

Create​

Create new resource instances.

Update​

Update existing resources by ID.

Examples​

Read Operation​

curl -X GET https://fhir.netsmartcloud.com/fhir/{Resource}/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Search Operation (POST - Recommended)​

curl -X POST https://fhir.netsmartcloud.com/fhir/{Resource}/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "parameter=value&_count=10"

Create Operation​

curl -X POST https://fhir.netsmartcloud.com/fhir/{Resource} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/fhir+json" \
    -d @resource.json

Update Operation​

curl -X PUT https://fhir.netsmartcloud.com/fhir/{Resource}/{id} \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/fhir+json" \
    -d @resource.json

Integration Patterns​

Common Workflows:

  • Resource retrieval for clinical decision support
  • Bulk data operations for reporting and analytics
  • Real-time updates for care coordination
  • Cross-resource queries using references

Related Resources: Resources are interconnected through FHIR references enabling comprehensive data access patterns.

Error Handling​

Common HTTP status codes and error responses are handled according to FHIR specifications. Consult resource-specific documentation for detailed error scenarios.

Supported Profiles​

Profile support varies by resource and is defined in the CapabilityStatement. Retrieve the current CapabilityStatement to verify supported profiles:

curl -X GET https://fhir.netsmartcloud.com/fhir/metadata \
    -H "Accept: application/fhir+json"