US Prescription Drug Monitoring Program (PDMP)
1.0.0-ballot - STU1 Ballot United States of America flag

This page is part of the US Prescription Drug Monitoring Program (PDMP) (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: PDMP MedicationAdministration

Official URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-medicationadministration Version: 1.0.0-ballot
Active as of 2024-04-01 Computable Name: PdmpMedicationAdministration

Defines constraints and extensions on the MedicationAdministration resource when used by a Prescription Drug Monitoring Program (PDMP) to return an individual’s medication administration history.

Important elements in this profile:

  • MedicationAdministration.subject
    • A reference to the patient receiving the medication SHALL be populated
  • MedicationAdministration.medicationCodeableConcept (or Medication reference)
    • The administered medication SHALL be populated, including the associated RxNorm code and NDC11 reflecting the medication name, strength and dose form
  • MedicationAdministration.performer
    • The party that administered the medication SHALL be populated using either a reference to the performer (US Core Practitioner resource) or an identifier specifying both the provider’s identifier value and system
  • MedicationAdministration.request
    • A reference to the authorizing MedicationRequest SHOULD be populated
  • MedicationAdministration.dosage.dose
    • The dose administered, including numeric value and units SHALL be populated
    • When the dose is stated in terms of “eaches” (e.g., tablets, capsules, etc.), populate only the dose.unit value with the text “each”. Do not populate the dose.system or dose.code values
  • MedicationAdministration.effective
    • The date(s) that the medication was adminstered to the patient SHALL be populated
  • MedicationAdministration.medicationCodeableConcept.userSelected
    • The userSelected element associated with the drug code received from administration data source
    • The userSelected element associated with any additional drug codes provided SHALL NOT be populated
  • MedicationAdministration.authorizingPrescription.identifier
    • This element SHOULD be populated with the authorizing prescription’s prescriber-system-assigned order number, if known

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... rx-transmission-method S 0..1 Coding PDMP Extension - Prescription Transmission Method
URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-transmission-method
Binding: PDMP Value Set - Prescription Transmission Method (extensible)
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
.... medication[x]:medicationCodeableConcept 0..1 CodeableConcept What was administered
..... coding
...... userSelected S 0..1 boolean If this coding was chosen directly by the user
... subject S 1..1 Reference(US Core Patient Profile) Who received medication
... context S 0..1 Reference(US Core Encounter Profile) Encounter or Episode of Care administered as part of
... effective[x] S 1..1 dateTime, Period Start and end time of administration
... performer S 1..1 BackboneElement Who performed the medication administration and what they did
.... actor SC 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
pdmp-administration-performer: MedicationAdministration SHALL include a performer actor reference or performer actor identifier
..... reference S 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier S 0..1 Identifier Logical reference, when literal reference is not known
...... system S 1..1 uri The namespace for the identifier value
...... value S 1..1 string The value that is unique
..... display S 0..1 string Text alternative for the resource
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage S 1..1 BackboneElement Details of how medication was taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... dose S 1..1 SimpleQuantity Amount of medication per dose
..... value S 1..1 decimal Numerical value (with implicit precision)
..... unit S 1..1 string Unit representation
..... system S 0..1 uri System that defines coded unit form
..... code S 0..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status
from the FHIR Standard
MedicationAdministration.medication[x]extensibleMedication Clinical Drug .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4

Constraints

IdGradePath(s)DetailsRequirements
pdmp-administration-performererrorMedicationAdministration.performer.actorMedicationAdministration SHALL include a performer actor reference or performer actor identifier
: reference.exists() or identifier.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... rx-transmission-method S 0..1 Coding PDMP Extension - Prescription Transmission Method
URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-transmission-method
Binding: PDMP Value Set - Prescription Transmission Method (extensible)
... status ?!SΣ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... Slices for medication[x] SΣ 1..1 What was administered
Slice: Unordered, Open by type:$this
Binding: Medication Clinical Drug . (extensible): Prescribable medications

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... coding Σ 0..* Coding Code defined by a terminology system
...... userSelected SΣ 0..1 boolean If this coding was chosen directly by the user
... subject SΣ 1..1 Reference(US Core Patient Profile) Who received medication
... context S 0..1 Reference(US Core Encounter Profile) Encounter or Episode of Care administered as part of
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 1..1 BackboneElement Who performed the medication administration and what they did
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣC 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
pdmp-administration-performer: MedicationAdministration SHALL include a performer actor reference or performer actor identifier
..... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value SΣ 1..1 string The value that is unique
Example General: 123456
..... display SΣ 0..1 string Text alternative for the resource
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage SC 1..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... dose S 1..1 SimpleQuantity Amount of medication per dose
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 1..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status
from the FHIR Standard
MedicationAdministration.medication[x]extensibleMedication Clinical Drug .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
pdmp-administration-performererrorMedicationAdministration.performer.actorMedicationAdministration SHALL include a performer actor reference or performer actor identifier
: reference.exists() or identifier.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... rx-transmission-method S 0..1 Coding PDMP Extension - Prescription Transmission Method
URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-transmission-method
Binding: PDMP Value Set - Prescription Transmission Method (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!SΣ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... Slices for medication[x] SΣ 1..1 What was administered
Slice: Unordered, Open by type:$this
Binding: Medication Clinical Drug . (extensible): Prescribable medications

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected SΣ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who received medication
... context S 0..1 Reference(US Core Encounter Profile) Encounter or Episode of Care administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 1..1 BackboneElement Who performed the medication administration and what they did
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor SΣC 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
pdmp-administration-performer: MedicationAdministration SHALL include a performer actor reference or performer actor identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value SΣ 1..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... display SΣ 0..1 string Text alternative for the resource
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage SC 1..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route 0..1 CodeableConcept Path of substance into body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... dose S 1..1 SimpleQuantity Amount of medication per dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 1..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
.... rate[x] 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]extensibleMedication Clinical Drug .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationAdministration.performer.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationAdministration.performer.actor.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
pdmp-administration-performererrorMedicationAdministration.performer.actorMedicationAdministration SHALL include a performer actor reference or performer actor identifier
: reference.exists() or identifier.exists()

This structure is derived from MedicationAdministration

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationAdministration.medication[x]

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... rx-transmission-method S 0..1 Coding PDMP Extension - Prescription Transmission Method
URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-transmission-method
Binding: PDMP Value Set - Prescription Transmission Method (extensible)
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
.... medication[x]:medicationCodeableConcept 0..1 CodeableConcept What was administered
..... coding
...... userSelected S 0..1 boolean If this coding was chosen directly by the user
... subject S 1..1 Reference(US Core Patient Profile) Who received medication
... context S 0..1 Reference(US Core Encounter Profile) Encounter or Episode of Care administered as part of
... effective[x] S 1..1 dateTime, Period Start and end time of administration
... performer S 1..1 BackboneElement Who performed the medication administration and what they did
.... actor SC 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
pdmp-administration-performer: MedicationAdministration SHALL include a performer actor reference or performer actor identifier
..... reference S 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier S 0..1 Identifier Logical reference, when literal reference is not known
...... system S 1..1 uri The namespace for the identifier value
...... value S 1..1 string The value that is unique
..... display S 0..1 string Text alternative for the resource
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage S 1..1 BackboneElement Details of how medication was taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... dose S 1..1 SimpleQuantity Amount of medication per dose
..... value S 1..1 decimal Numerical value (with implicit precision)
..... unit S 1..1 string Unit representation
..... system S 0..1 uri System that defines coded unit form
..... code S 0..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status
from the FHIR Standard
MedicationAdministration.medication[x]extensibleMedication Clinical Drug .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4

Constraints

IdGradePath(s)DetailsRequirements
pdmp-administration-performererrorMedicationAdministration.performer.actorMedicationAdministration SHALL include a performer actor reference or performer actor identifier
: reference.exists() or identifier.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... rx-transmission-method S 0..1 Coding PDMP Extension - Prescription Transmission Method
URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-transmission-method
Binding: PDMP Value Set - Prescription Transmission Method (extensible)
... status ?!SΣ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... Slices for medication[x] SΣ 1..1 What was administered
Slice: Unordered, Open by type:$this
Binding: Medication Clinical Drug . (extensible): Prescribable medications

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... coding Σ 0..* Coding Code defined by a terminology system
...... userSelected SΣ 0..1 boolean If this coding was chosen directly by the user
... subject SΣ 1..1 Reference(US Core Patient Profile) Who received medication
... context S 0..1 Reference(US Core Encounter Profile) Encounter or Episode of Care administered as part of
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 1..1 BackboneElement Who performed the medication administration and what they did
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣC 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
pdmp-administration-performer: MedicationAdministration SHALL include a performer actor reference or performer actor identifier
..... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value SΣ 1..1 string The value that is unique
Example General: 123456
..... display SΣ 0..1 string Text alternative for the resource
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage SC 1..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... dose S 1..1 SimpleQuantity Amount of medication per dose
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 1..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status
from the FHIR Standard
MedicationAdministration.medication[x]extensibleMedication Clinical Drug .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
pdmp-administration-performererrorMedicationAdministration.performer.actorMedicationAdministration SHALL include a performer actor reference or performer actor identifier
: reference.exists() or identifier.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... rx-transmission-method S 0..1 Coding PDMP Extension - Prescription Transmission Method
URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-extension-rx-transmission-method
Binding: PDMP Value Set - Prescription Transmission Method (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!SΣ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... Slices for medication[x] SΣ 1..1 What was administered
Slice: Unordered, Open by type:$this
Binding: Medication Clinical Drug . (extensible): Prescribable medications

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected SΣ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who received medication
... context S 0..1 Reference(US Core Encounter Profile) Encounter or Episode of Care administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 1..1 BackboneElement Who performed the medication administration and what they did
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor SΣC 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
pdmp-administration-performer: MedicationAdministration SHALL include a performer actor reference or performer actor identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value SΣ 1..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... display SΣ 0..1 string Text alternative for the resource
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage SC 1..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route 0..1 CodeableConcept Path of substance into body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... dose S 1..1 SimpleQuantity Amount of medication per dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 1..1 string Unit representation
..... system SΣC 0..1 uri System that defines coded unit form
..... code SΣ 0..1 code Coded form of the unit
.... rate[x] 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]extensibleMedication Clinical Drug .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationAdministration.performer.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationAdministration.performer.actor.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
pdmp-administration-performererrorMedicationAdministration.performer.actorMedicationAdministration SHALL include a performer actor reference or performer actor identifier
: reference.exists() or identifier.exists()

This structure is derived from MedicationAdministration

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationAdministration.medication[x]

 

Other representations of profile: CSV, Excel, Schematron