PUT Pharmacy Interventions

Developer Tools

PUT api/v1/{EMRSystem}/PharmacyInterventions/{InterventionId}

Updates a Pharmacy Intervention.

HTTP Method

PUT

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

InterventionId

The intervention identifier.

string

Required

 
Body Parameters
The pharmacy intervention update request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

Intervention

Gets or sets the intervention.

PharmacyInterventionUpdateViewModel

Required

 

Response Information

 
Resource Description
Http response containing http status code indicating success or failure.
None
 
Response Codes

Http Status Code 204 – Indicates that the request was processed successfully.

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.

 
Response Formats
Sample Message
Download Json Schema
{
  "UserId": "sample string 1",
  "Intervention": {
    "Types": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "SubTypes": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "StatusId": "sample string 1",
    "Significance": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TimeSpent": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Value": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Response": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Outcomes": {
      "FieldId": "sample string 1",
      "CodedValueIds": [
        "sample string 1",
        "sample string 2"
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "AdditionalDetails": [
      {
        "FieldId": "sample string 1",
        "CodedValueIds": [
          "sample string 1",
          "sample string 2"
        ],
        "TextValues": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "FieldId": "sample string 1",
        "CodedValueIds": [
          "sample string 1",
          "sample string 2"
        ],
        "TextValues": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "LinkedOrders": [
      {
        "OrderId": "sample string 1",
        "LinkTypeId": "sample string 2"
      },
      {
        "OrderId": "sample string 1",
        "LinkTypeId": "sample string 2"
      }
    ],
    "Documentation": "sample string 2",
    "Notes": "sample string 3"
  },
  "Domain": "sample string 2",
  "LoginId": "sample string 3",
  "Password": "sample string 4",
  "EmrInstance": "sample string 5",
  "ApplicationName": "sample string 6",
  "ApplicationKey": "sample string 7"
}
Sample Message
<PharmacyInterventionUpdateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 7</ApplicationKey>
  <ApplicationName>sample string 6</ApplicationName>
  <Domain>sample string 2</Domain>
  <EmrInstance>sample string 5</EmrInstance>
  <LoginId>sample string 3</LoginId>
  <Password>sample string 4</Password>
  <Intervention xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:AdditionalDetails>
      <d2p1:FormInputValuesViewModel>
        <d2p1:CodedValueIds xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:CodedValueIds>
        <d2p1:FieldId>sample string 1</d2p1:FieldId>
        <d2p1:TextValues xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:TextValues>
      </d2p1:FormInputValuesViewModel>
      <d2p1:FormInputValuesViewModel>
        <d2p1:CodedValueIds xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:CodedValueIds>
        <d2p1:FieldId>sample string 1</d2p1:FieldId>
        <d2p1:TextValues xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:TextValues>
      </d2p1:FormInputValuesViewModel>
    </d2p1:AdditionalDetails>
    <d2p1:Documentation>sample string 2</d2p1:Documentation>
    <d2p1:LinkedOrders>
      <d2p1:PharmacyInterventionOrderUpdateViewModel>
        <d2p1:LinkTypeId>sample string 2</d2p1:LinkTypeId>
        <d2p1:OrderId>sample string 1</d2p1:OrderId>
      </d2p1:PharmacyInterventionOrderUpdateViewModel>
      <d2p1:PharmacyInterventionOrderUpdateViewModel>
        <d2p1:LinkTypeId>sample string 2</d2p1:LinkTypeId>
        <d2p1:OrderId>sample string 1</d2p1:OrderId>
      </d2p1:PharmacyInterventionOrderUpdateViewModel>
    </d2p1:LinkedOrders>
    <d2p1:Notes>sample string 3</d2p1:Notes>
    <d2p1:Outcomes>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:Outcomes>
    <d2p1:Response>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:Response>
    <d2p1:Significance>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:Significance>
    <d2p1:StatusId>sample string 1</d2p1:StatusId>
    <d2p1:SubTypes>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:SubTypes>
    <d2p1:TimeSpent>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:TimeSpent>
    <d2p1:Types>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:Types>
    <d2p1:Value>
      <d2p1:CodedValueIds xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CodedValueIds>
      <d2p1:FieldId>sample string 1</d2p1:FieldId>
      <d2p1:TextValues xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:TextValues>
    </d2p1:Value>
  </Intervention>
  <UserId>sample string 1</UserId>
</PharmacyInterventionUpdateRequestViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?