Appointments APIs
The following FHIR resources are used in Appointment APIs
Get Dayview Appointments by Date
GET /provider/appointments/dayview?date
Retrieve all appointments of the current provider for a specific day.
Query Parameter
- date: The date for which to retieve list of the appointments for it (e.g.,
/provider/appointments/dayview?date=2024-08-28).
Response
Success Response
- 200 OK: The request was successful and the Bundle is returned.
- 400 Bad Request: The request parameters were invalid.
- 401 Unauthorized: The user does not have valid authentication credentials.
- 500 Internal Server Error: An unexpected error occurred on the server
Overview
Retrieves a FHIR Bundle containing a collection of Appointment related to a specific context or criteria. This API endpoint allows clients to fetch a structured collection of FHIR resources packaged together in a Bundle format.
Response Example
{
"resourceType": "Bundle",
"id": "bundle-appointments",
"type": "searchset",
"timestamp": "2024-10-22T04:37:37.2565278+00:00",
"total": 30,
"link": [
{
"relation": "self",
"url": "https://localhost:5190/fhir/Appointment?date=2024-10-29"
}
],
"entry": [
{
"fullUrl": "https://localhost:5190/fhir/Appointment/XHPBHCYM12VCNQIUDRBWWIK1CORCJQHL",
"resource": {
"resourceType": "Appointment",
"id": "XHPBHCYM12VCNQIUDRBWWIK1CORCJQHL",
"meta": {
"tag": [
{
"system": "https://intrahealth.com/appointmentId",
"code": "108"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">https://localhost:5190/fhir/Appointment/XHPBHCYM12VCNQIUDRBWWIK1CORCJQHL</div>"
},
"extension": [
{
"url": "IsGroupAppointment",
"valueBoolean": true
}
],
"status": "arrived",
"appointmentType": {
"coding": [
{
"system": "https://intrahealth.com/CodeSystem/appointment-mode",
"code": "3",
"display": "PHONE-CONSULT"
},
{
"system": "https://intrahealth.com/CodeSystem/appointment-type",
"code": "TRAVELIMM",
"display": "Travel Immunization"
}
]
},
"reasonCode": [
{
"text": "INJECTION, INTRA-ARTICULAR - HIPPP"
}
],
"start": "2024-10-29T12:15:00-07:00",
"end": "2024-10-29T12:30:00-07:00",
"minutesDuration": 15,
"created": "2024-10-15T22:58:29.347+00:00",
"participant": [
{
"actor": {
"extension": [
{
"url": "https://intrahealth.com/appointmentLocation",
"valueString": ""
}
],
"reference": "Location/3"
},
"status": "accepted"
},
{
"actor": {
"reference": "Patient/4",
"type": "Patient",
"display": "Test, Intrahealth 2"
},
"status": "accepted",
"period": {
"start": "2024-10-15T16:11:13-07:00"
}
}
]
},
"search": {
"mode": "match",
"score": 1
}
},
{
"fullUrl": "https://localhost:5190/fhir/Appointment/J9Y5JFOUN2QPTFOVFAPMXOUE6W06IHBU",
"resource": {
"resourceType": "Appointment",
"id": "J9Y5JFOUN2QPTFOVFAPMXOUE6W06IHBU",
"meta": {
"tag": [
{
"system": "https://intrahealth.com/appointmentId",
"code": "121"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">https://localhost:5190/fhir/Appointment/J9Y5JFOUN2QPTFOVFAPMXOUE6W06IHBU</div>"
},
"extension": [
{
"url": "IsGroupAppointment",
"valueBoolean": true
}
],
"status": "booked",
"appointmentType": {
"coding": [
{
"system": "https://intrahealth.com/CodeSystem/appointment-mode",
"code": "3",
"display": "PHONE-CONSULT"
},
{
"system": "https://intrahealth.com/CodeSystem/appointment-type",
"code": "TRAVELIMM",
"display": "Travel Immunization"
}
]
},
"reasonCode": [
{
"text": "INJECTION, INTRA-ARTICULAR - HIPPP"
}
],
"start": "2024-10-29T12:15:00-07:00",
"end": "2024-10-29T12:30:00-07:00",
"minutesDuration": 15,
"created": "2024-10-15T23:11:10.363+00:00",
"participant": [
{
"actor": {
"extension": [
{
"url": "https://intrahealth.com/appointmentLocation",
"valueString": ""
}
],
"reference": "Location/3"
},
"status": "accepted"
},
{
"actor": {
"reference": "Patient/4",
"type": "Patient",
"display": "Test, Intrahealth 2"
},
"status": "accepted",
"period": {
"start": "1899-12-29T16:00:00-08:00"
}
}
]
},
"search": {
"mode": "match",
"score": 1
}
},
{
"fullUrl": "https://localhost:5190/fhir/Appointment/MOKOY9LNI9ZXF2B9BFH2IKYSRGPJCBXS",
"resource": {
"resourceType": "Appointment",
"id": "MOKOY9LNI9ZXF2B9BFH2IKYSRGPJCBXS",
"meta": {
"tag": [
{
"system": "https://intrahealth.com/appointmentId",
"code": "134"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">https://localhost:5190/fhir/Appointment/MOKOY9LNI9ZXF2B9BFH2IKYSRGPJCBXS</div>"
},
"extension": [
{
"url": "IsGroupAppointment",
"valueBoolean": true
}
],
"status": "arrived",
"appointmentType": {
"coding": [
{
"system": "https://intrahealth.com/CodeSystem/appointment-mode",
"code": "3",
"display": "PHONE-CONSULT"
},
{
"system": "https://intrahealth.com/CodeSystem/appointment-type",
"code": "TRAVELIMM",
"display": "Travel Immunization"
}
]
},
"reasonCode": [
{
"text": "INJECTION, INTRA-ARTICULAR - HIPPP"
}
],
"start": "2024-10-29T12:15:00-07:00",
"end": "2024-10-29T12:30:00-07:00",
"minutesDuration": 15,
"created": "2024-10-15T23:14:08.580+00:00",
"participant": [
{
"actor": {
"extension": [
{
"url": "https://intrahealth.com/appointmentLocation",
"valueString": ""
}
],
"reference": "Location/3"
},
"status": "accepted"
},
{
"actor": {
"reference": "Patient/3",
"type": "Patient",
"display": "Test, Intrahealth 1"
},
"status": "accepted",
"period": {
"start": "2024-10-15T16:15:00-07:00"
}
}
]
},
"search": {
"mode": "match",
"score": 1
}
},
{
"fullUrl": "https://localhost:5190/fhir/Appointment/CUGXK87U3V9W1GGI070ZJMKXAHYEBMJS",
"resource": {
"resourceType": "Appointment",
"id": "CUGXK87U3V9W1GGI070ZJMKXAHYEBMJS",
"meta": {
"tag": [
{
"system": "https://intrahealth.com/appointmentId",
"code": "135"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">https://localhost:5190/fhir/Appointment/CUGXK87U3V9W1GGI070ZJMKXAHYEBMJS</div>"
},
"extension": [
{
"url": "IsGroupAppointment",
"valueBoolean": true
}
],
"status": "booked",
"appointmentType": {
"coding": [
{
"system": "https://intrahealth.com/CodeSystem/appointment-mode",
"code": "3",
"display": "PHONE-CONSULT"
},
{
"system": "https://intrahealth.com/CodeSystem/appointment-type",
"code": "TRAVELIMM",
"display": "Travel Immunization"
}
]
},
"reasonCode": [
{
"text": "INJECTION, INTRA-ARTICULAR - HIPPP"
}
],
"start": "2024-10-29T12:15:00-07:00",
"end": "2024-10-29T12:30:00-07:00",
"minutesDuration": 15,
"created": "2024-10-15T23:14:13.090+00:00",
"participant": [
{
"actor": {
"extension": [
{
"url": "https://intrahealth.com/appointmentLocation",
"valueString": ""
}
],
"reference": "Location/3"
},
"status": "accepted"
},
{
"actor": {
"reference": "Patient/3",
"type": "Patient",
"display": "Test, Intrahealth 1"
},
"status": "accepted",
"period": {
"start": "1899-12-29T16:00:00-08:00"
}
}
]
},
"search": {
"mode": "match",
"score": 1
}
},
{
"fullUrl": "https://localhost:5190/fhir/Appointment/OQ4HFMHFF90HHM5ODRS22ONTN6ETWAZH",
"resource": {
"resourceType": "Appointment",
"id": "OQ4HFMHFF90HHM5ODRS22ONTN6ETWAZH",
"meta": {
"tag": [
{
"system": "https://intrahealth.com/appointmentId",
"code": "139"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">https://localhost:5190/fhir/Appointment/OQ4HFMHFF90HHM5ODRS22ONTN6ETWAZH</div>"
},
"extension": [
{
"url": "IsGroupAppointment",
"valueBoolean": true
}
],
"status": "booked",
"appointmentType": {
"coding": [
{
"system": "https://intrahealth.com/CodeSystem/appointment-mode",
"code": "3",
"display": "PHONE-CONSULT"
},
{
"system": "https://intrahealth.com/CodeSystem/appointment-type",
"code": "TRAVELIMM",
"display": "Travel Immunization"
}
]
},
"reasonCode": [
{
"text": "INJECTION, INTRA-ARTICULAR - HIPPP"
}
],
"start": "2024-10-29T12:15:00-07:00",
"end": "2024-10-29T12:30:00-07:00",
"minutesDuration": 15,
"created": "2024-10-15T23:14:56.393+00:00",
"participant": [
{
"actor": {
"extension": [
{
"url": "https://intrahealth.com/appointmentLocation",
"valueString": ""
}
],
"reference": "Location/3"
},
"status": "accepted"
},
{
"actor": {
"reference": "Patient/3",
"type": "Patient",
"display": "Test, Intrahealth 1"
},
"status": "accepted",
"period": {
"start": "1899-12-29T16:00:00-08:00"
}
}
]
},
"search": {
"mode": "match",
"score": 1
}
}
]
}