POST api/PatientMedications

Request Information

URI Parameters

None.

Body Parameters

PatientMedication
NameDescriptionTypeAdditional information
ID

integer

None.

CPI

string

None.

MED_ID

integer

None.

DIV_ID

integer

None.

START_DATE

date

None.

STOP_DATE

date

None.

DOSAGE

string

None.

UNITS

string

None.

FREQUENCY

string

None.

PRN

boolean

None.

CRITICAL

boolean

None.

ACTIVE

boolean

None.

ENTR_DATE

date

None.

ENTR_BY

string

None.

HOLD_DATE

date

None.

HOLD_UNTIL

date

None.

BRAND_ID

integer

None.

ROUTE

string

None.

TAB_SIZE

string

None.

NOTE

string

None.

NUM_TABLETS

decimal number

None.

OLD

integer

None.

brand

MedicationBrand

None.

medication

Medication

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "CPI": "sample string 2",
  "MED_ID": 3,
  "DIV_ID": 4,
  "START_DATE": "2025-08-25T15:07:47.5433343+00:00",
  "STOP_DATE": "2025-08-25T15:07:47.5433343+00:00",
  "DOSAGE": "sample string 5",
  "UNITS": "sample string 6",
  "FREQUENCY": "sample string 7",
  "PRN": true,
  "CRITICAL": true,
  "ACTIVE": true,
  "ENTR_DATE": "2025-08-25T15:07:47.5433343+00:00",
  "ENTR_BY": "sample string 12",
  "HOLD_DATE": "2025-08-25T15:07:47.5433343+00:00",
  "HOLD_UNTIL": "2025-08-25T15:07:47.5433343+00:00",
  "BRAND_ID": 1,
  "ROUTE": "sample string 13",
  "TAB_SIZE": "sample string 14",
  "NOTE": "sample string 15",
  "NUM_TABLETS": 1.0,
  "OLD": 1,
  "brand": {
    "ID": 1,
    "BRAND_NAME": "sample string 2",
    "MED_ID": 3,
    "SIZE": "sample string 4",
    "UNIT": "sample string 5",
    "FORM": "sample string 6",
    "ROUTE": "sample string 7",
    "OLD": 1
  },
  "medication": {
    "MED_ID": 1,
    "GENERIC_NAME": "sample string 2",
    "DIV_ID": 3,
    "OLD": 1,
    "brands": [
      {
        "ID": 1,
        "BRAND_NAME": "sample string 2",
        "MED_ID": 3,
        "SIZE": "sample string 4",
        "UNIT": "sample string 5",
        "FORM": "sample string 6",
        "ROUTE": "sample string 7",
        "OLD": 1
      },
      {
        "ID": 1,
        "BRAND_NAME": "sample string 2",
        "MED_ID": 3,
        "SIZE": "sample string 4",
        "UNIT": "sample string 5",
        "FORM": "sample string 6",
        "ROUTE": "sample string 7",
        "OLD": 1
      }
    ]
  }
}

application/octet-stream

Sample:
{"ID":1,"CPI":"sample string 2","MED_ID":3,"DIV_ID":4,"START_DATE":"2025-08-25T15:07:47.5433343+00:00","STOP_DATE":"2025-08-25T15:07:47.5433343+00:00","DOSAGE":"sample string 5","UNITS":"sample string 6","FREQUENCY":"sample string 7","PRN":true,"CRITICAL":true,"ACTIVE":true,"ENTR_DATE":"2025-08-25T15:07:47.5433343+00:00","ENTR_BY":"sample string 12","HOLD_DATE":"2025-08-25T15:07:47.5433343+00:00","HOLD_UNTIL":"2025-08-25T15:07:47.5433343+00:00","BRAND_ID":1,"ROUTE":"sample string 13","TAB_SIZE":"sample string 14","NOTE":"sample string 15","NUM_TABLETS":1.0,"OLD":1,"brand":{"ID":1,"BRAND_NAME":"sample string 2","MED_ID":3,"SIZE":"sample string 4","UNIT":"sample string 5","FORM":"sample string 6","ROUTE":"sample string 7","OLD":1},"medication":{"MED_ID":1,"GENERIC_NAME":"sample string 2","DIV_ID":3,"OLD":1,"brands":[{"ID":1,"BRAND_NAME":"sample string 2","MED_ID":3,"SIZE":"sample string 4","UNIT":"sample string 5","FORM":"sample string 6","ROUTE":"sample string 7","OLD":1},{"ID":1,"BRAND_NAME":"sample string 2","MED_ID":3,"SIZE":"sample string 4","UNIT":"sample string 5","FORM":"sample string 6","ROUTE":"sample string 7","OLD":1}]}}

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

