Health eData 1 Sandbox
0.1.0 - CI Build United States of America flag

Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions

Resource Profile: US Core MedicationAdministration Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationadministration Version: 0.1.0
Active as of 2026-05-13 Maturity Level: 3 Computable Name: USCoreMedicationAdministrationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.74

The US Core MedicationAdministration Profile inherits from the FHIR MedicationAdministration resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Medication Administration Data Element of the Medications Data Class. It sets minimum expectations for the MedicationAdministration resource to record, search, and fetch information about medications administered to a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for the US Core MedicationAdministration profile:

  • Query for MedicationAdministration resources belonging to a Patient
  • [Record or update] a Patient MedicationAdministration

Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

Each MedicationAdministration Must Have:

  1. a status
  2. a medication
  3. a patient
  4. when the medication was administered

Each MedicationAdministration Must Support:

  1. who administered the medication
  2. reference to the administration order
  3. free text dosage instructions (e.g., SIG)
  4. the route of administration
  5. the dose and rate

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

USCoreMedicationAdministrationProfile — US Core MedicationAdministration Profile

The US Core MedicationAdministration Profile inherits from the FHIR MedicationAdministration resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Medication Administration Data Element of the Medications Data Class. It sets minimum expectations for the MedicationAdministration resource to record, search, and fetch information about medications administered to a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

  • URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationadministration
  • Version: 0.1.0
  • Status: active
  • Kind: resource
  • Type: MedicationAdministration
  • Base Definition: http://hl7.org/fhir/StructureDefinition/MedicationAdministration
  • Derivation: constraint

Elements (differential)

Element Must Support Add'l USCDI Cardinality Type Description
MedicationAdministration     0..*   Administration of medication to a patient
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.
status   1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Will 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.
Binding: http://hl7.org/fhir/ValueSet/medication-admin-status\|4.0.1 (required) — A set of codes indicating the current status of a MedicationAdministration.
medication[x]   1..1 CodeableConcept
Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
What was administered
Identifies 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.
Binding: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 (extensible)
subject   1..1 Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
target: http://hl7.org/fhir/StructureDefinition/Group
Who received medication
The person or animal or group receiving the medication.
effective[x]   1..1 dateTime
Period
Start and end time of administration
A 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.
performer   0..* BackboneElement Who performed the medication administration and what they did
Indicates who or what performed the medication administration and how they were involved.
actor   1..1 Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device
Who performed the medication administration
Indicates who or what performed the medication administration.
request   0..1 Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest
Request administration performed against
The original request, instruction or authority to perform the administration.
dosage   0..1 BackboneElement Details of how medication was taken
Describes the medication dosage information details e.g. dose, rate, site, route, etc.
text   0..1 string Free text dosage instructions e.g. SIG
Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.
The dosage instructions should reflect the dosage of the medication that was administered.            
  route   0..1 CodeableConcept Path of substance into body
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
Binding: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 (extensible) — SNOMED CT and NCI Thesaurus SPL route of administration codes
  dose   0..1 Quantity
profile: http://hl7.org/fhir/StructureDefinition/SimpleQuantity|4.0.1
Amount of medication per dose
The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
Binding: http://hl7.org/fhir/ValueSet/ucum-common (preferred)


## USCoreMedicationAdministrationProfile — US Core MedicationAdministration Profile

