Get Doctors OnCall Schedules

  1. User Guide
 

Schedule resources provide 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. The schedule does not provide any information about actual appointments. This separation also greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.

Note: A schedule is not used for the delivery of medication, the Timing data type should be used for that purpose.

 
CareSpan available search parameters Details Search Paramters

Name Field Name Type Value Description Required
service-type service-type - https://www.carespan.clinic/fhir/coding/service-type|on-call types of service to be requested Yes
page_index _getpagesoffset - eg. 0 from start record position. Default is 0 No
Per_page _count - eg. 20 Total Number of records in each requrest No

Sample Request URL

https://test-api.carespan.clinic/R4/Schedule?_getpagesoffset=0&_count=20&service-type=https://www.carespan.clinic/fhir/coding/schedule-type|on-call

Response
        
{
    "resourceType": "Bundle",
    "type": "searchset",
    "entry": [
        {
            "resource": {
                "resourceType": "Schedule",
                "extension": [
                    {
                        "valueInteger": 30,
                        "url": "http://hl7.org/fhir/ValueSet/duration-units"
                    },
                    {
                        "valueString": "m",
                        "url": "http://hl7.org/fhir/ValueSet/units-of-time"
                    }
                ],
                "serviceType": [
                    {
                        "coding": [
                            {
                                "code": "on-call",
                                "display": "On Call",
                                "system": "https://www.carespan.clinic/fhir/coding/service-type"
                            }
                        ]
                    }
                ],
                "actor": [
                    {
                        "reference": "Practitioner/GLV5Z14OI3",
                        "display": "John Echaveria"
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}