Jump to

• Request
• Response

Patch a slot

patch

/Slot/{ID}

Patches an existing slot.

Note:

• This implementation follows the JSON PATCH specification.
• Only operations on the paths listed below are supported.

Authorization Types

This operation supports the following authorization types:

• Provider
• System

Patch Operations

Path	Operation	Value Type
/status	replace	code
Description: The status of the slot. Example: { "op": "replace", "path": "/status" "status": "free" } Note: Only free and busy-tentative are supported.

Request

Supported Media Types

• application/fhir+json

Path Parameters

• ID(required): string
  The logical resource ID associated with the resource.

Header Parameters

• Authorization(required): string
  Contains the credentials to authenticate a consumer to the service. The credentials should be the OAuth2 Bearer Token.
• If-Match(required): string
• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.

Body ()

The body of the patch operation

Root Schema : SlotPatch

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":"1",
    "items":{
        "type":"object",
        "required":[
            "op",
            "path"
        ],
        "properties":{
            "op":{
                "type":"string",
                "enum":[
                    "replace"
                ]
            },
            "path":{
                "type":"string",
                "enum":[
                    "/status"
                ]
            },
            "value":{
                "type":"string",
                "enum":[
                    "free",
                    "busy-tentative"
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• op(required): string
  Allowed Values: [ "replace" ]
• path(required): string
  Allowed Values: [ "/status" ]
• value: string
  Allowed Values: [ "free", "busy-tentative" ]

{
    "type":"object",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "enum":[
                "replace"
            ]
        },
        "path":{
            "type":"string",
            "enum":[
                "/status"
            ]
        },
        "value":{
            "type":"string",
            "enum":[
                "free",
                "busy-tentative"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json-patch+json

Default Response

Example Request:

PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/4047611-32216049-61518614-0

Example Request Body:

[
    {
      'op': 'replace',
      'path': '/status',
      'value': 'busy-tentative'
    }
  ]

Example Response:

  Cache-Control: no-cache
  Content-Length: 20
  Content-Type: text/html
  Date: Tue, 06 Apr 2021 15:36:47 GMT
  Etag: W/"410v795030969834"
  Last-Modified: Tue, 06 Apr 2021 15:36:47 GMT
  Vary: Origin
  X-Request-Id: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

• Etag: string
  For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
• If-Match: string
  For Update or Patch versioning controls. Related to Etag. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
• 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.

Back to Top