GET PlanCare2Api/EvsMedication/FarMedRxPrescription?clientId={clientId}&type={type}

Retrieves Farmed Client prescription information When parsing the information from FarMed fails a HttpStatusCode.UnprocessableEntity (422) will be returned

Request Information

URI Parameters

Name Description Type Additional information
clientId

PlanCare internal Client identifier

integer

Required

type

FarMed Format Type value: mo (voorschriftquery) or rx (voorschriftquerypoli)

string

Required

Body Parameters

None.

Response Information

Resource Description

Prescription record

Prescription
Name Description Type Additional information
Patient

Patient information as known in the EVS

Patient

-

Contraindications

Contraindications known for the patient

Collection of string

-

Allergies

Known allergies of the patient

Collection of string

-

Medication

Current and or previous medication prescriptions

Collection of Medication

-

Error

Error message returned by the EVS

string

-

Response Formats

application/json, text/json

Sample:
{
  "Patient": {
    "$id": "2",
    "Initials": "sample string 1",
    "Preposition": "sample string 2",
    "LastName": "sample string 3",
    "Gender": "sample string 4",
    "DateOfBirth": "sample string 5",
    "InternalPatientId": "sample string 6"
  },
  "Contraindications": [
    "sample string 1",
    "sample string 2"
  ],
  "Allergies": [
    "sample string 1",
    "sample string 2"
  ],
  "Medication": [
    {
      "$id": "3",
      "StartDate": "sample string 1",
      "EndDate": "sample string 2",
      "Id": 3,
      "GenericName": "sample string 4",
      "Dosage": {
        "$id": "4",
        "Description": "sample string 1",
        "MostRecentOrder": {
          "$id": "5",
          "Id": 1,
          "StartDate": "sample string 2",
          "EndDate": "sample string 3"
        },
        "RepetitionTimes": 2.1,
        "RepetitionUnit": "sample string 3",
        "Count": 4.1,
        "UnitSingular": "sample string 5",
        "UnitPlural": "sample string 6",
        "AdditionalText": "sample string 7",
        "FreeText": "sample string 8",
        "NurseTimes": "sample string 9",
        "NurseCount": "sample string 10",
        "InfuseKind": "sample string 11",
        "DropCount": "sample string 12",
        "DropUnit": "sample string 13",
        "SchemeName": "sample string 14",
        "SchemeId": "sample string 15",
        "SchemeSequenceNumber": "sample string 16",
        "Rhythm": "sample string 17",
        "RouteOfAdministration": "sample string 18"
      },
      "Prescriber": "sample string 5"
    },
    {
      "$ref": "3"
    }
  ],
  "Error": "sample string 1"
}

application/xml, text/xml

Sample:
<Prescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.EVSMedication">
  <Allergies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Allergies>
  <Contraindications xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Contraindications>
  <Error>sample string 1</Error>
  <Medication>
    <Medication>
      <Dosage>
        <AdditionalText>sample string 7</AdditionalText>
        <Count>4.1</Count>
        <Description>sample string 1</Description>
        <DropCount>sample string 12</DropCount>
        <DropUnit>sample string 13</DropUnit>
        <FreeText>sample string 8</FreeText>
        <InfuseKind>sample string 11</InfuseKind>
        <MostRecentOrder>
          <EndDate>sample string 3</EndDate>
          <Id>1</Id>
          <StartDate>sample string 2</StartDate>
        </MostRecentOrder>
        <NurseCount>sample string 10</NurseCount>
        <NurseTimes>sample string 9</NurseTimes>
        <RepetitionTimes>2.1</RepetitionTimes>
        <RepetitionUnit>sample string 3</RepetitionUnit>
        <Rhythm>sample string 17</Rhythm>
        <RouteOfAdministration>sample string 18</RouteOfAdministration>
        <SchemeId>sample string 15</SchemeId>
        <SchemeName>sample string 14</SchemeName>
        <SchemeSequenceNumber>sample string 16</SchemeSequenceNumber>
        <UnitPlural>sample string 6</UnitPlural>
        <UnitSingular>sample string 5</UnitSingular>
      </Dosage>
      <EndDate>sample string 2</EndDate>
      <GenericName>sample string 4</GenericName>
      <Id>3</Id>
      <Prescriber>sample string 5</Prescriber>
      <StartDate>sample string 1</StartDate>
    </Medication>
    <Medication>
      <Dosage>
        <AdditionalText>sample string 7</AdditionalText>
        <Count>4.1</Count>
        <Description>sample string 1</Description>
        <DropCount>sample string 12</DropCount>
        <DropUnit>sample string 13</DropUnit>
        <FreeText>sample string 8</FreeText>
        <InfuseKind>sample string 11</InfuseKind>
        <MostRecentOrder>
          <EndDate>sample string 3</EndDate>
          <Id>1</Id>
          <StartDate>sample string 2</StartDate>
        </MostRecentOrder>
        <NurseCount>sample string 10</NurseCount>
        <NurseTimes>sample string 9</NurseTimes>
        <RepetitionTimes>2.1</RepetitionTimes>
        <RepetitionUnit>sample string 3</RepetitionUnit>
        <Rhythm>sample string 17</Rhythm>
        <RouteOfAdministration>sample string 18</RouteOfAdministration>
        <SchemeId>sample string 15</SchemeId>
        <SchemeName>sample string 14</SchemeName>
        <SchemeSequenceNumber>sample string 16</SchemeSequenceNumber>
        <UnitPlural>sample string 6</UnitPlural>
        <UnitSingular>sample string 5</UnitSingular>
      </Dosage>
      <EndDate>sample string 2</EndDate>
      <GenericName>sample string 4</GenericName>
      <Id>3</Id>
      <Prescriber>sample string 5</Prescriber>
      <StartDate>sample string 1</StartDate>
    </Medication>
  </Medication>
  <Patient>
    <DateOfBirth>sample string 5</DateOfBirth>
    <Gender>sample string 4</Gender>
    <Initials>sample string 1</Initials>
    <InternalPatientId>sample string 6</InternalPatientId>
    <LastName>sample string 3</LastName>
    <Preposition>sample string 2</Preposition>
  </Patient>
</Prescription>