Jump to

• Request
• Response

Patch a medication request

patch

/MedicationRequest/{ID}

Patch an existing medication request.

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 MedicationRequest Example: { "op": "replace", "path": "/status", "value": "stopped" } Note: Only the stopped and cancelled statuses are supported. The stopped status indicates that the medication was stopped before all scheduled administrations occurred. The cancelled status indicates that the first instance was never administered. Use the dosageInstruction.timing.repeat.boundsPeriod.start field to determine if the stopped or cancelled status is most appropriate. If the field is in the past, then use the stopped status; otherwise, use the cancelled status. If you use stopped when the cancelled status is most appropriate, the status is updated to cancelled. If you use cancelled when the stopped status is most appropriate, the status is updated to stopped. Only historical documented medications in Millennium can have their status updated. To identify these medications, you can use the following query parameters to filter the medication request: MedicationRequest.intent = order MedicationRequest.category = patientspecified & community MedicationRequest.reportedBoolean = true

Request

Supported Media Types

• application/fhir+json

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 MedicationRequest resource.
• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.
• content-type(required): string
  Specifies the content type of the request entity body.

Body ()

The body of the patch operation.

Root Schema : MedicationRequestPatch

Type: array

Minimum Number of Items: 1

A summary representation of the patch (PATCH) operation for a medication request.

Show Source

• Array of: object items

{
    "description":"A summary representation of the patch (PATCH) operation for a medication request.",
    "type":"array",
    "minItems":1,
    "items":{
        "type":"object",
        "required":[
            "op",
            "path"
        ],
        "properties":{
            "op":{
                "type":"string",
                "enum":[
                    "replace"
                ]
            },
            "path":{
                "type":"string"
            },
            "value":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• op(required): string
  Allowed Values: [ "replace" ]
• path(required): string
• value: string

{
    "type":"object",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "enum":[
                "replace"
            ]
        },
        "path":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json-patch+json

Default Response

Example Request:

PATCH https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationRequest/1621910

Example Request Body:

[
    {
      'op': 'replace',
      'path': '/status',
      'value': 'stopped'
    }
  ]

Example Response:

  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Tue, 26 Mar 2019 15:42:29 GMT
  Etag: W/"10"
  Last-Modified: Tue, 26 Mar 2019 15:42:27 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.
• 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