Update an appointment
/Appointment/{id}
Updates an appointment.
Note: The only supported change is to update the Appointment.status
to arrived
or cancelled
.
Authorization Types
This resource supports the following authorization types:
- Provider
- System
Request
- application/json+fhir
-
id(required): string
The logical resource ID.
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
-
If-Match(required): string
The current version of the Appointment resource.
object
-
participant(required):
array participant
Participants involved in the appointment.
-
resourceType(required):
string
Allowed Values:
[ "Appointment" ]
The type of the FHIR resource.
-
status(required):
string
Allowed Values:
[ "arrived", "cancelled" ]
A code representing the overall status of the appointment.
{
"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":"accepted",
"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"
}
]
}
object
-
actor(required):
object actor
A person, location, healthcare service, or device that is participating in the appointment.
-
status(required):
string
Allowed Values:
[ "accepted" ]
The participation status of the actor.
object
A person, location, healthcare service, or device that is participating in the appointment.
-
display:
string
Example:
Smart, Barney R
-
reference:
string
Example:
Patient/4704007
Response
- application/json+fhir
200 Response
OK
-
ETag: string
The identifier for a specific version of a resource. This identifier is formatted as
W/"
and used to specify the" If-Match
header value on subsequent updates. -
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
412 Response
Precondition Failed
The If-Match
header must be provided.
422 Response
Unprocessable Entity
This error may occur for multiple reasons.
- The resource being updated is in a status that cannot be changed.
- An unsupported
status
was provided. - The patient URL or provider URL is longer than 255 characters.
423 Response
Locked
The appointment is currently being modified by another source.
424 Response
Failed Dependency
The appointment could not be updated because of an operation that is necessary for the update (for example, encounter association).
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.