medication administrations

Create Medication Administration

post
/organizations/{organizationId}/fhir/4/MedicationAdministration

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a MedicationAdministration resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Identifiers associated with this Medication Administration 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. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
instantiatesarray(uri)A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statuscodeWill generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
statusReasonarray(CodeableConcept)A code indicating why the administration was not performed.
categoryCodeableConceptIndicates where the medication is expected to be consumed or administered.
medicationCodeableConceptCodeableConceptIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceThe person or animal or group receiving the medication.
contextReferenceThe visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
supportingInformationarray(Reference)Additional information (for example, patient height and weight) that supports the administration of the medication.
effectiveDateTimestringA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
effectivePeriodPeriodA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
performerarray(MedicationAdministration_Performer)Indicates who or what performed the medication administration and how they were involved.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
requestReferenceThe original request, instruction or authority to perform the administration.
devicearray(Reference)The device used in administering the medication to the patient. For example, a particular infusion pump.
notearray(Annotation)Extra information about the medication administration that is not conveyed by the other attributes.
dosageMedicationAdministration_DosageDescribes the medication dosage information details e.g. dose, rate, site, route, etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the administration was verified.

Response

Patch Medication Administration

patch
/organizations/{organizationId}/fhir/4/MedicationAdministration/{resourceId}

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

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*This is a MedicationAdministration resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Identifiers associated with this Medication Administration 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. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
instantiatesarray(uri)A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statuscodeWill generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
statusReasonarray(CodeableConcept)A code indicating why the administration was not performed.
categoryCodeableConceptIndicates where the medication is expected to be consumed or administered.
medicationCodeableConceptCodeableConceptIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceThe person or animal or group receiving the medication.
contextReferenceThe visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
supportingInformationarray(Reference)Additional information (for example, patient height and weight) that supports the administration of the medication.
effectiveDateTimestringA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
effectivePeriodPeriodA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
performerarray(MedicationAdministration_Performer)Indicates who or what performed the medication administration and how they were involved.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
requestReferenceThe original request, instruction or authority to perform the administration.
devicearray(Reference)The device used in administering the medication to the patient. For example, a particular infusion pump.
notearray(Annotation)Extra information about the medication administration that is not conveyed by the other attributes.
dosageMedicationAdministration_DosageDescribes the medication dosage information details e.g. dose, rate, site, route, etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the administration was verified.

Response

Read Medication Administration

get
/organizations/{organizationId}/fhir/4/MedicationAdministration/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Medication Administration

get
/organizations/{organizationId}/fhir/4/MedicationAdministration/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Medication Administration

get
/organizations/{organizationId}/fhir/4/MedicationAdministration/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Medication Administration

delete
/organizations/{organizationId}/fhir/4/MedicationAdministration/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Medication Administration

get
/organizations/{organizationId}/fhir/4/MedicationAdministration

Request

Headers

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

Query params

_idstring
_languagestring
codestring
contextstring
devicestring
effective-timestring
identifierstring
medicationstring
patientstring
performerstring
reason-not-givenstring
reason-givenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Medication Administration

get
/organizations/{organizationId}/fhir/4/MedicationAdministration/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Medication Administration

post
/organizations/{organizationId}/fhir/4/MedicationAdministration/_search

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Request

Headers

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

Query params

_idstring
_languagestring
codestring
contextstring
devicestring
effective-timestring
identifierstring
medicationstring
patientstring
performerstring
reason-givenstring
reason-not-givenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a MedicationAdministration resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Identifiers associated with this Medication Administration 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. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
instantiatesarray(uri)A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statuscodeWill generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
statusReasonarray(CodeableConcept)A code indicating why the administration was not performed.
categoryCodeableConceptIndicates where the medication is expected to be consumed or administered.
medicationCodeableConceptCodeableConceptIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceThe person or animal or group receiving the medication.
contextReferenceThe visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
supportingInformationarray(Reference)Additional information (for example, patient height and weight) that supports the administration of the medication.
effectiveDateTimestringA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
effectivePeriodPeriodA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
performerarray(MedicationAdministration_Performer)Indicates who or what performed the medication administration and how they were involved.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
requestReferenceThe original request, instruction or authority to perform the administration.
devicearray(Reference)The device used in administering the medication to the patient. For example, a particular infusion pump.
notearray(Annotation)Extra information about the medication administration that is not conveyed by the other attributes.
dosageMedicationAdministration_DosageDescribes the medication dosage information details e.g. dose, rate, site, route, etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the administration was verified.

Response

Update Medication Administration

put
/organizations/{organizationId}/fhir/4/MedicationAdministration/{resourceId}

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a MedicationAdministration resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Identifiers associated with this Medication Administration 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. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
instantiatesarray(uri)A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statuscodeWill generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
statusReasonarray(CodeableConcept)A code indicating why the administration was not performed.
categoryCodeableConceptIndicates where the medication is expected to be consumed or administered.
medicationCodeableConceptCodeableConceptIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subject*ReferenceThe person or animal or group receiving the medication.
contextReferenceThe visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
supportingInformationarray(Reference)Additional information (for example, patient height and weight) that supports the administration of the medication.
effectiveDateTimestringA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
effectivePeriodPeriodA specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
performerarray(MedicationAdministration_Performer)Indicates who or what performed the medication administration and how they were involved.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
requestReferenceThe original request, instruction or authority to perform the administration.
devicearray(Reference)The device used in administering the medication to the patient. For example, a particular infusion pump.
notearray(Annotation)Extra information about the medication administration that is not conveyed by the other attributes.
dosageMedicationAdministration_DosageDescribes the medication dosage information details e.g. dose, rate, site, route, etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the administration was verified.

Response