R4 Schedule

The Schedule resource provides a "container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked." (HL7 FHIR R4 Schedule)

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 RelatedPerson

Operations

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

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	-	-	-
myAvatar	-	-	-	Yes
myEvolv	-	-	-	-
myUnity	-	-	-	-

Search

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

Name	Type	Description
practitioner	reference	REQUIRED 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.

Production

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"

Preview

Search by Practitioner

curl -X POST https://fhirtest.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

Production

Search by Patient

curl -X GET https://fhir.netsmartcloud.com/v4/Schedule?practitioner=Practitioner/7619 \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Preview

Search by Patient

curl -X GET https://fhirtest.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.