Response Information

Resource Description

PatientMedication
NameDescriptionTypeAdditional information
ID

integer

None.

CPI

string

None.

MED_ID

integer

None.

DIV_ID

integer

None.

START_DATE

date

None.

STOP_DATE

date

None.

DOSAGE

string

None.

UNITS

string

None.

FREQUENCY

string

None.

PRN

boolean

None.

CRITICAL

boolean

None.

ACTIVE

boolean

None.

ENTR_DATE

date

None.

ENTR_BY

string

None.

HOLD_DATE

date

None.

HOLD_UNTIL

date

None.

BRAND_ID

integer

None.

ROUTE

string

None.

TAB_SIZE

string

None.

NOTE

string

None.

NUM_TABLETS

decimal number

None.

OLD

integer

None.

brand

MedicationBrand

None.

medication

Medication

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "CPI": "sample string 2",
  "MED_ID": 3,
  "DIV_ID": 4,
  "START_DATE": "2025-08-25T15:07:47.5911933+00:00",
  "STOP_DATE": "2025-08-25T15:07:47.5911933+00:00",
  "DOSAGE": "sample string 5",
  "UNITS": "sample string 6",
  "FREQUENCY": "sample string 7",
  "PRN": true,
  "CRITICAL": true,
  "ACTIVE": true,
  "ENTR_DATE": "2025-08-25T15:07:47.5911933+00:00",
  "ENTR_BY": "sample string 12",
  "HOLD_DATE": "2025-08-25T15:07:47.5911933+00:00",
  "HOLD_UNTIL": "2025-08-25T15:07:47.5911933+00:00",
  "BRAND_ID": 1,
  "ROUTE": "sample string 13",
  "TAB_SIZE": "sample string 14",
  "NOTE": "sample string 15",
  "NUM_TABLETS": 1.0,
  "OLD": 1,
  "brand": {
    "ID": 1,
    "BRAND_NAME": "sample string 2",
    "MED_ID": 3,
    "SIZE": "sample string 4",
    "UNIT": "sample string 5",
    "FORM": "sample string 6",
    "ROUTE": "sample string 7",
    "OLD": 1
  },
  "medication": {
    "MED_ID": 1,
    "GENERIC_NAME": "sample string 2",
    "DIV_ID": 3,
    "OLD": 1,
    "brands": [
      {
        "ID": 1,
        "BRAND_NAME": "sample string 2",
        "MED_ID": 3,
        "SIZE": "sample string 4",
        "UNIT": "sample string 5",
        "FORM": "sample string 6",
        "ROUTE": "sample string 7",
        "OLD": 1
      },
      {
        "ID": 1,
        "BRAND_NAME": "sample string 2",
        "MED_ID": 3,
        "SIZE": "sample string 4",
        "UNIT": "sample string 5",
        "FORM": "sample string 6",
        "ROUTE": "sample string 7",
        "OLD": 1
      }
    ]
  }
}

application/octet-stream

Sample:
{"ID":1,"CPI":"sample string 2","MED_ID":3,"DIV_ID":4,"START_DATE":"2025-08-25T15:07:47.5911933+00:00","STOP_DATE":"2025-08-25T15:07:47.5911933+00:00","DOSAGE":"sample string 5","UNITS":"sample string 6","FREQUENCY":"sample string 7","PRN":true,"CRITICAL":true,"ACTIVE":true,"ENTR_DATE":"2025-08-25T15:07:47.5911933+00:00","ENTR_BY":"sample string 12","HOLD_DATE":"2025-08-25T15:07:47.5911933+00:00","HOLD_UNTIL":"2025-08-25T15:07:47.5911933+00:00","BRAND_ID":1,"ROUTE":"sample string 13","TAB_SIZE":"sample string 14","NOTE":"sample string 15","NUM_TABLETS":1.0,"OLD":1,"brand":{"ID":1,"BRAND_NAME":"sample string 2","MED_ID":3,"SIZE":"sample string 4","UNIT":"sample string 5","FORM":"sample string 6","ROUTE":"sample string 7","OLD":1},"medication":{"MED_ID":1,"GENERIC_NAME":"sample string 2","DIV_ID":3,"OLD":1,"brands":[{"ID":1,"BRAND_NAME":"sample string 2","MED_ID":3,"SIZE":"sample string 4","UNIT":"sample string 5","FORM":"sample string 6","ROUTE":"sample string 7","OLD":1},{"ID":1,"BRAND_NAME":"sample string 2","MED_ID":3,"SIZE":"sample string 4","UNIT":"sample string 5","FORM":"sample string 6","ROUTE":"sample string 7","OLD":1}]}}