POST api/v1/{practiceXRef}/patient/inactivate

Delete an existing patient in a practice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceXRef

NodeId of the practice that owns the patient data

 string

Required

Body Parameters

The patient object

Com.Healthbridge.Hhas.Patient.Interface.Commands.RemovePatient
NameDescriptionTypeAdditional information
PatientId

globally unique identifier

None.
PatientXRef

string

None.
PracticeId

globally unique identifier

None.
Reason

string

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PatientId": "c340a7af-7a5a-40a7-bb85-25817d9c436e",
  "PatientXRef": "sample string 2",
  "PracticeId": "08990d59-a537-40f2-934b-ccbe87dea617",
  "Reason": "sample string 4",
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 5"
}

application/xml, text/xml

Sample: 
<RemovePatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Patient.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 5</OriginatedSystem>
  <PatientId>c340a7af-7a5a-40a7-bb85-25817d9c436e</PatientId>
  <PatientXRef>sample string 2</PatientXRef>
  <PracticeId>08990d59-a537-40f2-934b-ccbe87dea617</PracticeId>
  <Reason>sample string 4</Reason>
</RemovePatient>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'RemovePatient'.

Response Information

Resource Description

NodeId of the patient

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "77544f28-f41d-4c9a-8deb-c1799952e709",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>77544f28-f41d-4c9a-8deb-c1799952e709</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>