Infer

POST /v1/medications/infer

Infer

cURL

curl --request POST \
  --url https://api.example.com/v1/medications/infer \
  --header 'Content-Type: application/json' \
  --data '
{
  "resources": [
    {}
  ],
  "bundle": {},
  "as_of": "2023-11-07T05:31:56Z",
  "format": "inferred_list",
  "verbosity": "minimal",
  "statuses": [
    "active"
  ]
}
'

200

{
  "medications": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "status": "active",
      "confidence": 123,
      "rxnorm_code": "<string>",
      "rxnorm_system": "<string>",
      "sig": "<string>",
      "dosage": {
        "text": "<string>",
        "patient_instruction": "<string>",
        "timing": {
          "text": "<string>",
          "code": "<string>",
          "code_system": "<string>",
          "ncit_code": "<string>",
          "ncit_display": "<string>"
        },
        "when": [
          {
            "text": "<string>",
            "code": "<string>",
            "code_system": "<string>",
            "ncit_code": "<string>",
            "ncit_display": "<string>"
          }
        ],
        "duration": {
          "value": 123,
          "unit": "<string>",
          "display": "<string>"
        },
        "as_needed": true,
        "site": "<string>",
        "route": {
          "text": "<string>",
          "snomed_code": "<string>",
          "snomed_display": "<string>",
          "ncit_code": "<string>",
          "ncit_display": "<string>"
        },
        "method": {
          "text": "<string>",
          "snomed_code": "<string>",
          "snomed_display": "<string>",
          "ncit_code": "<string>",
          "ncit_display": "<string>"
        },
        "dose_quantity": {
          "value": 123,
          "unit": "<string>",
          "system": "<string>",
          "code": "<string>"
        },
        "dose_range": {
          "low_value": 123,
          "high_value": 123,
          "unit": "<string>"
        },
        "dose_form": "<string>"
      },
      "indication": {
        "text": "<string>",
        "snomed_code": "<string>",
        "snomed_display": "<string>",
        "icd10_code": "<string>",
        "icd10_display": "<string>"
      },
      "last_activity_date": "2023-11-07T05:31:56Z"
    }
  ],
  "provenance": {},
  "meta": {
    "request_id": "<string>",
    "ruleset_version": "<string>",
    "as_of": "2023-11-07T05:31:56Z",
    "processing_time_ms": 123,
    "input_resource_count": 123,
    "output_medication_count": 123
  }
}

Body

application/json

resources · Resources · object[]

bundle · Bundle · object

as_of · string<date-time> | null

format · enum<string> · default: inferred_list

Available options: inferred_list, us_core, bundle

verbosity · enum<string> · default: minimal

Available options: minimal, standard, full

statuses · enum<string>[] | null

Optional status filter. When present, only medications with an inferred status in this list are returned. When omitted, all statuses are returned.

Available options: active, completed, stopped, cancelled, unknown

Response

200

application/json

Successful Response

InferResponseFull

InferResponseStandard

InferResponseMinimal

medications · InferredMedicationStandard · object[] · required

Show child attributes

provenance · Provenance · object · required

Show child attributes

meta · InferMeta · object · required

Show child attributes