Get a list of appointments
/Appointment
Retrieves a list of appointments that meet supplied query parameters.
Note:
- Valid IDs for the
practitioner
andlocation
search parameters are determined by the customer and provided when integrating your application with the customer's environment. See the Appointment resource information for details. - The
patient
,practitioner
, andlocation
parameters may be included only once and may not be used in combination. For example,patient=1234,5678
is supported butpatient=1234&patient=5678
, andpatient=1234&location=5678
are not. - Search by
date
returns appointments with a status other thanproposed
that start within the date range provided. - Search by
-date-or-req-period
returns the same appointments as thedate
parameter, but also returns appointments with a status ofproposed
that are requested to start or end between the dates provided. - The retrieved appointments are sorted by
start
date in ascending order (earliest first). - When searching with a patient authorization type, sensitive appointments will not be returned.
Authorization Types
This operation supports the following authorization types:
Request
-
-date-or-req-period: string
The appointment start date and time with offset or the appointment requested period date and time with offset. This parameter or
date
is required if thepatient
,practitioner
, orlocation
parameters are used.This parameter returns appointments with a status other than
proposed
that start or end within the date range provided, and returns appointments with a status ofproposed
that are requested to start or end between the dates provided.May be provided:
- Once with a prefix and time component to indicate a specific date and time. Example:
&date=ge2019-12-07T22:22:16.270Z
,&date=lt2019-12-14T22:22:16.270Z
. - Twice with the prefixes
ge
andlt
to indicate a specific range. The date and prefix pairs must define an upper and lower bound. Example:&date=ge2019-12-07T22:22:16.270Z&date=lt2019-12-14T22:22:16.270Z
.
Example:
-date-or-req-period=ge2019-06-07T22:22:16.000Z
- Once with a prefix and time component to indicate a specific date and time. Example:
-
_count: integer
Minimum Value:
1
The maximum number of results to return.
Example:
_count=15
-
_id: string
The logical resource ID. This parameter is required if the
patient
,practitioner
, andlocation
parameters are not used.Example:
_id=12345
-
date: string
The appointment start date and time with offset. This parameter or
-date-or-req-period
is required if thepatient
,practitioner
, orlocation
parameters are used.This parameter returns appointments with a status other than
proposed
that start or end within the date range provided.May be provided:
- Once with a prefix and time component to indicate a specific date and time. Example:
&date=ge2019-12-07T22:22:16.270Z
,&date=lt2019-12-14T22:22:16.270Z
. - Twice with the prefixes
ge
andlt
to indicate a specific range. The date and prefix pairs must define an upper and lower bound. Example:&date=ge2019-12-07T22:22:16.270Z&date=lt2019-12-14T22:22:16.270Z
.
Example:
date=ge2019-06-07T22:22:16.000Z
- Once with a prefix and time component to indicate a specific date and time. Example:
-
location: string
The logical resource ID of the location associated with the appointment. This parameter is required if the
_id
,patient
, andpractitioner
parameters are not used.Example:
location=21304876
-
patient: string
The logical resource ID of the patient associated with the appointment. This parameter is required if the
_id
,practitioner
, andlocation
parameters are not used.Example:
patient=12724066
-
practitioner: string
The logical resource ID of the practitioner associated with the appointment. This parameter is required if the
_id
,patient
, andlocation
parameters are not used.Example:
practitioner=593923
-
status: array[string]
Minimum Number of Items:
1
The status of the appointment. See the AppointmentStatus definition for more details.
Example:
status=arrived
-
Allowed Values:
[ "proposed", "pending", "booked", "arrived", "fulfilled", "cancelled", "noshow", "entered-in-error", "checked-in", "waitlist" ]
-
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
Response
- application/fhir+json
Default Response
Example search for an appointment.
Example Request:GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment?patient=12724066&date=ge2020-01-01T22:22:16.270Z
Example Response:
{
"resourceType": "Bundle",
"id": "c12c5555-b7db-4f1c-a21a-ad4f2bffbfd0",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment?date=ge2020-01-01T22%3A22%3A16.270Z&patient=12724066"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4822366",
"resource": {
"resourceType": "Appointment",
"id": "4822366",
"meta": {
"versionId": "2",
"lastUpdated": "2021-04-22T12:21:26Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Appointment</b></p><p><b>Status</b>: Cancelled</p><p><b>Service Type</b>: Surgery Rapid</p><p><b>Start</b>: Jan 23, 2020 10:10 P.M. UTC</p><p><b>End</b>: Jan 23, 2020 11:10 P.M. UTC</p><p><b>Participants</b>:</p><dl><dd><b>Location</b>: Endoscopy</dd><dd><b>Other Resource</b>: EN Add-On</dd><dd><b>Patient</b>: SMARTS SR., NANCYS II</dd></dl></div>"
},
"extension": [
{
"valueBoolean": false,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-cancelable"
},
{
"valueBoolean": false,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-reschedulable"
}
],
"status": "cancelled",
"cancelationReason": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14229",
"code": "0",
"userSelected": true
}
]
},
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "4047611",
"display": "Surgery Rapid",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394576009",
"display": "Accident & emergency (qualifier value)",
"userSelected": false
}
],
"text": "Surgery Rapid"
}
],
"reasonCode": [
{
"text": "I have a cramp"
}
],
"description": "Surgery Rapid",
"start": "2020-01-23T22:10:00Z",
"end": "2020-01-23T23:10:00Z",
"minutesDuration": 60,
"participant": [
{
"actor": {
"reference": "Location/32216049",
"display": "Endoscopy"
},
"required": "required",
"status": "accepted"
},
{
"type": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14250",
"code": "269829903",
"display": "Endoscopy Rooms",
"userSelected": true
}
],
"text": "Endoscopy Rooms"
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
]
}
],
"actor": {
"display": "EN Add-On"
},
"required": "required",
"status": "accepted"
},
{
"type": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14250",
"code": "4572",
"display": "Patient",
"userSelected": true
}
],
"text": "Patient"
}
],
"actor": {
"reference": "Patient/12724066",
"display": "SMARTS SR., NANCYS II"
},
"required": "required",
"status": "accepted",
"period": {
"start": "2020-01-23T22:10:00Z",
"end": "2020-01-23T23:10:00Z"
}
}
],
"requestedPeriod": [
{
"start": "2020-01-23T22:10:00Z",
"end": "2020-01-23T23:10:00Z"
}
]
}
}
]
}
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id
, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id
, if present.
x-search-booked Response
Example search for a booked
appointment.
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment?patient=12507979&date=ge2021-01-22T19:00:00.000Z&status=booked
Example Response:
{
"resourceType": "Bundle",
"id": "5f5f8642-bfd4-4b21-bbeb-0538b9e3ec64",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment?date=ge2021-01-22T19%3A00%3A00.000Z&patient=12507979&status=booked"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4823974",
"resource": {
"resourceType": "Appointment",
"id": "4823974",
"meta": {
"versionId": "1",
"lastUpdated": "2021-01-22T17:25:37Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Appointment</b></p><p><b>Status</b>: Booked</p><p><b>Service Type</b>: Established Patient</p><p><b>Start</b>: Jan 22, 2021 10:15 P.M. UTC</p><p><b>End</b>: Jan 22, 2021 10:30 P.M. UTC</p><p><b>Slot Id</b>: 24477854-21304876-63231945-495</p><p><b>Participants</b>:</p><dl><dd><b>Location</b>: MX Clinic 1</dd><dd><b>Patient</b>: SMITHY, UPDATED_LAST_NAME UPDATED_FIRST_NAME</dd><dd><b>Practitioner</b>: Applegate MD, Christina</dd></dl></div>"
},
"extension": [
{
"valueBoolean": false,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-cancelable"
},
{
"valueBoolean": false,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-reschedulable"
}
],
"status": "booked",
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "24477854",
"display": "Established Patient",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "408443003",
"display": "General medical practice (qualifier value)",
"userSelected": false
}
],
"text": "Established Patient"
}
],
"description": "Established Patient",
"start": "2021-01-22T22:15:00Z",
"end": "2021-01-22T22:30:00Z",
"minutesDuration": 15,
"slot": [
{
"reference": "Slot/24477854-21304876-63231945-495"
}
],
"participant": [
{
"actor": {
"reference": "Location/21304876",
"display": "MX Clinic 1"
},
"required": "required",
"status": "accepted"
},
{
"type": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14250",
"code": "4572",
"display": "Patient",
"userSelected": true
}
],
"text": "Patient"
}
],
"actor": {
"reference": "Patient/12507979",
"display": "SMITHY, UPDATED_LAST_NAME UPDATED_FIRST_NAME"
},
"required": "required",
"status": "tentative",
"period": {
"start": "2021-01-22T22:15:00Z",
"end": "2021-01-22T22:30:00Z"
}
},
{
"type": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14250",
"code": "0",
"userSelected": true
}
]
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
]
}
],
"actor": {
"reference": "Practitioner/593923",
"display": "Applegate MD, Christina"
},
"required": "required",
"status": "accepted"
}
],
"requestedPeriod": [
{
"start": "2021-01-22T22:15:00Z",
"end": "2021-01-22T22:30:00Z"
}
]
}
}
]
}
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id
, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id
, if present.