Skip to main content

Schedule

Overview​

The Schedule resource represents containers for time-slots that can be booked for appointments. It defines the window of time and types of appointments that can be scheduled for specific practitioners or resources.

Important: Always validate Schedule resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.

Resource Schema​

The Schedule resource follows the HL7 FHIR R4 Schedule specification.

Key elements include:

  • identifier - External identifiers for the schedule
  • active - Whether the schedule record is in active use
  • serviceCategory - High-level category of service
  • serviceType - Specific service being scheduled
  • specialty - Type of specialty needed
  • actor - Resource(s) that the schedule is providing availability for
  • planningHorizon - Period of time covered by schedule
  • comment - Comments about availability

Example Schedule Resource​

{
  "resourceType": "Schedule",
  "id": "12345",
  "identifier": [{
    "use": "usual",
    "system": "http://hospital.example.org/schedules",
    "value": "SCH-2024-001"
  }],
  "active": true,
  "serviceCategory": [{
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/service-category",
      "code": "17",
      "display": "General Practice"
    }]
  }],
  "serviceType": [{
    "coding": [{
      "system": "http://snomed.info/sct",
      "code": "408443003",
      "display": "General medical practice"
    }]
  }],
  "specialty": [{
    "coding": [{
      "system": "http://snomed.info/sct",
      "code": "394814009",
      "display": "General practice"
    }]
  }],
  "actor": [{
    "reference": "Practitioner/67890",
    "display": "Dr. John Smith"
  }],
  "planningHorizon": {
    "start": "2024-01-15T08:00:00Z",
    "end": "2024-01-15T17:00:00Z"
  },
  "comment": "General practice appointments available Monday through Friday"
}

Supported Profiles​

This API supports the following FHIR profiles:

Operations​

The General Purpose FHIR R4 Schedule resource has limited supported and only supports the search operation using a custom parameter.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED----
myAvatar---Yes
myEvolv----
myUnity----
info

Not all Netsmart solutions support Procedure search. See supported operations table above and consult your target solution's documentation for more information.

This operation retrieves a list of resources by these query parameters.

Standard Parameters​

None supported.

Custom Parameters​

NameTypeDescription
practitionerreferenceREQUIRED The practitioner this schedule is related to

Search Examples​

Via POST​

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

Search by Practitioner
curl -X POST https://fhir.netsmartcloud.com/v4/Schedule/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "practitioner=Practitioner/7619"
Via GET​
Search by Patient
curl -X GET https://fhir.netsmartcloud.com/v4/Schedule?practitioner=Practitioner/7619 \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Special Considerations​

Schedule May Only Be Searched​

This resource only supports searching for Schedules by Practitioner similar to the standard search by actor (e.g., actor=Practitioner/7619). except the Schedules returned by this search cannot be read by id (GET /v4/Schedule/id) or updated (PUT /v4/Schedule/id).

Additionally, Schedules cannot be created using this resource.

Error Handling​

For information about error responses when working with Schedule resources, see Common Errors.

Common Schedule-related errors include:

  • Missing required practitioner reference
  • Invalid service category or type codes
  • Malformed planning horizon dates
  • Attempting unsupported operations (create, read, update)

Integration Patterns​

Appointment Scheduling​

Find available schedules for practitioners:

# Get schedules for practitioner
curl -X GET "https://fhir.netsmartcloud.com/v4/Schedule?practitioner=Practitioner/67890" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Availability Management​

Retrieve scheduling information:

# Search schedules by practitioner
curl -X POST "https://fhir.netsmartcloud.com/v4/Schedule/_search" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "practitioner=Practitioner/67890"

Resource Planning​

Identify scheduling capacity:

# Get active schedules
curl -X GET "https://fhir.netsmartcloud.com/v4/Schedule?practitioner=Practitioner/67890&active=true" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Relationships to Other Resources​

The Schedule resource connects to appointment and provider resources:

Support​

For questions about Schedule resource implementation or appointment scheduling workflows, contact Netsmart support through your designated support channels.