Create an appointment
/Appointment/
Creates an appointment.
Note:
- The modifier elements
implicitRules
andmodifierExtension
are not supported and are rejected if present. - Scheduling examples are time sensitive and require a slot with a status of
free
.
Authorization Types
This resource supports the following authorization types:
- Provider
- System
Request
- application/json+fhir
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
object
-
comment:
string
Additional text to aid in facilitating the appointment.
Example:Further explain MRI results
-
participant(required):
array participant
Minimum Number of Items:
1
Maximum Number of Items:1
Participants involved in the appointment.
Note: The
participant.type
must not be set. -
resourceType(required):
string
Allowed Values:
[ "Appointment" ]
The type of the FHIR resource.
-
slot(required):
array slot
Minimum Number of Items:
1
Maximum Number of Items:1
The availability to which the appointment is booked.
-
status(required):
string
Allowed Values:
[ "proposed" ]
A code representing the overall status of the appointment.
{
"resourceType":"Appointment",
"slot":[
{
"reference":"Slot/24477854-21304876-62852027-0"
}
],
"status":"proposed",
"participant":[
{
"actor":{
"reference":"Patient/12724066"
},
"status":"needs-action"
}
]
}
array
1
1
Participants involved in the appointment.
Note: The participant.type
must not be set.
array
1
1
The availability to which the appointment is booked.
object
-
actor(required):
object actor
The patient that is participating in the appointment.
-
status(required):
string
Allowed Values:
[ "needs-action" ]
object
The patient that is participating in the appointment.
-
display:
string
Example:
Smart, Barney R
-
reference:
string
Example:
Patient/4704007
object
-
reference:
string
Example:
Slot/21265426-633867-6828001-60
Response
- application/json+fhir
201 Response
Created
-
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. -
Location: string
The URL location of the created entity.
Example:
https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/6427746
-
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
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.