1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. MedicationRequest

Create a medication request

post

/MedicationRequest

Creates an individual medication request.

Note: Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors.

Authorization Types

This operation supports the following authorization types:

Request

Supported Media Types
Header Parameters
Body ()
The body of the create operation.
Root Schema : MedicationRequestCreate
Type: object
A summary representation of the create (POST) operation for a medication request.
Show Source
  • dispenseRequest
    The medication supply authorization.
  • Indicates whether the provider is asking for the medication request not to occur.
    Note: If provided, must be set to false.
    Example: 
    {
  "doNotPerform": false
}
  • Indicates how the medication is to be used by the patient.
    Note: Can only be provided once.
  • The supplemental instruction or warnings to the patient.
    Note: If provided, can only be provided once. Only text is supported.
    Example: 
    {
  "dosageInstruction": [
    {
      "additionalInstruction": [
        {
          "text": "Take with food."
        }
      ]
    }
  ]
}
  • Indicates whether the medication is only taken when needed or the preconditions for taking the medication.
    Note: When providing the asNeededCodeableConcept field, and the coding field is provided, system and code must be provided together.
    Example: 
    {
  "dosageInstruction": [
    {
      "asNeededBoolean": true
    }
  ]
}


    
{
  "dosageInstruction": [
    {
      "asNeededCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "25064002"
          }
        ],
        "text": "For headaches"
      }
    }
  ]
}
  • How the drug should enter the body.
    Note: Can only be provided once.
  • The amount of medication per dose.
    Note: Must be of type SimpleQuantity. Must contain the system and code fields if either are provided.
    Example: 
    {
  "dosageInstruction": [
    {
      "doseAndRate": [
        {
          "doseQuantity": {
            "value": 5,
            "unit": "tabs",
            "system": "http://unitsofmeasure.org",
            "code": "tbl"
          }
        }
      ]
    }
  ]
}
  • dosageInstruction.route
    The route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
    Note:
    • If provided, only the coding field is supported.
    • When the coding field is provided, system and code must be provided together.
    Example: 
    {
  "dosageInstruction": [
    {
      "route": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "41974700"
          }
        ]
      }
    }
  ]
}
  • dosageInstruction.site
    The anatomic site where the medication first enters the body.
    Note:
    • If provided, only the coding field is supported.
    • When the coding field is provided, system and code must be provided together.
    Example: 
    {
  "dosageInstruction": [
    {
      "site": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "368208006"
          }
        ]
      }
    }
  ]
}
  • The free-text dosage instructions.
    Example: 
    {
  "dosageInstruction": [
    {
      "text": "5 mL, Oral, Daily."
    }
  ]
}
  • When the medication should be administered.
  • dosageInstruction.timing.code
    Code for a known or defined timing pattern.
    Note:
    • If provided, only the coding field is supported.
    • When the coding field is provided, system and code must be provided together.
    Example: 
    {
  "dosageInstruction": [
    {
      "timing": {
        "code": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-GTSAbbreviation",
              "code": "BID"
            }
          ]
        }
      }
    }
  ]
}
  • When the event is to occur.
  • The outer bounds for start and end limits of the timing schedule.
    Example: 
    {
  "dosageInstruction": [
    {
      "timing": {
        "repeat": {
          "boundsPeriod": {
            "start": "2020-03-03T20:07:53Z",
            "end": "2021-03-03T20:07:53Z"
          }
        }
      }
    }
  ]
}
  • The number of times to repeat.
    Example: 
    {
  "dosageInstruction": [
    {
      "timing": {
        "repeat": {
          "count": 1
        }
      }
    }
  ]
}
  • How long when it happens.
    Note: If provided, durationUnit must be provided.
    Example: 
    {
  "dosageInstruction": [
    {
      "timing": {
        "repeat": {
          "duration": 1,
          "durationUnit": "d"
        }
      }
    }
  ]
}
  • The units of time for the duration.
    Note: If provided, duration must be provided.
    Example: 
    {
  "dosageInstruction": [
    {
      "timing": {
        "repeat": {
          "duration": 5,
          "durationUnit": "h"
        }
      }
    }
  ]
}
  • encounter
    The encounter that this medication request was created for or associated with.
    Example: 
    {
  "encounter": {
    "reference": "Encounter/1621910"
  }
}
  • Whether the request is a proposal, plan, or an original order.
    Note:
    • When creating a medication request, the intent must be order or plan.
    • When read back, the created medication request always has an intent of order or plan. The reported field can be used to determine if a medication is an authorization or a medication reported by a patient. Medication requests with intents of order and plan are supported in accordance with the changes to the US Core Profile.
    Example: 
    {
  "intent": "order"
}
  • A code that defines the medication
    Note: Must be of type CodeableConcept. Either text, or one coding with a system and code must be provided.
    Example: 
     {
  "medicationCodeableConcept": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "352362"
      }
    ],
    "text": "Acetaminophen"
  }
}
  • note
    Information about the medication request.
    Example: 
    {
  "note": [
    {
      "authorString": "Leslie Knope",
      "time": "2020-03-03T20:07:53Z",
      "text": "Patient has had medication in past."
    }
  ]
}
  • Indicates if this record was captured as a secondary reported record rather than as an original primary source-of-truth record.
    Note: Must be of type boolean and must be set to true.
    Example: 
    {
  "reportedBoolean": true
}
  • Allowed Values: [ "MedicationRequest" ]
    The type of the FHIR resource.
  • The current state of the medication request.
    Note: When creating a new medication request, the status must be active.
    Example: 
    {
  "status": "active"
}
  • A link to a resource representing the person or set of individuals to whom the medication will be given.
    Note: Must be a Patient reference.
    Example: 
    {
  "subject": {
    "reference": "Patient/12742400"
  }
}
Nested Schema : dispenseRequest
Type: object
The medication supply authorization.
Show Source
Nested Schema : dosageInstruction.route
Type: object
The route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
Note:
  • If provided, only the coding field is supported.
  • When the coding field is provided, system and code must be provided together.
