API Reference

Remove a participant from a Conversation

delete
https://project-api.zapehr.com/v1/messaging/conversation//participant

Remove a participant from a Conversation. Conversations allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone.

Access Policy Requirements:
Action: Messaging:ConversationRemoveParticipant
Access Policy Resource: Messaging:Conversation
Action: FHIR:Read
Access Policy Resource: FHIR:Patient, FHIR:Practitioner, or FHIR:RelatedPerson

Path Params
uuid
required

ID of the Conversation from the https://extensions.fhir.oystehr.com/encounter-virtual-service-pre-release extension if on FHIR R4B, or from Encounter.virtual-service if on FHIR R5.

Body Params
string
required

A valid FHIR Encounter relative reference in the format: Encounter/some-uuid. This reference must be a valid Encounter in the FHIR store which has the https://extensions.fhir.oystehr.com/encounter-virtual-service-pre-release extension from being created by POST /message/conversation.

string
required

A valid FHIR profile reference in the format: for example, Patient/some-uuid. This reference must be a valid Patient, Practitioner, or RelatedPerson present in the FHIR store and which has been previously added to the Conversation.

Responses
204

Participants were removed from the Conversation successfully.

Updated about 1 year ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 year ago