POST api/ConvertPortalPatientToPatient

Converts a portal patient into a patient. If the patient does not exist, a new patient will be created. All the data of the portal patient will be transferred to the patient.

Request Information

URI Parameters

None.

Body Parameters

ConvertPortalPatientToPatientModel
NameDescriptionTypeAdditional information
PortalPatientId

Unique ID of the portal patient that will be converted to patient (Required).

 globally unique identifier

None.
PatientExternalId

Unique ID of the converted patient in the integrating system (Required).

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "portalPatientId": "8130df12-0302-4938-be12-c30eefbfd824",
  "patientExternalId": "sample string 2"
}

application/xml, text/xml

Sample: 
<ConvertPortalPatientToPatientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PortalPatients">
  <PatientExternalId>sample string 2</PatientExternalId>
  <PortalPatientId>8130df12-0302-4938-be12-c30eefbfd824</PortalPatientId>
</ConvertPortalPatientToPatientModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ConvertPortalPatientToPatientModel'.

Response Information

Resource Description

ConvertPortalPatientToPatientModel
NameDescriptionTypeAdditional information
PortalPatientId

Unique ID of the portal patient that will be converted to patient (Required).

 globally unique identifier

None.
PatientExternalId

Unique ID of the converted patient in the integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "portalPatientId": "aab6291b-e802-4593-b473-b43fc4714dbe",
  "patientExternalId": "sample string 2"
}

application/xml, text/xml

Sample: 
<ConvertPortalPatientToPatientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PortalPatients">
  <PatientExternalId>sample string 2</PatientExternalId>
  <PortalPatientId>aab6291b-e802-4593-b473-b43fc4714dbe</PortalPatientId>
</ConvertPortalPatientToPatientModel>