medication administrations

Create Medication Administration

post
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationAdministrationThis is a MedicationAdministration resource
identifierarray(Identifier)External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
definitionarray(Reference)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.
statusstringin-progress|on-hold|completed|entered-in-error|stopped|unknownWill 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.
categoryCodeableConceptIndicates the type of medication administration and 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 the medication administration was performed as part of.
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)The individual who was responsible for giving the medication to the patient.
notGivenbooleanSet this to true if the record is saying that the medication was NOT administered.
reasonNotGivenarray(CodeableConcept)A code indicating why the administration was not performed.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
prescriptionReferenceThe 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/3/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*stringMedicationAdministrationThis is a MedicationAdministration resource
identifierarray(Identifier)External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
definitionarray(Reference)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.
statusstringin-progress|on-hold|completed|entered-in-error|stopped|unknownWill 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.
categoryCodeableConceptIndicates the type of medication administration and 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 the medication administration was performed as part of.
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)The individual who was responsible for giving the medication to the patient.
notGivenbooleanSet this to true if the record is saying that the medication was NOT administered.
reasonNotGivenarray(CodeableConcept)A code indicating why the administration was not performed.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
prescriptionReferenceThe 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/3/MedicationAdministration/{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 Administration

get
/organizations/{organizationId}/fhir/3/MedicationAdministration/{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 Administration

get
/organizations/{organizationId}/fhir/3/MedicationAdministration/{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 Administration

delete
/organizations/{organizationId}/fhir/3/MedicationAdministration/{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 Administration

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

Request

Headers

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

Query params

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

Params

organizationId*string|stringid|slug

Response

Search History Medication Administration

get
/organizations/{organizationId}/fhir/3/MedicationAdministration/_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 Administration

post
/organizations/{organizationId}/fhir/3/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
not-givenstring
patientstring
performerstring
prescriptionstring
reason-givenstring
reason-not-givenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationAdministrationThis is a MedicationAdministration resource
identifierarray(Identifier)External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
definitionarray(Reference)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.
statusstringin-progress|on-hold|completed|entered-in-error|stopped|unknownWill 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.
categoryCodeableConceptIndicates the type of medication administration and 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 the medication administration was performed as part of.
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)The individual who was responsible for giving the medication to the patient.
notGivenbooleanSet this to true if the record is saying that the medication was NOT administered.
reasonNotGivenarray(CodeableConcept)A code indicating why the administration was not performed.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
prescriptionReferenceThe 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/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMedicationAdministrationThis is a MedicationAdministration resource
identifierarray(Identifier)External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
definitionarray(Reference)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.
statusstringin-progress|on-hold|completed|entered-in-error|stopped|unknownWill 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.
categoryCodeableConceptIndicates the type of medication administration and 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 the medication administration was performed as part of.
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)The individual who was responsible for giving the medication to the patient.
notGivenbooleanSet this to true if the record is saying that the medication was NOT administered.
reasonNotGivenarray(CodeableConcept)A code indicating why the administration was not performed.
reasonCodearray(CodeableConcept)A code indicating why the medication was given.
reasonReferencearray(Reference)Condition or observation that supports why the medication was administered.
prescriptionReferenceThe 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