POST api/PatientMedications

Creates a new patient medication or updates an existent patient medication's information.

Request Information

URI Parameters

None.

Body Parameters

PatientMedicationUpdateModel
NameDescriptionTypeAdditional information
Name

Name of the medication (Required).

 string

None.
Instructions

Instructions of the medication (Required).

 string

None.
PatientExternalId

Patient externalId in the integrating system (Required).

 string

None.
DoctorExternalId

Doctor ID in the integrating system.

 string

None.
Active

Patient medication active.

 boolean

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "instructions": "sample string 2",
  "patientExternalId": "sample string 3",
  "doctorExternalId": "sample string 4",
  "active": true,
  "id": "4bfdfdc7-9995-43e2-91cc-f7b65e258b93",
  "externalId": "sample string 7"
}

application/xml, text/xml

Sample: 
<PatientMedicationUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PatientMedications">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 7</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">4bfdfdc7-9995-43e2-91cc-f7b65e258b93</Id>
  <Active>true</Active>
  <DoctorExternalId>sample string 4</DoctorExternalId>
  <Instructions>sample string 2</Instructions>
  <Name>sample string 1</Name>
  <PatientExternalId>sample string 3</PatientExternalId>
</PatientMedicationUpdateModel>

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

Response Information

Resource Description

PatientMedicationUpdateModel
NameDescriptionTypeAdditional information
Name

Name of the medication (Required).

 string

None.
Instructions

Instructions of the medication (Required).

 string

None.
PatientExternalId

Patient externalId in the integrating system (Required).

 string

None.
DoctorExternalId

Doctor ID in the integrating system.

 string

None.
Active

Patient medication active.

 boolean

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "instructions": "sample string 2",
  "patientExternalId": "sample string 3",
  "doctorExternalId": "sample string 4",
  "active": true,
  "id": "d97a4ae2-bf13-4cee-986e-9b4af13b46c5",
  "externalId": "sample string 7"
}

application/xml, text/xml

Sample: 
<PatientMedicationUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PatientMedications">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 7</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">d97a4ae2-bf13-4cee-986e-9b4af13b46c5</Id>
  <Active>true</Active>
  <DoctorExternalId>sample string 4</DoctorExternalId>
  <Instructions>sample string 2</Instructions>
  <Name>sample string 1</Name>
  <PatientExternalId>sample string 3</PatientExternalId>
</PatientMedicationUpdateModel>