Appointment resources are used to provide information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance. Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time.
| Name |
Field Name |
Type |
Value |
Description |
Required |
| Patient MRN |
patient |
- |
eg. GIY8J1RLX0 |
Identify the Patient to get appointment details. |
Yes |
| page_index |
_getpagesoffset |
- |
eg. 10 |
From start record position. Default is 0 |
No |
| Per_page |
_count |
- |
eg. 20 |
Total Number of records in each requrest |
No |
| date |
date |
- |
eg. gt2020-10-10 Date Formats |
Queries against the appointment start time |
No |
Sample Request URL
https://test-api.carespan.clinic/R4/Appointment?_getpagesoffset=0&_count=20&patient=GIY8J1RLX0
Response
{
"resourceType": "Bundle",
"type": "searchset",
"link": [
[
{
"relation": "self",
"url": "https://test-api.carespan.clinic/R4/Appointment?patient=GIY8J1RLX0&_getpagesoffset=0&_count=20"
}
]
],
"entry": [
{
"fullUrl": "//Appointment/aa7c951393868a8950e4566b3ffd5481",
"resource": {
"id": "aa7c951393868a8950e4566b3ffd5481",
"resourceType": "Appointment",
"extension": [
{
"valueString": "appointment-ready",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
},
{
"valueString": "https://local.carespan.clinic/login/welcome/4fjaSKF0HpU5JWvA",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
}
],
"status": "booked",
"start": "2020-11-12T16:32:00+00:00",
"end": "2020-11-12T17:15:40+00:00",
"comment": "test create appointment day 10",
"participant": [
{
"actor": {
"reference": "Practitioner/GI7E0ATLD0",
"display": "Mr. Kiran Malave MD"
}
},
{
"actor": {
"reference": "Patient/GIY8J1RLX0",
"display": "karan malave"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "//Appointment/6abe10d07d189857c8b2be3d97fa5f7f",
"resource": {
"id": "6abe10d07d189857c8b2be3d97fa5f7f",
"resourceType": "Appointment",
"extension": [
{
"valueString": "appointment-ready",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
},
{
"valueString": "https://local.carespan.clinic/login/welcome/jzmpMaZBRd9mkNv7",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
}
],
"status": "booked",
"start": "2020-11-13T14:09:00+00:00",
"end": "2020-11-13T15:09:00+00:00",
"comment": "test create appointment day 13",
"participant": [
{
"actor": {
"reference": "Practitioner/GI7E0ATLD0",
"display": "Mr. Kiran Malave MD"
}
},
{
"actor": {
"reference": "Patient/GIY8J1RLX0",
"display": "karan malave"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "//Appointment/07ebe237302f2628599f583e4ad0f75f",
"resource": {
"id": "07ebe237302f2628599f583e4ad0f75f",
"resourceType": "Appointment",
"extension": [
{
"valueString": "exam-canceled",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
},
{
"valueString": "https://local.carespan.clinic/login/welcome/jvNBq0Fas9s3OVG7",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
}
],
"status": "cancelled",
"start": "2020-11-13T17:00:00+00:00",
"end": "2020-11-13T17:30:00+00:00",
"comment": "test create appointment day 13-17:30",
"participant": [
{
"actor": {
"reference": "Practitioner/GI7E0ATLD0",
"display": "Mr. Kiran Malave MD"
}
},
{
"actor": {
"reference": "Patient/GIY8J1RLX0",
"display": "karan malave"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "//Appointment/dbbe7f120de523f0ee17a73004f3544f",
"resource": {
"id": "dbbe7f120de523f0ee17a73004f3544f",
"resourceType": "Appointment",
"extension": [
{
"valueString": "exam-canceled",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
},
{
"valueString": "https://local.carespan.clinic/login/welcome/s2DAYcux6czfK9LO",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
}
],
"status": "cancelled",
"start": "2020-11-13T17:30:00+00:00",
"end": "2020-11-13T18:00:00+00:00",
"comment": "test create appointment day 13-18:00",
"participant": [
{
"actor": {
"reference": "Practitioner/GI7E0ATLD0",
"display": "Mr. Kiran Malave MD"
}
},
{
"actor": {
"reference": "Patient/GIY8J1RLX0",
"display": "karan malave"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "//Appointment/c1f9328876050fdc6b937d8153421770",
"resource": {
"id": "c1f9328876050fdc6b937d8153421770",
"resourceType": "Appointment",
"extension": [
{
"valueString": "patient-no-show",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
},
{
"valueString": "https://local.carespan.clinic/login/welcome/ZbXjzjBaFYjUQsW2",
"url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
}
],
"status": "no-show",
"appointmentType": {
"coding": [
{
"system": "https://www.hl7.org/fhir/v2/0276/index.html",
"code": "ROUTINE"
},
{
"system": "https://api.carespan.clinic/fhir/coding/encounter-types",
"code": "7",
"display": "Initial Visit"
}
]
},
"start": "2021-09-07T21:10:50+00:00",
"end": "2021-09-07T21:30:50+00:00",
"comment": "test",
"participant": [
{
"actor": {
"reference": "Practitioner/GHM7V7SQSI",
"display": "Dr. Leicy Azpeitia"
}
},
{
"actor": {
"reference": "Patient/GQXNET0UOD",
"display": "Alan Wexler"
}
}
]
},
"search": {
"mode": "match"
}
}
]
}