Jump to

• Request
• Response

Update an appointment

put

/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

Supported Media Types

• application/json+fhir

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.

• If-Match(required): string
  The current version of the Appointment resource.

Body ()

Root Schema : AppointmentUpdateBody

Type: object

Show Source

• 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.

{
    "type":"object",
    "required":[
        "resourceType",
        "status",
        "participant"
    ],
    "properties":{
        "resourceType":{
            "description":"<p>The type of the FHIR resource.</p>",
            "type":"string",
            "enum":[
                "Appointment"
            ]
        },
        "status":{
            "description":"<p>A code representing the overall status of the appointment.</p>\n",
            "type":"string",
            "enum":[
                "arrived",
                "cancelled"
            ]
        },
        "participant":{
            "description":"<p>Participants involved in the appointment.</p>",
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "actor",
                    "status"
                ],
                "properties":{
                    "actor":{
                        "type":"object",
                        "description":"<p>A person, location, healthcare service, or device that is participating in the appointment.</p>\n",
                        "properties":{
                            "reference":{
                                "type":"string",
                                "example":"Patient/4704007"
                            },
                            "display":{
                                "type":"string",
                                "example":"Smart, Barney R"
                            }
                        }
                    },
                    "status":{
                        "type":"string",
                        "description":"<p>The participation status of the actor.</p>",
                        "enum":[
                            "accepted"
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "resourceType":"Appointment",
        "id":"4817508",
        "meta":{
            "versionId":"1",
            "lastUpdated":"2020-07-06T16:41:32.000Z"
        },
        "text":{
            "status":"generated",
            "div":"&lt;div&gt;&lt;p&gt;&lt;b&gt;Appointment&lt;/b&gt;&lt;/p&gt;&lt;p&gt;&lt;b&gt;Description&lt;/b&gt;: PT Eval&lt;/p&gt;&lt;p&gt;&lt;b&gt;Type&lt;/b&gt;: PT Eval&lt;/p&gt;&lt;p&gt;&lt;b&gt;Start&lt;/b&gt;: Oct  6, 2020  2:00 P.M. UTC&lt;/p&gt;&lt;p&gt;&lt;b&gt;End&lt;/b&gt;: Oct  6, 2020  3:00 P.M. UTC&lt;/p&gt;&lt;p&gt;&lt;b&gt;Duration&lt;/b&gt;: 60 Minutes&lt;/p&gt;&lt;p&gt;&lt;b&gt;Status&lt;/b&gt;: Booked&lt;/p&gt;&lt;p&gt;&lt;b&gt;Reason&lt;/b&gt;: torn ACL&lt;/p&gt;&lt;p&gt;&lt;b&gt;Location&lt;/b&gt;: OP Rehab1&lt;/p&gt;&lt;p&gt;&lt;b&gt;Participants&lt;/b&gt;:&lt;/p&gt;&lt;p&gt;&lt;b&gt;Patient&lt;/b&gt;: SMART, NANCY&lt;/p&gt;&lt;br /&gt;&lt;p&gt;&lt;b&gt;Participant&lt;/b&gt;: Sisko, Jon PT&lt;/p&gt;&lt;p&gt;&lt;b&gt;Primary&lt;/b&gt;: Yes&lt;/p&gt;&lt;/div&gt;"
        },
        "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"
            }
        ]
    }
}

Example:

{
    "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"
        }
    ]
}

Nested Schema : participant

Type: array

Participants involved in the appointment.

Show Source

• Array of: object items

{
    "description":"<p>Participants involved in the appointment.</p>",
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "actor",
            "status"
        ],
        "properties":{
            "actor":{
                "type":"object",
                "description":"<p>A person, location, healthcare service, or device that is participating in the appointment.</p>\n",
                "properties":{
                    "reference":{
                        "type":"string",
                        "example":"Patient/4704007"
                    },
                    "display":{
                        "type":"string",
                        "example":"Smart, Barney R"
                    }
                }
            },
            "status":{
                "type":"string",
                "description":"<p>The participation status of the actor.</p>",
                "enum":[
                    "accepted"
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "required":[
        "actor",
        "status"
    ],
    "properties":{
        "actor":{
            "type":"object",
            "description":"<p>A person, location, healthcare service, or device that is participating in the appointment.</p>\n",
            "properties":{
                "reference":{
                    "type":"string",
                    "example":"Patient/4704007"
                },
                "display":{
                    "type":"string",
                    "example":"Smart, Barney R"
                }
            }
        },
        "status":{
            "type":"string",
            "description":"<p>The participation status of the actor.</p>",
            "enum":[
                "accepted"
            ]
        }
    }
}

Nested Schema : actor

Type: object

A person, location, healthcare service, or device that is participating in the appointment.

Show Source

• display: string
  Example: Smart, Barney R
• reference: string
  Example: Patient/4704007

{
    "type":"object",
    "description":"<p>A person, location, healthcare service, or device that is participating in the appointment.</p>\n",
    "properties":{
        "reference":{
            "type":"string",
            "example":"Patient/4704007"
        },
        "display":{
            "type":"string",
            "example":"Smart, Barney R"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json+fhir

200 Response

OK

Headers

• 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.

Headers

• X-Request-Id: string

  Oracle troubleshooting identifier.

• opc-request-id: string

  Oracle troubleshooting identifier.

Body ()

Root Schema : schema

Type: object

Show Source

• issue(required): array issue
  Minimum Number of Items: 1
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "minItems":"1",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string",
                        "description":"<p>See the IssueSeverity definition for more information.</p>\n",
                        "enum":[
                            "fatal",
                            "error",
                            "warning",
                            "information"
                        ]
                    },
                    "code":{
                        "type":"string",
                        "description":"<p>See the IssueType definition for codes and more information.</p>\n"
                    },
                    "details":{
                        "type":"object",
                        "properties":{
                            "coding":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "system":{
                                            "type":"string"
                                        },
                                        "code":{
                                            "type":"string"
                                        },
                                        "display":{
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "text":{
                                "type":"string"
                            }
                        }
                    },
                    "location":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":"1",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string",
                "description":"<p>See the IssueSeverity definition for more information.</p>\n",
                "enum":[
                    "fatal",
                    "error",
                    "warning",
                    "information"
                ]
            },
            "code":{
                "type":"string",
                "description":"<p>See the IssueType definition for codes and more information.</p>\n"
            },
            "details":{
                "type":"object",
                "properties":{
                    "coding":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "system":{
                                    "type":"string"
                                },
                                "code":{
                                    "type":"string"
                                },
                                "display":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "text":{
                        "type":"string"
                    }
                }
            },
            "location":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string",
            "description":"<p>See the IssueSeverity definition for more information.</p>\n",
            "enum":[
                "fatal",
                "error",
                "warning",
                "information"
            ]
        },
        "code":{
            "type":"string",
            "description":"<p>See the IssueType definition for codes and more information.</p>\n"
        },
        "details":{
            "type":"object",
            "properties":{
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            },
                            "display":{
                                "type":"string"
                            }
                        }
                    }
                },
                "text":{
                    "type":"string"
                }
            }
        },
        "location":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : details

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    },
                    "display":{
                        "type":"string"
                    }
                }
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : location

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "system":{
                "type":"string"
            },
            "code":{
                "type":"string"
            },
            "display":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
• display: string
• system: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Back to Top