POST api/v1/xref/{tenantXRef}/patient/inactivate

Delete an existing patient in a practice (by business xref)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantXRef

ref key of the practice that owns the patient data

 string

Required

Body Parameters

The patient object

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.ExternalSystemIntegration.Model.RemovePatientRequest
NameDescriptionTypeAdditional information
BillingPracticeNo

string

None.
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: 
{
  "BillingPracticeNo": "sample string 1",
  "PatientId": "f0aed702-42f7-4f8b-a17b-2db25c3c18a8",
  "PatientXRef": "sample string 3",
  "PracticeId": "8fdf3864-f7b2-43e6-8def-a434e4491036",
  "Reason": "sample string 5",
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 6"
}

application/xml, text/xml

Sample: 
<RemovePatientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.ExternalSystemIntegration.Model">
  <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 6</OriginatedSystem>
  <PatientId xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Patient.Interface.Commands">f0aed702-42f7-4f8b-a17b-2db25c3c18a8</PatientId>
  <PatientXRef xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Patient.Interface.Commands">sample string 3</PatientXRef>
  <PracticeId xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Patient.Interface.Commands">8fdf3864-f7b2-43e6-8def-a434e4491036</PracticeId>
  <Reason xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Patient.Interface.Commands">sample string 5</Reason>
  <BillingPracticeNo>sample string 1</BillingPracticeNo>
</RemovePatientRequest>

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 'RemovePatientRequest'.

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": "ab3b355d-86cf-4dd2-9be9-682938681734",
  "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>ab3b355d-86cf-4dd2-9be9-682938681734</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>