medication requests

Create Medication Request

post
/organizations/{organizationId}/fhir/3/MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationRequestThis is a MedicationRequest resource
identifierarray(Identifier)This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)A plan or request that is fulfilled in whole or in part by this medication request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
statusstringactive|on-hold|cancelled|completed|entered-in-error|stopped|draft|unknownA code specifying the current state of the order. Generally this will be active or completed state.
intentstringproposal|plan|order|instance-orderWhether the request is a proposal, plan, or an original order.
categoryCodeableConceptIndicates the type of medication order and where the medication is expected to be consumed or administered.
prioritystringroutine|urgent|stat|asapIndicates how quickly the Medication Request should be addressed with respect to other requests.
medicationCodeableConceptCodeableConceptIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceA link to a resource representing the person or set of individuals to whom the medication will be given.
contextReferenceA link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
supportingInformationarray(Reference)Include additional information (for example, patient height and weight) that supports the ordering of the medication.
authoredOnstringThe date (and perhaps time) when the prescription was initially written or authored on.
requesterMedicationRequest_RequesterThe individual, organization or device that initiated the request and has responsibility for its activation.
recorderReferenceThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
reasonCodearray(CodeableConcept)The reason or the indication for ordering the medication.
reasonReferencearray(Reference)Condition or observation that supports why the medication was ordered.
notearray(Annotation)Extra information about the prescription that could not be conveyed by the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
dispenseRequestMedicationRequest_DispenseRequestIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
substitutionMedicationRequest_SubstitutionIndicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
priorPrescriptionReferenceA link to a resource representing an earlier order related order or prescription.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response

Patch Medication Request

patch
/organizations/{organizationId}/fhir/3/MedicationRequest/{resourceId}

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMedicationRequestThis is a MedicationRequest resource
identifierarray(Identifier)This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)A plan or request that is fulfilled in whole or in part by this medication request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
statusstringactive|on-hold|cancelled|completed|entered-in-error|stopped|draft|unknownA code specifying the current state of the order. Generally this will be active or completed state.
intentstringproposal|plan|order|instance-orderWhether the request is a proposal, plan, or an original order.
categoryCodeableConceptIndicates the type of medication order and where the medication is expected to be consumed or administered.
prioritystringroutine|urgent|stat|asapIndicates how quickly the Medication Request should be addressed with respect to other requests.
medicationCodeableConceptCodeableConceptIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceA link to a resource representing the person or set of individuals to whom the medication will be given.
contextReferenceA link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
supportingInformationarray(Reference)Include additional information (for example, patient height and weight) that supports the ordering of the medication.
authoredOnstringThe date (and perhaps time) when the prescription was initially written or authored on.
requesterMedicationRequest_RequesterThe individual, organization or device that initiated the request and has responsibility for its activation.
recorderReferenceThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
reasonCodearray(CodeableConcept)The reason or the indication for ordering the medication.
reasonReferencearray(Reference)Condition or observation that supports why the medication was ordered.
notearray(Annotation)Extra information about the prescription that could not be conveyed by the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
dispenseRequestMedicationRequest_DispenseRequestIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
substitutionMedicationRequest_SubstitutionIndicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
priorPrescriptionReferenceA link to a resource representing an earlier order related order or prescription.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response

Read Medication Request

get
/organizations/{organizationId}/fhir/3/MedicationRequest/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Medication Request

get
/organizations/{organizationId}/fhir/3/MedicationRequest/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Medication Request

get
/organizations/{organizationId}/fhir/3/MedicationRequest/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Medication Request

delete
/organizations/{organizationId}/fhir/3/MedicationRequest/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Medication Request

get
/organizations/{organizationId}/fhir/3/MedicationRequest

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authoredonstring
categorystring
codestring
contextstring
datestring
identifierstring
intended-dispenserstring
intentstring
medicationstring
patientstring
pertains-tostring
prioritystring
reasonstring
reason-codestring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Medication Request

get
/organizations/{organizationId}/fhir/3/MedicationRequest/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Medication Request

post
/organizations/{organizationId}/fhir/3/MedicationRequest/_search

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authoredonstring
categorystring
codestring
contextstring
datestring
identifierstring
intended-dispenserstring
intentstring
medicationstring
patientstring
pertains-tostring
prioritystring
reasonstring
reason-codestring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationRequestThis is a MedicationRequest resource
identifierarray(Identifier)This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)A plan or request that is fulfilled in whole or in part by this medication request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
statusstringactive|on-hold|cancelled|completed|entered-in-error|stopped|draft|unknownA code specifying the current state of the order. Generally this will be active or completed state.
intentstringproposal|plan|order|instance-orderWhether the request is a proposal, plan, or an original order.
categoryCodeableConceptIndicates the type of medication order and where the medication is expected to be consumed or administered.
prioritystringroutine|urgent|stat|asapIndicates how quickly the Medication Request should be addressed with respect to other requests.
medicationCodeableConceptCodeableConceptIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceA link to a resource representing the person or set of individuals to whom the medication will be given.
contextReferenceA link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
supportingInformationarray(Reference)Include additional information (for example, patient height and weight) that supports the ordering of the medication.
authoredOnstringThe date (and perhaps time) when the prescription was initially written or authored on.
requesterMedicationRequest_RequesterThe individual, organization or device that initiated the request and has responsibility for its activation.
recorderReferenceThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
reasonCodearray(CodeableConcept)The reason or the indication for ordering the medication.
reasonReferencearray(Reference)Condition or observation that supports why the medication was ordered.
notearray(Annotation)Extra information about the prescription that could not be conveyed by the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
dispenseRequestMedicationRequest_DispenseRequestIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
substitutionMedicationRequest_SubstitutionIndicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
priorPrescriptionReferenceA link to a resource representing an earlier order related order or prescription.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response

Update Medication Request

put
/organizations/{organizationId}/fhir/3/MedicationRequest/{resourceId}

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMedicationRequestThis is a MedicationRequest resource
identifierarray(Identifier)This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)A plan or request that is fulfilled in whole or in part by this medication request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
statusstringactive|on-hold|cancelled|completed|entered-in-error|stopped|draft|unknownA code specifying the current state of the order. Generally this will be active or completed state.
intentstringproposal|plan|order|instance-orderWhether the request is a proposal, plan, or an original order.
categoryCodeableConceptIndicates the type of medication order and where the medication is expected to be consumed or administered.
prioritystringroutine|urgent|stat|asapIndicates how quickly the Medication Request should be addressed with respect to other requests.
medicationCodeableConceptCodeableConceptIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceA link to a resource representing the person or set of individuals to whom the medication will be given.
contextReferenceA link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
supportingInformationarray(Reference)Include additional information (for example, patient height and weight) that supports the ordering of the medication.
authoredOnstringThe date (and perhaps time) when the prescription was initially written or authored on.
requesterMedicationRequest_RequesterThe individual, organization or device that initiated the request and has responsibility for its activation.
recorderReferenceThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
reasonCodearray(CodeableConcept)The reason or the indication for ordering the medication.
reasonReferencearray(Reference)Condition or observation that supports why the medication was ordered.
notearray(Annotation)Extra information about the prescription that could not be conveyed by the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
dispenseRequestMedicationRequest_DispenseRequestIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
substitutionMedicationRequest_SubstitutionIndicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
priorPrescriptionReferenceA link to a resource representing an earlier order related order or prescription.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response