This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/daf-medicationadministration
Defines constraints and extensions on the MedicationAdministration resource for use in querying and retrieving patient's medication information that was administered.
This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from MedicationAdministration.
Summary
Mandatory: 4 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from MedicationAdministration.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | ||
identifier | S | 0..* | Identifier | |
status | S | 1..1 | code | |
patient | S | 1..1 | Reference(DAF-Patient) | |
practitioner | S | 0..1 | Reference(DAF-Pract) | |
encounter | S | 0..1 | Reference(DAF-Encounter) | |
prescription | S | 0..1 | Reference(DAF-MedicationOrder) | |
wasNotGiven | S | 0..1 | boolean | |
reasonNotGiven | S | 0..1 | CodeableConcept | |
effectiveTime[x] | S | 1..1 | dateTime, Period | |
medication[x] | CodeableConcept, Reference(Medication) | Slice: Unordered, Open, by @type | ||
medicationCodeableConcept | S | 1..1 | CodeableConcept | Binding: Medication Clinical Drug (RxNorm) (extensible) |
medicationReference | S | 1..1 | Reference(DAF-Medication) | |
device | S | 0..* | Reference(Device) | |
dosage | S | 0..1 | BackboneElement | |
siteCodeableConcept | S | 0..1 | CodeableConcept | Binding: Vaccine Administered Body Site (preferred) |
route | S | 0..1 | CodeableConcept | Binding: Medication Route FDA Value Set (preferred) |
quantity | S | 0..1 | SimpleQuantity | |
rate[x] | S | 0..1 | Ratio, Range | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | ∑ I | 0..* | MedicationAdministration | Administration of medication to a patient mad-3: Reason given is only permitted if wasNotGiven is false mad-2: Reason not given is only permitted if wasNotGiven is true |
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: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S ∑ | 0..* | Identifier | External identifier |
status | ?! S∑ | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationAdministrationStatus (required) |
patient | S ∑ | 1..1 | Reference(DAF-Patient) | Who received medication |
practitioner | S ∑ | 0..1 | Reference(DAF-Pract) | Who administered substance |
encounter | S ∑ | 0..1 | Reference(DAF-Encounter) | Encounter administered as part of |
prescription | S ∑ | 0..1 | Reference(DAF-MedicationOrder) | Order administration performed against |
wasNotGiven | ?! S∑ | 0..1 | boolean | True if medication not administered |
reasonNotGiven | S ∑I | 0..1 | CodeableConcept | Reason administration not performed Binding: Reason Medication Not Given Codes (example) |
reasonGiven | ∑ I | 0..* | CodeableConcept | Reason administration performed Binding: Reason Medication Given Codes (example) |
effectiveTime[x] | S ∑ | 1..1 | dateTime, Period | Start and end time of administration |
medication[x] | ∑ | CodeableConcept, Reference(Medication) | What was administered Slice: Unordered, Open, by @type | |
medication[x] | ∑ | 1..1 | CodeableConcept, Reference(Medication) | What was administered |
medicationCodeableConcept | S ∑ | 1..1 | CodeableConcept | What was administered Binding: Medication Clinical Drug (RxNorm) (extensible) |
medicationReference | S ∑ | 1..1 | Reference(DAF-Medication) | What was administered |
device | S ∑ | 0..* | Reference(Device) | Device used to administer |
note | ∑ | 0..1 | string | Information about the administration |
dosage | S ∑I | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.quantity and dosage.rate[x] |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
text | ∑ | 0..1 | string | Dosage Instructions |
siteCodeableConcept | S ∑ | 0..1 | CodeableConcept | Body site administered to Binding: Vaccine Administered Body Site (preferred) |
route | S ∑ | 0..1 | CodeableConcept | Path of substance into body Binding: Medication Route FDA Value Set (preferred) |
method | ∑ | 0..1 | CodeableConcept | How drug was administered Binding: (unbound) (example) |
quantity | S ∑ | 0..1 | SimpleQuantity | Amount administered in one dose |
rate[x] | S ∑ | 0..1 | Ratio, Range | Dose quantity per unit of time |
Documentation for this format |
todo
This structure is derived from MedicationAdministration.
Summary
Mandatory: 4 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationAdministration.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | ||
identifier | S | 0..* | Identifier | |
status | S | 1..1 | code | |
patient | S | 1..1 | Reference(DAF-Patient) | |
practitioner | S | 0..1 | Reference(DAF-Pract) | |
encounter | S | 0..1 | Reference(DAF-Encounter) | |
prescription | S | 0..1 | Reference(DAF-MedicationOrder) | |
wasNotGiven | S | 0..1 | boolean | |
reasonNotGiven | S | 0..1 | CodeableConcept | |
effectiveTime[x] | S | 1..1 | dateTime, Period | |
medication[x] | CodeableConcept, Reference(Medication) | Slice: Unordered, Open, by @type | ||
medicationCodeableConcept | S | 1..1 | CodeableConcept | Binding: Medication Clinical Drug (RxNorm) (extensible) |
medicationReference | S | 1..1 | Reference(DAF-Medication) | |
device | S | 0..* | Reference(Device) | |
dosage | S | 0..1 | BackboneElement | |
siteCodeableConcept | S | 0..1 | CodeableConcept | Binding: Vaccine Administered Body Site (preferred) |
route | S | 0..1 | CodeableConcept | Binding: Medication Route FDA Value Set (preferred) |
quantity | S | 0..1 | SimpleQuantity | |
rate[x] | S | 0..1 | Ratio, Range | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | ∑ I | 0..* | MedicationAdministration | Administration of medication to a patient mad-3: Reason given is only permitted if wasNotGiven is false mad-2: Reason not given is only permitted if wasNotGiven is true |
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: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S ∑ | 0..* | Identifier | External identifier |
status | ?! S∑ | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationAdministrationStatus (required) |
patient | S ∑ | 1..1 | Reference(DAF-Patient) | Who received medication |
practitioner | S ∑ | 0..1 | Reference(DAF-Pract) | Who administered substance |
encounter | S ∑ | 0..1 | Reference(DAF-Encounter) | Encounter administered as part of |
prescription | S ∑ | 0..1 | Reference(DAF-MedicationOrder) | Order administration performed against |
wasNotGiven | ?! S∑ | 0..1 | boolean | True if medication not administered |
reasonNotGiven | S ∑I | 0..1 | CodeableConcept | Reason administration not performed Binding: Reason Medication Not Given Codes (example) |
reasonGiven | ∑ I | 0..* | CodeableConcept | Reason administration performed Binding: Reason Medication Given Codes (example) |
effectiveTime[x] | S ∑ | 1..1 | dateTime, Period | Start and end time of administration |
medication[x] | ∑ | CodeableConcept, Reference(Medication) | What was administered Slice: Unordered, Open, by @type | |
medication[x] | ∑ | 1..1 | CodeableConcept, Reference(Medication) | What was administered |
medicationCodeableConcept | S ∑ | 1..1 | CodeableConcept | What was administered Binding: Medication Clinical Drug (RxNorm) (extensible) |
medicationReference | S ∑ | 1..1 | Reference(DAF-Medication) | What was administered |
device | S ∑ | 0..* | Reference(Device) | Device used to administer |
note | ∑ | 0..1 | string | Information about the administration |
dosage | S ∑I | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.quantity and dosage.rate[x] |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
text | ∑ | 0..1 | string | Dosage Instructions |
siteCodeableConcept | S ∑ | 0..1 | CodeableConcept | Body site administered to Binding: Vaccine Administered Body Site (preferred) |
route | S ∑ | 0..1 | CodeableConcept | Path of substance into body Binding: Medication Route FDA Value Set (preferred) |
method | ∑ | 0..1 | CodeableConcept | How drug was administered Binding: (unbound) (example) |
quantity | S ∑ | 0..1 | SimpleQuantity | Amount administered in one dose |
rate[x] | S ∑ | 0..1 | Ratio, Range | Dose quantity per unit of time |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
MedicationAdministration.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
MedicationAdministration.status | MedicationAdministrationStatus | required | MedicationAdministrationStatus |
MedicationAdministration.reasonNotGiven | Reason Medication Not Given Codes | example | Reason Medication Not Given Codes |
MedicationAdministration.reasonGiven | Reason Medication Given Codes | example | Reason Medication Given Codes |
MedicationAdministration.medicationCodeableConcept | Medication Clinical Drug (RxNorm) | extensible | Medication Clinical Drug (RxNorm) |
MedicationAdministration.dosage.siteCodeableConcept | Vaccine Administered Body Site | preferred | Vaccine Administered Body Site |
MedicationAdministration.dosage.route | Medication Route FDA Value Set | preferred | Medication Route FDA Value Set |
MedicationAdministration.dosage.method | ?ext | example |
Id | Path | Details | Requirements |
mad-3 | MedicationAdministration | Reason given is only permitted if wasNotGiven is false XPath: not(exists(f:reasonGiven) and f:wasNotGiven/@value=true()) | |
mad-2 | MedicationAdministration | Reason not given is only permitted if wasNotGiven is true XPath: not(exists(f:reasonNotGiven) and f:wasNotGiven/@value=false()) | |
mad-1 | MedicationAdministration.dosage | SHALL have at least one of dosage.quantity and dosage.rate[x] XPath: exists(f:quantity) or exists(f:rateRatio) or exists(f:rateRange) |