Get an appointment by ID
get
/Appointment/{ID}
Retrieves an appointment by the associated appointment ID.
Authorization Types
This operation supports the following authorization types:
Request
Path Parameters
-
ID(required): string
The logical resource ID.
Header Parameters
-
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
Supported Media Types
- application/fhir+json
Default Response
Example retrieval of an appointment.
Example Request:GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4822366{
"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"
}
]
}Headers
-
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-retrieve-booked Response
Example retrieval of a booked appointment.
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4874055{
"resourceType": "Appointment",
"id": "4874055",
"meta": {
"versionId": "3",
"lastUpdated": "2023-02-15T20:26:52Z"
},
"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>: Client Billing</p><p><b>Start</b>: Feb 15, 2023 9:00 P.M. UTC</p><p><b>End</b>: Feb 15, 2023 9:15 P.M. UTC</p><p><b>Participants</b>:</p><dl><dd><b>Location</b>: MX Clinic 2</dd><dd><b>Other Resource</b>: Favreau, Bastien MD</dd><dd><b>Patient</b>: ODSchedulingCancel, 55681cfa-0084-48a1-93eb-0a9f89ad5d60</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": "2554801993",
"display": "Client Billing",
"userSelected": true
}
],
"text": "Client Billing"
}
],
"description": "Client Billing",
"start": "2023-02-15T21:00:00Z",
"end": "2023-02-15T21:15:00Z",
"minutesDuration": 15,
"participant": [
{
"actor": {
"reference": "Location/21251399",
"display": "MX Clinic 2"
},
"required": "required",
"status": "accepted"
},
{
"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": {
"display": "Favreau, Bastien MD"
},
"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/12822932",
"display": "ODSchedulingCancel, 55681cfa-0084-48a1-93eb-0a9f89ad5d60"
},
"required": "required",
"status": "accepted",
"period": {
"start": "2023-02-15T21:00:00Z",
"end": "2023-02-15T21:15:00Z"
}
}
],
"requestedPeriod": [
{
"start": "2023-02-15T21:00:00Z",
"end": "2023-02-15T21:15:00Z"
}
]
}Headers
-
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-retrieve-with-video-visit Response
Example retrieval of an appointment with a video visit.
Example Request:GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/4817572{
"resourceType": "Appointment",
"id": "4817572",
"meta": {
"versionId": "2-1",
"lastUpdated": "2020-07-11T05:05:01Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Appointment</b></p><p><b>Status</b>: No Show</p><p><b>Service Type</b>: Video Visit</p><p><b>Start</b>: Jul 10, 2020 1:00 P.M. UTC</p><p><b>End</b>: Jul 10, 2020 1:15 P.M. UTC</p><p><b>Slot Id</b>: 2572307911-21304876-63048470-0</p><p><b>Participants</b>:</p><dl><dd><b>Location</b>: MX Clinic 1</dd><dd><b>Patient</b>: SMARTS SR., NANCYS II</dd><dd><b>Practitioner</b>: Applegate MD, Christina</dd></dl><p><b>Video Visit</b>: Yes</p></div>"
},
"contained": [
{
"resourceType": "HealthcareService",
"id": "28",
"type": [
{
"text": "Patient Virtual Meeting Room"
}
],
"telecom": [
{
"system": "url",
"value": "http://patientlink.vmr.net"
}
]
},
{
"resourceType": "HealthcareService",
"id": "31",
"type": [
{
"text": "Provider Virtual Meeting Room"
}
],
"telecom": [
{
"system": "url",
"value": "http://patientlink.vmr.net"
}
]
}
],
"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": "noshow",
"serviceType": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
"code": "2572307911",
"display": "Video Visit",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "394581000",
"display": "Community medicine (qualifier value)",
"userSelected": false
}
],
"text": "Video Visit"
}
],
"reasonCode": [
{
"text": "Testing Video Visit"
}
],
"description": "Video Visit",
"start": "2020-07-10T13:00:00Z",
"end": "2020-07-10T13:15:00Z",
"minutesDuration": 15,
"slot": [
{
"reference": "Slot/2572307911-21304876-63048470-0"
}
],
"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/12724066",
"display": "SMARTS SR., NANCYS II"
},
"required": "required",
"status": "accepted",
"period": {
"start": "2020-07-10T13:00:00Z",
"end": "2020-07-10T13:15:00Z"
}
},
{
"type": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14250",
"code": "4574",
"display": "Resource",
"userSelected": true
}
],
"text": "Resource"
},
{
"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"
},
{
"type": [
{
"text": "Patient Virtual Meeting Room"
}
],
"actor": {
"reference": "#28"
},
"status": "accepted"
},
{
"type": [
{
"text": "Provider Virtual Meeting Room"
}
],
"actor": {
"reference": "#31"
},
"status": "accepted"
}
],
"requestedPeriod": [
{
"start": "2020-07-10T13:00:00Z",
"end": "2020-07-10T13:15:00Z"
}
]
}Headers
-
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.