Example: 
{
  "dosageInstruction": [
    {
      "route": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "41974700"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : dosageInstruction.site
Type: object
The anatomic site where the medication first enters the body.
Note:
  • If provided, only the coding field is supported.
  • When the coding field is provided, system and code must be provided together.
Example: 
{
  "dosageInstruction": [
    {
      "site": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "368208006"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : dosageInstruction.timing.code
Type: object
Code for a known or defined timing pattern.
Note:
  • If provided, only the coding field is supported.
  • When the coding field is provided, system and code must be provided together.
Example: 
{
  "dosageInstruction": [
    {
      "timing": {
        "code": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-GTSAbbreviation",
              "code": "BID"
            }
          ]
        }
      }
    }
  ]
}
Show Source
Nested Schema : encounter
Type: object
The encounter that this medication request was created for or associated with.
Example: 
{
  "encounter": {
    "reference": "Encounter/1621910"
  }
}
Show Source
Nested Schema : note
Type: object
Information about the medication request.
Example: 
{
  "note": [
    {
      "authorString": "Leslie Knope",
      "time": "2020-03-03T20:07:53Z",
      "text": "Patient has had medication in past."
    }
  ]
}
Show Source
Nested Schema : dispenseRequest.quantity
Type: object
The amount of medication to supply per dispense.
Note:
  • Must contain the system and code fields if either are provided.
  • The unit field is not supported.
Example: 
{
  "dispenseRequest": {
    "quantity": {
      "value": 12,
      "system": "http://unitsofmeasure.org",
      "code": "tbl"
    }
  }
}
Show Source
Nested Schema : substitution
Type: object
Any restrictions on medication substitution.
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : authorReference
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

Example Request: 
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationRequest
Example Request Body: 
{
    'resourceType': 'MedicationRequest',
    'status': 'active',
    'intent': 'order',
    'doNotPerform': false,
    'reportedBoolean': true,
    'medicationCodeableConcept': {
      'coding': [
        {
          'system': 'http://www.nlm.nih.gov/research/umls/rxnorm',
          'code': '352362'
        }
      ],
      'text': 'Acetaminophen'
    },
    'subject': {
      'reference': 'Patient/12742400'
    },
    'encounter': {
      'reference': 'Encounter/97953530'
    },
    'note': [
      {
        'authorString': 'Leslie Knope',
        'time': '2020-03-03T20:07:53Z',
        'text': 'Patient has had medication in past.'
      }
    ],
    'dosageInstruction': [
      {
        'text': '5 mL, Oral, Daily.',
        'additionalInstruction': [
          {
            'text': 'Take with food.'
          }
        ],
        'timing': {
          'repeat': {
            'boundsPeriod': {
              'start': '2020-02-25T23:19:10Z',
              'end': '2021-02-27T23:19:10Z'
            },
            'count': 1,
            'duration': 1.0,
            'durationUnit': 'd'
          },
          'code': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/v3-GTSAbbreviation',
                'code': 'BID'
              }
            ]
          }
        },
        'asNeededBoolean': true,
        'site': {
          'coding': [
            {
              'system': 'http://snomed.info/sct',
              'code': '368208006'
            }
          ]
        },
        'route': {
          'coding': [
            {
              'system': 'http://snomed.info/sct',
              'code': '41974700'
            }
          ]
        },
        'doseAndRate': [
          {
            'doseQuantity': {
              'value': 23.0,
              'unit': 'tabs',
              'system': 'http://unitsofmeasure.org',
              'code': 'tbl'
            }
          }
        ]
      }
    ],
    'dispenseRequest': {
      'numberOfRepeatsAllowed': 5,
      'quantity': {
        'value': 10.0,
        'system': 'http://unitsofmeasure.org',
        'code': 'tbl'
      }
    },
    'substitution': {
      'allowedBoolean': true
    }
  }
```
Example Response:

  
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: application/fhir+json
  Date: Wed, 27 Mar 2019 15:59:33 GMT
  Etag: W/"0"
  Last-Modified: Wed, 27 Mar 2019 15:59:30 GMT
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationRequest/4595905
  Vary: Origin
  X-Request-Id: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111


The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top