Get a list of appointments
/Appointment/
Retrieves a list of appointments that meet supplied query parameters.
Note:
- The
patient
,practitioner
, andlocation
parameters may be included only once and may not be used in combination. - The retrieved appointments are sorted by
start
date in ascending order.
Authorization Types
This operation supports the following authorization types:
- Patient
- Provider
- System
Request
-
_count: integer
Minimum Value:
1
The maximum number of results to return.
Example:
_count=15
-
_id: array[string]
Minimum Number of Items:
1
The logical resource ID. This parameter is required if the
patient
,practitioner
, orlocation
parameter is not used.Example:
_id=12345
-
date: string
The appointment start date and time. This parameter is required if the
patient
,practitioner
, orlocation
parameter is used.May be provided:
- Once without a prefix or time component to imply a date range. Example:
date=2016
,date=2016-07
,date=2016-07-04
. - Once without a prefix and with a time component to indicate a specific date and time. Example:
date=2016-07-04T13:00:00.000-05:00
. - Twice with the
ge
orgt
andle
orlt
prefixes to indicate a specific range. The date and prefix pairs must define an upper and lower bound. Example:date=ge2014&date=lt2016
,date=ge2014-03-15&date=le2017
.
Example:
date=2024-06
- Once without a prefix or time component to imply a date range. Example:
-
location: array[string]
Minimum Number of Items:
1
The logical resource ID of the location associated with the appointment. This parameter is required if the
_id
,patient
, orpractitioner
parameter is not used.Valid IDs are determined by the customer and provided when integrating your application with the customer's environment.
Example:
location=21304876
-
patient: array[string]
Minimum Number of Items:
1
The logical resource ID of the patient associated with the appointment. This parameter is required if the
_id
,practitioner
, orlocation
parameter is not used.Example:
patient=12724066
-
practitioner: array[string]
Minimum Number of Items:
1
The logical resource ID of the practitioner associated with the appointment. This parameter is required if the
_id
,patient
, orlocation
parameter is not used.Valid IDs are determined by the customer and provided when integrating your application with the customer's environment.
Example:
practitioner=593923
-
status: array[string]
Minimum Number of Items:
1
The status of the appointment.
-
Allowed Values:
[ "proposed", "pending", "booked", "arrived", "fulfilled", "cancelled", "noshow" ]
-
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
Response
- application/json+fhir
200 Response
OK
-
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
{
"resourceType":"Bundle",
"id":"c1502c8d-2f96-4d7e-996c-5b39f96046c8",
"type":"searchset",
"total":"1",
"link":[
{
"relation":"self",
"url":"https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment?date=2020&patient=12724066&_count=50"
}
],
"entry":[
{
"fullUrl":"https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4817508",
"resource":{
"resourceType":"Appointment",
"id":"4817508",
"meta":{
"versionId":"1",
"lastUpdated":"2020-07-06T16:41:32.000Z"
},
"text":{
"status":"generated",
"div":"<div><p><b>Appointment</b></p><p><b>Description</b>: PT Eval</p><p><b>Type</b>: PT Eval</p><p><b>Start</b>: Oct 6, 2020 2:00 P.M. UTC</p><p><b>End</b>: Oct 6, 2020 3:00 P.M. UTC</p><p><b>Duration</b>: 60 Minutes</p><p><b>Status</b>: Booked</p><p><b>Reason</b>: torn ACL</p><p><b>Location</b>: OP Rehab1</p><p><b>Participants</b>:</p><p><b>Patient</b>: SMART, NANCY</p><br /><p><b>Participant</b>: Sisko, Jon PT</p><p><b>Primary</b>: Yes</p></div>"
},
"status":"booked",
"type":{
"coding":[
{
"system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code":"26054577",
"display":"PT Eval",
"userSelected":true
}
],
"text":"PT Eval"
},
"reason":{
"coding":[
{
"extension":[
{
"url":"http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode":"unsupported"
}
]
}
],
"text":"torn ACL"
},
"description":"PT Eval",
"start":"2020-10-06T14:00:00.000Z",
"end":"2020-10-06T15:00:00.000Z",
"minutesDuration":"60",
"participant":[
{
"type":[
{
"coding":[
{
"extension":[
{
"url":"http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode":"unknown"
}
]
}
],
"text":"PT Therapists"
},
{
"coding":[
{
"system":"http://hl7.org/fhir/v3/ParticipationType",
"code":"PPRF",
"display":"primary performer",
"userSelected":false
}
]
}
],
"actor":{
"display":"Sisko, Jon PT"
},
"required":"required",
"status":"accepted"
},
{
"type":[
{
"coding":[
{
"extension":[
{
"url":"http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode":"unknown"
}
]
}
],
"text":"Patient"
}
],
"actor":{
"reference":"Patient/12724066",
"display":"SMART, NANCY"
},
"required":"required",
"status":"accepted"
},
{
"actor":{
"reference":"Location/21503380",
"display":"OP Rehab1"
},
"required":"required",
"status":"accepted"
}
]
}
}
]
}
Default Response
An OperationOutcome describing any error that occurred.
-
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
object
-
issue(required):
array issue
Minimum Number of Items:
1
-
resourceType(required):
string
Allowed Values:
[ "OperationOutcome" ]
object
-
code(required):
string
See the IssueType definition for codes and more information.
-
details:
object details
-
location:
array location
-
severity(required):
string
Allowed Values:
[ "fatal", "error", "warning", "information" ]
See the IssueSeverity definition for more information.