The US Core MedicationAdministration Profile inherits from the FHIR [MedicationAdministration](https://hl7.org/fhir/R4/medicationadministration.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Medication Administration Data Element of the Medications Data Class*. It sets minimum expectations for the MedicationAdministration resource to record, search, and fetch information about medications administered to a patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationadministration`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `MedicationAdministration`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/MedicationAdministration`
- **Derivation:** constraint


### Elements (differential)

| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `MedicationAdministration` |  |  | 0..* |  | **Administration of medication to a patient**<br/>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. |
| <span style="padding-left: 1.5em;">↳</span> `status` | ✅ |  | 1..1 | `code` | **in-progress \| not-done \| on-hold \| completed \| entered-in-error \| stopped \| unknown**<br/>Will 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.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/medication-admin-status\|4.0.1` (required) — A set of codes indicating the current status of a MedicationAdministration.</span> |
| <span style="padding-left: 1.5em;">↳</span> `medication[x]` | ✅ |  | 1..1 | `CodeableConcept`<br/>`Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication</span> | **What was administered**<br/>Identifies 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.<br/><span style="font-size: 0.85em;">**Binding:** `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4` (extensible)</span> |
| <span style="padding-left: 1.5em;">↳</span> `subject` | ✅ |  | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Group</span> | **Who received medication**<br/>The person or animal or group receiving the medication. |
| <span style="padding-left: 1.5em;">↳</span> `effective[x]` | ✅ |  | 1..1 | `dateTime`<br/>`Period` | **Start and end time of administration**<br/>A 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. |
| <span style="padding-left: 1.5em;">↳</span> `performer` | ✅ |  | 0..* | `BackboneElement` | **Who performed the medication administration and what they did**<br/>Indicates who or what performed the medication administration and how they were involved. |
| <span style="padding-left: 3.0em;">↳</span> `actor` | ✅ |  | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span> | **Who performed the medication administration**<br/>Indicates who or what performed the medication administration. |
| <span style="padding-left: 1.5em;">↳</span> `request` | ✅ |  | 0..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest</span> | **Request administration performed against**<br/>The original request, instruction or authority to perform the administration. |
| <span style="padding-left: 1.5em;">↳</span> `dosage` | ✅ |  | 0..1 | `BackboneElement` | **Details of how medication was taken**<br/>Describes the medication dosage information details e.g. dose, rate, site, route, etc. |
| <span style="padding-left: 3.0em;">↳</span> `text` | ✅ |  | 0..1 | `string` | **Free text dosage instructions e.g. SIG**<br/>Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.

The dosage instructions should reflect the dosage of the medication that was administered. |
| <span style="padding-left: 3.0em;">↳</span> `route` | ✅ |  | 0..1 | `CodeableConcept` | **Path of substance into body**<br/>A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient.  For example, topical, intravenous, etc.<br/><span style="font-size: 0.85em;">**Binding:** `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22` (extensible) — SNOMED CT and NCI Thesaurus SPL route of administration codes</span> |
| <span style="padding-left: 3.0em;">↳</span> `dose` | ✅ |  | 0..1 | `Quantity`<br/><span style="font-size: 0.85em;">profile: http://hl7.org/fhir/StructureDefinition/SimpleQuantity\|4.0.1</span> | **Amount of medication per dose**<br/>The amount of the medication given at one administration event.   Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/ucum-common` (preferred)</span> |




Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0-ballot) S | Group) Who received medication
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime S
.... effectivePeriod Period S
... performer SΣ 0..* BackboneElement Who performed the medication administration and what they did
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(US Core Practitioner Profile S | US Core Patient Profile(9.0.0-ballot) | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who performed the medication administration
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage SC 0..1 BackboneElement Details of how medication was taken
Constraints: mad-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration of Therapeutic Agents . (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes
.... dose S 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
Binding: Common UCUM units (preferred)
Additional BindingsPurpose
UCUMCodes Max Binding

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible Medication Clinical Drug . 📦20240606 VSAC v0.24
MedicationAdministration.​dosage.route Base extensible Route of Administration of Therapeutic Agents . 📦20241015 VSAC v0.24
MedicationAdministration.​dosage.dose Base preferred Common UCUM units 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationAdministration If 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-4 error MedicationAdministration If 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-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mad-1 error MedicationAdministration.dosage SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... medication[x] S 1..1 What was administered
Binding: Medication Clinical Drug . (extensible)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
... subject S 1..1 Reference(US Core Patient Profile(9.0.0-ballot) S | Group) Who received medication
.... effectiveDateTime dateTime S
.... effectivePeriod Period S
... performer S 0..* BackboneElement Who performed the medication administration and what they did
.... actor S 1..1 Reference(US Core Practitioner Profile S | US Core Patient Profile(9.0.0-ballot) | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who performed the medication administration
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage S 0..1 BackboneElement Details of how medication was taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration of Therapeutic Agents . (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes
.... dose S 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
Binding: Common UCUM units (preferred)
Additional BindingsPurpose
UCUMCodes Max Binding

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationAdministration.​medication[x] Base extensible Medication Clinical Drug . 📦20240606 VSAC v0.24
MedicationAdministration.​dosage.route Base extensible Route of Administration of Therapeutic Agents . 📦20241015 VSAC v0.24
MedicationAdministration.​dosage.dose Base preferred Common UCUM units 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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.
... medication[x] SΣ 1..1 What was administered
Binding: Medication Clinical Drug . (extensible)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0-ballot) S | Group) Who received medication
... context 0..1 Reference(Encounter | EpisodeOfCare) 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 S
.... effectivePeriod Period S
... performer SΣ 0..* 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Σ 1..1 Reference(US Core Practitioner Profile S | US Core Patient Profile(9.0.0-ballot) | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who performed the medication administration
... 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 0..1 BackboneElement Details of how medication was taken
Constraints: mad-1
.... 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 S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration of Therapeutic Agents . (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes
.... 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 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
Binding: Common UCUM units (preferred)
Additional BindingsPurpose
UCUMCodes Max Binding
.... 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

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base example SNOMED CT Reason Medication Not Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​category Base preferred Medication administration category codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible Medication Clinical Drug . 📦20240606 VSAC v0.24
MedicationAdministration.​performer.function Base example Medication administration performer function codes 📍4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.route Base extensible Route of Administration of Therapeutic Agents . 📦20241015 VSAC v0.24
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.dose Base preferred Common UCUM units 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationAdministration If 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-4 error MedicationAdministration If 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-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mad-1 error MedicationAdministration.dosage SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0-ballot) S | Group) Who received medication
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime S
.... effectivePeriod Period S
... performer SΣ 0..* BackboneElement Who performed the medication administration and what they did
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(US Core Practitioner Profile S | US Core Patient Profile(9.0.0-ballot) | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who performed the medication administration
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage SC 0..1 BackboneElement Details of how medication was taken
Constraints: mad-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration of Therapeutic Agents . (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes
.... dose S 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
Binding: Common UCUM units (preferred)
Additional BindingsPurpose
UCUMCodes Max Binding

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible Medication Clinical Drug . 📦20240606 VSAC v0.24
MedicationAdministration.​dosage.route Base extensible Route of Administration of Therapeutic Agents . 📦20241015 VSAC v0.24
MedicationAdministration.​dosage.dose Base preferred Common UCUM units 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationAdministration If 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-4 error MedicationAdministration If 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-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mad-1 error MedicationAdministration.dosage SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... medication[x] S 1..1 What was administered
Binding: Medication Clinical Drug . (extensible)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
... subject S 1..1 Reference(US Core Patient Profile(9.0.0-ballot) S | Group) Who received medication
.... effectiveDateTime dateTime S
.... effectivePeriod Period S
... performer S 0..* BackboneElement Who performed the medication administration and what they did
.... actor S 1..1 Reference(US Core Practitioner Profile S | US Core Patient Profile(9.0.0-ballot) | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who performed the medication administration
... request S 0..1 Reference(US Core MedicationRequest Profile) Request administration performed against
... dosage S 0..1 BackboneElement Details of how medication was taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration of Therapeutic Agents . (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes
.... dose S 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
Binding: Common UCUM units (preferred)
Additional BindingsPurpose
UCUMCodes Max Binding

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationAdministration.​medication[x] Base extensible Medication Clinical Drug . 📦20240606 VSAC v0.24
MedicationAdministration.​dosage.route Base extensible Route of Administration of Therapeutic Agents . 📦20241015 VSAC v0.24
MedicationAdministration.​dosage.dose Base preferred Common UCUM units 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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.
... medication[x] SΣ 1..1 What was administered
Binding: Medication Clinical Drug . (extensible)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(US Core Medication Profile)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0-ballot) S | Group) Who received medication
... context 0..1 Reference(Encounter | EpisodeOfCare) 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 S
.... effectivePeriod Period S
... performer SΣ 0..* 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Σ 1..1 Reference(US Core Practitioner Profile S | US Core Patient Profile(9.0.0-ballot) | US Core Organization Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who performed the medication administration
... 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 0..1 BackboneElement Details of how medication was taken
Constraints: mad-1
.... 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 S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration of Therapeutic Agents . (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes
.... 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 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
Binding: Common UCUM units (preferred)
Additional BindingsPurpose
UCUMCodes Max Binding
.... 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

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base example SNOMED CT Reason Medication Not Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​category Base preferred Medication administration category codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible Medication Clinical Drug . 📦20240606 VSAC v0.24
MedicationAdministration.​performer.function Base example Medication administration performer function codes 📍4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.route Base extensible Route of Administration of Therapeutic Agents . 📦20241015 VSAC v0.24
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.dose Base preferred Common UCUM units 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationAdministration If 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-4 error MedicationAdministration If 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-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mad-1 error MedicationAdministration.dosage SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()

 

Other representations of profile: CSV, Excel, Schematron