POST api/v2/{providerId}/clinical/patient/{patientId}/prescription

Add prescription to be shown on patient timeline

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required

patientId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescription
NameDescriptionTypeAdditional information
MedicationPrescriptionId

Medication Prescription identifier

globally unique identifier

None.

IssuedDate

Date when medication prescription was issued

date

None.

Name

string

None.

FutureDate

date

None.

Provider

Provider that has made the prescription

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.ProviderVo

None.

Patient

Patient visit event details (who was the patient, when the the event occurred, accounting details)

Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo

None.

MedicationPrescriptionLines

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescriptionLine

None.

PracticeId

globally unique identifier

None.

HtmlBody

string

None.

IncludeSignature

boolean

None.

IsOriginalScript

boolean

None.

ExcludeReportDate

boolean

None.

AdditionalNotes

string

None.

OrderNumber

string

None.

PatientAllergies

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "MedicationPrescriptionId": "7c608463-d87a-41d3-8424-977dfadc77c0",
  "IssuedDate": "2025-04-12T00:26:34Z",
  "Name": "sample string 3",
  "FutureDate": "2025-04-12T00:26:34Z",
  "Provider": {
    "PracticeType": "sample string 1",
    "PracticeName": "sample string 2",
    "SpecialityCode": "sample string 3",
    "SubSpecialityCode": "sample string 4",
    "PracticeNumber": "sample string 5",
    "TreatingDoctorName": "sample string 6",
    "TreatingDoctorPracticeNumber": "sample string 7",
    "DispensingDoctor": "sample string 8",
    "DispensingLicenseNumber": "sample string 9",
    "HPCSANumber": "sample string 10",
    "ContactNumber": "sample string 11",
    "Qualification": "sample string 12",
    "SpecialityDescription": "sample string 13",
    "TelephoneNumber": "sample string 14",
    "FaxNumber": "sample string 15",
    "CellphoneNumber": "sample string 16",
    "EmailAddress": "sample string 17",
    "PhysicalAddress": "sample string 18",
    "PostalAddress": "sample string 19",
    "IsLocumProvider": true
  },
  "Patient": {
    "PatientId": "d4495ae2-ce1b-4473-b595-076f122b0f82",
    "PatientXRef": "sample string 2",
    "PracticeId": "c4c716c2-756a-456c-86e9-b8e2e1e04157",
    "FileNo": "sample string 4",
    "KnownAs": "sample string 5",
    "Occupation": "sample string 6",
    "Employer": "sample string 7",
    "PreferredLanguage": "sample string 8",
    "MaritalStatus": "sample string 9",
    "PatientDetails": {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "Surname": "sample string 3",
      "DateOfBirth": "2025-04-12T00:26:34Z",
      "IdentityNo": "sample string 5",
      "Gender": "sample string 6",
      "ContactNo": "sample string 7",
      "EmailAddress": "sample string 8"
    },
    "PatientAccountDetails": {
      "AccountId": "d9135262-6a92-4d2b-8f3f-93ece1183baa",
      "AccountNo": "sample string 2",
      "IsCashAccount": true,
      "MedicalAidName": "sample string 4",
      "MedicalAidPlan": "sample string 5",
      "MedicalAidPlanOption": "sample string 6",
      "MedicalAidMembershipNumber": "sample string 7",
      "MedicalAidDependentCode": "sample string 8",
      "MedicalAidMainMemberDetails": {
        "Title": "sample string 1",
        "FirstName": "sample string 2",
        "Surname": "sample string 3",
        "DateOfBirth": "2025-04-12T00:26:34Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "MedicalAidRoutingCode": "sample string 9",
      "MedicalAidOptionCode": "sample string 10",
      "MedicalAidSchemeCode": "sample string 11",
      "MedicalAidPlanCode": "sample string 12"
    },
    "PhysicalAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "Code": "sample string 4"
    },
    "PostalAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "Code": "sample string 4"
    },
    "Deceased": true
  },
  "MedicationPrescriptionLines": [
    {
      "Quantity": 1,
      "LineNum": 2,
      "MedicationDescription": "sample string 3",
      "NappiCode": "sample string 4",
      "DosageUnits": 5.0,
      "DosageType": "sample string 6",
      "FrequencyUnits": 7,
      "FrequencyMax": 8,
      "PeriodUnit": 9,
      "PeriodType": "sample string 10",
      "DurationUnit": 11,
      "DurationType": "sample string 12",
      "Repeat": 13,
      "ChronicIndicator": true,
      "AllowGeneric": true,
      "Diagnosis": [
        {
          "Id": "57923c74-ac82-4caf-ac03-ca9acad0cf6c",
          "DiagnosisCode": "sample string 2",
          "DiagnosisDescription": "sample string 3",
          "SpecificCode": true,
          "PrimaryIndicator": true,
          "ValidPrimary": true,
          "ValidSequelae": true,
          "MaxSpecificity": true,
          "Gender": "sample string 9",
          "AgeRangeStart": 1,
          "AgeRangeEnd": 1,
          "DiagnosisToken": "sample string 10",
          "DiagnosisTokenDescription": "sample string 11",
          "IcdSource": "sample string 12",
          "OrderNo": 13
        },
        {
          "Id": "57923c74-ac82-4caf-ac03-ca9acad0cf6c",
          "DiagnosisCode": "sample string 2",
          "DiagnosisDescription": "sample string 3",
          "SpecificCode": true,
          "PrimaryIndicator": true,
          "ValidPrimary": true,
          "ValidSequelae": true,
          "MaxSpecificity": true,
          "Gender": "sample string 9",
          "AgeRangeStart": 1,
          "AgeRangeEnd": 1,
          "DiagnosisToken": "sample string 10",
          "DiagnosisTokenDescription": "sample string 11",
          "IcdSource": "sample string 12",
          "OrderNo": 13
        }
      ],
      "DispensingInstructions": "sample string 16",
      "AdministrationInstructions": "sample string 17",
      "Description": "sample string 18",
      "CreatedFrom": "sample string 19",
      "AccelerateLearning": true,
      "Parameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "Quantity": 1,
      "LineNum": 2,
      "MedicationDescription": "sample string 3",
      "NappiCode": "sample string 4",
      "DosageUnits": 5.0,
      "DosageType": "sample string 6",
      "FrequencyUnits": 7,
      "FrequencyMax": 8,
      "PeriodUnit": 9,
      "PeriodType": "sample string 10",
      "DurationUnit": 11,
      "DurationType": "sample string 12",
      "Repeat": 13,
      "ChronicIndicator": true,
      "AllowGeneric": true,
      "Diagnosis": [
        {
          "Id": "57923c74-ac82-4caf-ac03-ca9acad0cf6c",
          "DiagnosisCode": "sample string 2",
          "DiagnosisDescription": "sample string 3",
          "SpecificCode": true,
          "PrimaryIndicator": true,
          "ValidPrimary": true,
          "ValidSequelae": true,
          "MaxSpecificity": true,
          "Gender": "sample string 9",
          "AgeRangeStart": 1,
          "AgeRangeEnd": 1,
          "DiagnosisToken": "sample string 10",
          "DiagnosisTokenDescription": "sample string 11",
          "IcdSource": "sample string 12",
          "OrderNo": 13
        },
        {
          "Id": "57923c74-ac82-4caf-ac03-ca9acad0cf6c",
          "DiagnosisCode": "sample string 2",
          "DiagnosisDescription": "sample string 3",
          "SpecificCode": true,
          "PrimaryIndicator": true,
          "ValidPrimary": true,
          "ValidSequelae": true,
          "MaxSpecificity": true,
          "Gender": "sample string 9",
          "AgeRangeStart": 1,
          "AgeRangeEnd": 1,
          "DiagnosisToken": "sample string 10",
          "DiagnosisTokenDescription": "sample string 11",
          "IcdSource": "sample string 12",
          "OrderNo": 13
        }
      ],
      "DispensingInstructions": "sample string 16",
      "AdministrationInstructions": "sample string 17",
      "Description": "sample string 18",
      "CreatedFrom": "sample string 19",
      "AccelerateLearning": true,
      "Parameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "PracticeId": "7e8d9b17-f6b9-41f4-b68a-bdebf28661ae",
  "HtmlBody": "sample string 6",
  "IncludeSignature": true,
  "IsOriginalScript": true,
  "ExcludeReportDate": true,
  "AdditionalNotes": "sample string 10",
  "OrderNumber": "sample string 11",
  "PatientAllergies": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<MedicationPrescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/clinical/v1/medicationprescription/">
  <AdditionalNotes>sample string 10</AdditionalNotes>
  <ExcludeReportDate>true</ExcludeReportDate>
  <FutureDate>2025-04-12T00:26:34.9619638+02:00</FutureDate>
  <HtmlBody>sample string 6</HtmlBody>
  <IncludeSignature>true</IncludeSignature>
  <IsOriginalScript>true</IsOriginalScript>
  <IssuedDate>2025-04-12T00:26:34.9619638+02:00</IssuedDate>
  <MedicationPrescriptionId>7c608463-d87a-41d3-8424-977dfadc77c0</MedicationPrescriptionId>
  <MedicationPrescriptionLines>
    <MedicationPrescriptionLine>
      <AccelerateLearning>true</AccelerateLearning>
      <AdministrationInstructions>sample string 17</AdministrationInstructions>
      <AllowGeneric>true</AllowGeneric>
      <ChronicIndicator>true</ChronicIndicator>
      <CreatedFrom>sample string 19</CreatedFrom>
      <Description>sample string 18</Description>
      <Diagnosis xmlns:d4p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
        <d4p1:Diagnosis>
          <d4p1:AgeRangeEnd>1</d4p1:AgeRangeEnd>
          <d4p1:AgeRangeStart>1</d4p1:AgeRangeStart>
          <d4p1:DiagnosisCode>sample string 2</d4p1:DiagnosisCode>
          <d4p1:DiagnosisDescription>sample string 3</d4p1:DiagnosisDescription>
          <d4p1:DiagnosisToken>sample string 10</d4p1:DiagnosisToken>
          <d4p1:DiagnosisTokenDescription>sample string 11</d4p1:DiagnosisTokenDescription>
          <d4p1:Gender>sample string 9</d4p1:Gender>
          <d4p1:IcdSource>sample string 12</d4p1:IcdSource>
          <d4p1:Id>57923c74-ac82-4caf-ac03-ca9acad0cf6c</d4p1:Id>
          <d4p1:MaxSpecificity>true</d4p1:MaxSpecificity>
          <d4p1:OrderNo>13</d4p1:OrderNo>
          <d4p1:PrimaryIndicator>true</d4p1:PrimaryIndicator>
          <d4p1:SpecificCode>true</d4p1:SpecificCode>
          <d4p1:ValidPrimary>true</d4p1:ValidPrimary>
          <d4p1:ValidSequelae>true</d4p1:ValidSequelae>
        </d4p1:Diagnosis>
        <d4p1:Diagnosis>
          <d4p1:AgeRangeEnd>1</d4p1:AgeRangeEnd>
          <d4p1:AgeRangeStart>1</d4p1:AgeRangeStart>
          <d4p1:DiagnosisCode>sample string 2</d4p1:DiagnosisCode>
          <d4p1:DiagnosisDescription>sample string 3</d4p1:DiagnosisDescription>
          <d4p1:DiagnosisToken>sample string 10</d4p1:DiagnosisToken>
          <d4p1:DiagnosisTokenDescription>sample string 11</d4p1:DiagnosisTokenDescription>
          <d4p1:Gender>sample string 9</d4p1:Gender>
          <d4p1:IcdSource>sample string 12</d4p1:IcdSource>
          <d4p1:Id>57923c74-ac82-4caf-ac03-ca9acad0cf6c</d4p1:Id>
          <d4p1:MaxSpecificity>true</d4p1:MaxSpecificity>
          <d4p1:OrderNo>13</d4p1:OrderNo>
          <d4p1:PrimaryIndicator>true</d4p1:PrimaryIndicator>
          <d4p1:SpecificCode>true</d4p1:SpecificCode>
          <d4p1:ValidPrimary>true</d4p1:ValidPrimary>
          <d4p1:ValidSequelae>true</d4p1:ValidSequelae>
        </d4p1:Diagnosis>
      </Diagnosis>
      <DispensingInstructions>sample string 16</DispensingInstructions>
      <DosageType>sample string 6</DosageType>
      <DosageUnits>5</DosageUnits>
      <DurationType>sample string 12</DurationType>
      <DurationUnit>11</DurationUnit>
      <FrequencyMax>8</FrequencyMax>
      <FrequencyUnits>7</FrequencyUnits>
      <LineNum>2</LineNum>
      <MedicationDescription>sample string 3</MedicationDescription>
      <NappiCode>sample string 4</NappiCode>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Parameters>
      <PeriodType>sample string 10</PeriodType>
      <PeriodUnit>9</PeriodUnit>
      <Quantity>1</Quantity>
      <Repeat>13</Repeat>
    </MedicationPrescriptionLine>
    <MedicationPrescriptionLine>
      <AccelerateLearning>true</AccelerateLearning>
      <AdministrationInstructions>sample string 17</AdministrationInstructions>
      <AllowGeneric>true</AllowGeneric>
      <ChronicIndicator>true</ChronicIndicator>
      <CreatedFrom>sample string 19</CreatedFrom>
      <Description>sample string 18</Description>
      <Diagnosis xmlns:d4p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
        <d4p1:Diagnosis>
          <d4p1:AgeRangeEnd>1</d4p1:AgeRangeEnd>
          <d4p1:AgeRangeStart>1</d4p1:AgeRangeStart>
          <d4p1:DiagnosisCode>sample string 2</d4p1:DiagnosisCode>
          <d4p1:DiagnosisDescription>sample string 3</d4p1:DiagnosisDescription>
          <d4p1:DiagnosisToken>sample string 10</d4p1:DiagnosisToken>
          <d4p1:DiagnosisTokenDescription>sample string 11</d4p1:DiagnosisTokenDescription>
          <d4p1:Gender>sample string 9</d4p1:Gender>
          <d4p1:IcdSource>sample string 12</d4p1:IcdSource>
          <d4p1:Id>57923c74-ac82-4caf-ac03-ca9acad0cf6c</d4p1:Id>
          <d4p1:MaxSpecificity>true</d4p1:MaxSpecificity>
          <d4p1:OrderNo>13</d4p1:OrderNo>
          <d4p1:PrimaryIndicator>true</d4p1:PrimaryIndicator>
          <d4p1:SpecificCode>true</d4p1:SpecificCode>
          <d4p1:ValidPrimary>true</d4p1:ValidPrimary>
          <d4p1:ValidSequelae>true</d4p1:ValidSequelae>
        </d4p1:Diagnosis>
        <d4p1:Diagnosis>
          <d4p1:AgeRangeEnd>1</d4p1:AgeRangeEnd>
          <d4p1:AgeRangeStart>1</d4p1:AgeRangeStart>
          <d4p1:DiagnosisCode>sample string 2</d4p1:DiagnosisCode>
          <d4p1:DiagnosisDescription>sample string 3</d4p1:DiagnosisDescription>
          <d4p1:DiagnosisToken>sample string 10</d4p1:DiagnosisToken>
          <d4p1:DiagnosisTokenDescription>sample string 11</d4p1:DiagnosisTokenDescription>
          <d4p1:Gender>sample string 9</d4p1:Gender>
          <d4p1:IcdSource>sample string 12</d4p1:IcdSource>
          <d4p1:Id>57923c74-ac82-4caf-ac03-ca9acad0cf6c</d4p1:Id>
          <d4p1:MaxSpecificity>true</d4p1:MaxSpecificity>
          <d4p1:OrderNo>13</d4p1:OrderNo>
          <d4p1:PrimaryIndicator>true</d4p1:PrimaryIndicator>
          <d4p1:SpecificCode>true</d4p1:SpecificCode>
          <d4p1:ValidPrimary>true</d4p1:ValidPrimary>
          <d4p1:ValidSequelae>true</d4p1:ValidSequelae>
        </d4p1:Diagnosis>
      </Diagnosis>
      <DispensingInstructions>sample string 16</DispensingInstructions>
      <DosageType>sample string 6</DosageType>
      <DosageUnits>5</DosageUnits>
      <DurationType>sample string 12</DurationType>
      <DurationUnit>11</DurationUnit>
      <FrequencyMax>8</FrequencyMax>
      <FrequencyUnits>7</FrequencyUnits>
      <LineNum>2</LineNum>
      <MedicationDescription>sample string 3</MedicationDescription>
      <NappiCode>sample string 4</NappiCode>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Parameters>
      <PeriodType>sample string 10</PeriodType>
      <PeriodUnit>9</PeriodUnit>
      <Quantity>1</Quantity>
      <Repeat>13</Repeat>
    </MedicationPrescriptionLine>
  </MedicationPrescriptionLines>
  <Name>sample string 3</Name>
  <OrderNumber>sample string 11</OrderNumber>
  <Patient xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
    <d2p1:Deceased>true</d2p1:Deceased>
    <d2p1:Employer>sample string 7</d2p1:Employer>
    <d2p1:FileNo>sample string 4</d2p1:FileNo>
    <d2p1:KnownAs>sample string 5</d2p1:KnownAs>
    <d2p1:MaritalStatus>sample string 9</d2p1:MaritalStatus>
    <d2p1:Occupation>sample string 6</d2p1:Occupation>
    <d2p1:PatientAccountDetails>
      <d2p1:AccountId>d9135262-6a92-4d2b-8f3f-93ece1183baa</d2p1:AccountId>
      <d2p1:AccountNo>sample string 2</d2p1:AccountNo>
      <d2p1:IsCashAccount>true</d2p1:IsCashAccount>
      <d2p1:MedicalAidDependentCode>sample string 8</d2p1:MedicalAidDependentCode>
      <d2p1:MedicalAidMainMemberDetails>
        <d2p1:ContactNo>sample string 7</d2p1:ContactNo>
        <d2p1:DateOfBirth>2025-04-12T00:26:34.9619638+02:00</d2p1:DateOfBirth>
        <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:Gender>sample string 6</d2p1:Gender>
        <d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
        <d2p1:Surname>sample string 3</d2p1:Surname>
        <d2p1:Title>sample string 1</d2p1:Title>
      </d2p1:MedicalAidMainMemberDetails>
      <d2p1:MedicalAidMembershipNumber>sample string 7</d2p1:MedicalAidMembershipNumber>
      <d2p1:MedicalAidName>sample string 4</d2p1:MedicalAidName>
      <d2p1:MedicalAidOptionCode>sample string 10</d2p1:MedicalAidOptionCode>
      <d2p1:MedicalAidPlan>sample string 5</d2p1:MedicalAidPlan>
      <d2p1:MedicalAidPlanCode>sample string 12</d2p1:MedicalAidPlanCode>
      <d2p1:MedicalAidPlanOption>sample string 6</d2p1:MedicalAidPlanOption>
      <d2p1:MedicalAidRoutingCode>sample string 9</d2p1:MedicalAidRoutingCode>
      <d2p1:MedicalAidSchemeCode>sample string 11</d2p1:MedicalAidSchemeCode>
    </d2p1:PatientAccountDetails>
    <d2p1:PatientDetails>
      <d2p1:ContactNo>sample string 7</d2p1:ContactNo>
      <d2p1:DateOfBirth>2025-04-12T00:26:34.9619638+02:00</d2p1:DateOfBirth>
      <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:Gender>sample string 6</d2p1:Gender>
      <d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
      <d2p1:Surname>sample string 3</d2p1:Surname>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:PatientDetails>
    <d2p1:PatientId>d4495ae2-ce1b-4473-b595-076f122b0f82</d2p1:PatientId>
    <d2p1:PatientXRef>sample string 2</d2p1:PatientXRef>
    <d2p1:PhysicalAddress>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Line1>sample string 1</d2p1:Line1>
      <d2p1:Line2>sample string 2</d2p1:Line2>
      <d2p1:Line3>sample string 3</d2p1:Line3>
    </d2p1:PhysicalAddress>
    <d2p1:PostalAddress>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Line1>sample string 1</d2p1:Line1>
      <d2p1:Line2>sample string 2</d2p1:Line2>
      <d2p1:Line3>sample string 3</d2p1:Line3>
    </d2p1:PostalAddress>
    <d2p1:PracticeId>c4c716c2-756a-456c-86e9-b8e2e1e04157</d2p1:PracticeId>
    <d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage>
  </Patient>
  <PatientAllergies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PatientAllergies>
  <PracticeId>7e8d9b17-f6b9-41f4-b68a-bdebf28661ae</PracticeId>
  <Provider xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
    <d2p1:CellphoneNumber>sample string 16</d2p1:CellphoneNumber>
    <d2p1:ContactNumber>sample string 11</d2p1:ContactNumber>
    <d2p1:DispensingDoctor>sample string 8</d2p1:DispensingDoctor>
    <d2p1:DispensingLicenseNumber>sample string 9</d2p1:DispensingLicenseNumber>
    <d2p1:EmailAddress>sample string 17</d2p1:EmailAddress>
    <d2p1:FaxNumber>sample string 15</d2p1:FaxNumber>
    <d2p1:HPCSANumber>sample string 10</d2p1:HPCSANumber>
    <d2p1:IsLocumProvider>true</d2p1:IsLocumProvider>
    <d2p1:PhysicalAddress>sample string 18</d2p1:PhysicalAddress>
    <d2p1:PostalAddress>sample string 19</d2p1:PostalAddress>
    <d2p1:PracticeName>sample string 2</d2p1:PracticeName>
    <d2p1:PracticeNumber>sample string 5</d2p1:PracticeNumber>
    <d2p1:PracticeType>sample string 1</d2p1:PracticeType>
    <d2p1:Qualification>sample string 12</d2p1:Qualification>
    <d2p1:SpecialityCode>sample string 3</d2p1:SpecialityCode>
    <d2p1:SpecialityDescription>sample string 13</d2p1:SpecialityDescription>
    <d2p1:SubSpecialityCode>sample string 4</d2p1:SubSpecialityCode>
    <d2p1:TelephoneNumber>sample string 14</d2p1:TelephoneNumber>
    <d2p1:TreatingDoctorName>sample string 6</d2p1:TreatingDoctorName>
    <d2p1:TreatingDoctorPracticeNumber>sample string 7</d2p1:TreatingDoctorPracticeNumber>
  </Provider>
</MedicationPrescription>

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

Response Information

Resource Description

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

boolean

None.

ResponseCode

integer

None.

ResponseMessage

string

None.

Data

string

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": "sample string 4",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<RestApiResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>sample string 4</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>
</RestApiResultOfstring>