Pharmacy FHIR Maturity Project CI Build

This page is part of the US-Medication FHIR IG (v0.0.1: STU 1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-medicationadministration

The MedicationAdministration resources can be used to record a patient consuming or otherwise being administered a medication. For more information about the context for their usages, refer to the medication domains’s boundaries section. This profile sets minimum expectations for the MedicationAdministration resource to record, search and fetch medications associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the DAF-MedicationAdministration profile:

  • Query for medications that have been administered to a particular patient
  • Query for all medications administered during an encounter
  • Query for all medications which were not administered during an encounter
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each MedicationAdministration must have:

  1. a status
  2. a medication
  3. a patient
  4. a date or date range

In addition, the following data-elements must be supported.

*’If the data is present, MedicationAdministration shall include:**

  1. who administrated
  2. dosage information

Profile specific implementation guidance:

  • The MedicationAdministration can represent a medication, using either a code or refer to a Medication resource. The server application can choose one way or both methods, but the client application must support both methods. More specific guidance is provided in the conformance resource for this profile

example here

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/pharmacymaturity/StructureDefinition/medicationadministration

This profile builds on MedicationAdministration.

This profile was published on Tue Nov 08 00:00:00 AEDT 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*Administration of medication to a patient
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: medication-Administration-status (required)
... medication[x] S1..1CodeableConcept, Reference(US Core Medication Profile)What was administered
Binding: Medication Clinical Drug (RxNorm) (extensible)
... patient S1..1Reference(US Core Patient Profile)Who received medication
... encounter 0..1Reference(Encounter)Encounter administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] S1..1dateTime, PeriodStart and end time of administration
... performer S0..1Reference(US Core Practitioner), Reference(US Core Patient Profile), Reference(RelatedPerson)Who administered substance
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or Observation that supports why the medication was administered
... prescription 0..1Reference(MedicationRequest)Request administration performed against
... notGiven ?!∑0..1booleanTrue if medication not administered
... reasonNotGiven I0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonGiven I0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage SI0..1BackboneElementDetails of how medication was taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route 0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (example)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMED CT Administration Method Codes (example)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Ratio, SimpleQuantityDose quantity per unit of time
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Summary

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*Administration of medication to a patient
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: medication-Administration-status (required)
... medication[x] S1..1CodeableConcept, Reference(US Core Medication Profile)What was administered
Binding: Medication Clinical Drug (RxNorm) (extensible)
... patient S1..1Reference(US Core Patient Profile)Who received medication
... encounter 0..1Reference(Encounter)Encounter administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] S1..1dateTime, PeriodStart and end time of administration
... performer S0..1Reference(US Core Practitioner), Reference(US Core Patient Profile), Reference(RelatedPerson)Who administered substance
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or Observation that supports why the medication was administered
... prescription 0..1Reference(MedicationRequest)Request administration performed against
... notGiven ?!∑0..1booleanTrue if medication not administered
... reasonNotGiven I0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonGiven I0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage SI0..1BackboneElementDetails of how medication was taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route 0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (example)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMED CT Administration Method Codes (example)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Ratio, SimpleQuantityDose quantity per unit of time
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Argonaut Search Criteria for StructureDefinition-medicationadministration

Search