Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-MedicationAdministration | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_MedicationAdministration_R4B | ||
This cross-version profile allows STU3 MedicationAdministration content to be represented via FHIR R4B MedicationAdministration resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MedicationAdministration |
0..* | MedicationAdministration(4.3.0) | 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 Constraints: ext-1 | |
   extension:definition |
0..* | Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.definition Constraints: ext-1 | |
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:notGiven |
?! | 0..1 | boolean | STU3: True if medication not administered (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.notGiven Constraints: ext-1 |
| status |
?!Σ | 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 extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
 extension:status |
0..1 | code | STU3: in-progress | on-hold | completed | entered-in-error | stopped | unknown additional codes URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.status Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Constraints: ext-1 | |
 medication[x] |
Σ | 1..1 | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
 medication[x]All Types |
Content/Rules for all Types | |||
  Slices for extension |
Content/Rules for all slices | |||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: medication additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
 medicationCodeableConcept |
CodeableConcept | |||
  medicationReference |
Reference(Medication) | |||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:subject |
0..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| effective[x] |
Σ | 1..1 | Start and end time of administration | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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 | MedicationAdministration.implicitRules, MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.status, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.medication[x], MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject, MedicationAdministration.effective[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration(4.3.0) | Administration of medication to a patient | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:definition |
0..* | Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.definition Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:notGiven |
?! | 0..1 | boolean | STU3: True if medication not administered (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.notGiven Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | External identifier | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..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) | ||||
| instantiates |
Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:partOf |
0..1 | Reference(Resource) | STU3: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| status |
?!Σ | 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. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | STU3: in-progress | on-hold | completed | entered-in-error | stopped | unknown additional codes URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.status Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| 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] |
Σ | 1..1 | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
| medication[x]All Types |
Content/Rules for all Types | |||||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: medication additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:context |
0..1 | Reference(Resource) | STU3: context additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support administration | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:supportingInformation |
0..1 | Reference(Resource) | STU3: supportingInformation additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| effective[x] |
Σ | 1..1 | Start and end time of administration | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| performer |
Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:onBehalfOf |
0..1 | Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B(0.1.0) | Organization) | STU3: Organization organization was acting for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.performer.onBehalfOf Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actor |
0..1 | Reference(Resource) | STU3: Individual who was performing URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reasonReference |
0..1 | Reference(Resource) | STU3: Condition or Observation that supports why the medication was administered additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:prescription |
0..1 | Reference(Resource) | STU3: prescription additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:device |
0..1 | Reference(Resource) | STU3: device additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Information about the administration | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| dosage |
C | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| text |
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 |
0..1 | SimpleQuantity(4.3.0) | Amount of medication per dose | |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:eventHistory |
0..1 | Reference(Resource) | STU3: eventHistory additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.partOf.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.statusReason | Base | example | SNOMED CT Reason Medication Not Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.category | Base | preferred | MedicationAdministration Category Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.context.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.supportingInformation.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.function | Base | example | MedicationAdministration Performer Function Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.reasonCode | Base | example | Reason Medication Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.reasonReference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.request.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.device.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.route | Base | example | SNOMED CT Route Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.eventHistory.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | MedicationAdministration.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | MedicationAdministration.meta, MedicationAdministration.meta.extension, MedicationAdministration.meta.extension:meta, MedicationAdministration.meta.versionId, MedicationAdministration.meta.lastUpdated, MedicationAdministration.meta.source, MedicationAdministration.meta.profile, MedicationAdministration.meta.security, MedicationAdministration.meta.tag, MedicationAdministration.implicitRules, MedicationAdministration.language, MedicationAdministration.text, MedicationAdministration.text.extension, MedicationAdministration.text.extension:text, MedicationAdministration.text.status, MedicationAdministration.text.div, MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.identifier, MedicationAdministration.identifier.extension, MedicationAdministration.identifier.extension:identifier, MedicationAdministration.identifier.use, MedicationAdministration.identifier.type, MedicationAdministration.identifier.system, MedicationAdministration.identifier.value, MedicationAdministration.identifier.period, MedicationAdministration.identifier.assigner, MedicationAdministration.instantiates, MedicationAdministration.partOf, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.partOf.reference, MedicationAdministration.partOf.type, MedicationAdministration.partOf.identifier, MedicationAdministration.partOf.display, MedicationAdministration.status, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.statusReason, MedicationAdministration.category, MedicationAdministration.medication[x], MedicationAdministration.medication[x].extension, MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject, MedicationAdministration.subject.reference, MedicationAdministration.subject.type, MedicationAdministration.subject.identifier, MedicationAdministration.subject.display, MedicationAdministration.context, MedicationAdministration.context.extension, MedicationAdministration.context.extension:context, MedicationAdministration.context.reference, MedicationAdministration.context.type, MedicationAdministration.context.identifier, MedicationAdministration.context.display, MedicationAdministration.supportingInformation, MedicationAdministration.supportingInformation.extension, MedicationAdministration.supportingInformation.extension:supportingInformation, MedicationAdministration.supportingInformation.reference, MedicationAdministration.supportingInformation.type, MedicationAdministration.supportingInformation.identifier, MedicationAdministration.supportingInformation.display, MedicationAdministration.effective[x], MedicationAdministration.performer, MedicationAdministration.performer.extension, MedicationAdministration.performer.extension:onBehalfOf, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.function, MedicationAdministration.performer.actor, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.performer.actor.reference, MedicationAdministration.performer.actor.type, MedicationAdministration.performer.actor.identifier, MedicationAdministration.performer.actor.display, MedicationAdministration.reasonCode, MedicationAdministration.reasonReference, MedicationAdministration.reasonReference.extension, MedicationAdministration.reasonReference.extension:reasonReference, MedicationAdministration.reasonReference.reference, MedicationAdministration.reasonReference.type, MedicationAdministration.reasonReference.identifier, MedicationAdministration.reasonReference.display, MedicationAdministration.request, MedicationAdministration.request.extension, MedicationAdministration.request.extension:prescription, MedicationAdministration.request.reference, MedicationAdministration.request.type, MedicationAdministration.request.identifier, MedicationAdministration.request.display, MedicationAdministration.device, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.device.reference, MedicationAdministration.device.type, MedicationAdministration.device.identifier, MedicationAdministration.device.display, MedicationAdministration.note, MedicationAdministration.note.extension, MedicationAdministration.note.extension:note, MedicationAdministration.note.author[x], MedicationAdministration.note.time, MedicationAdministration.note.text, MedicationAdministration.dosage, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension, MedicationAdministration.dosage.text, MedicationAdministration.dosage.site, MedicationAdministration.dosage.route, MedicationAdministration.dosage.method, MedicationAdministration.dosage.dose, MedicationAdministration.dosage.rate[x], MedicationAdministration.eventHistory, MedicationAdministration.eventHistory.extension, MedicationAdministration.eventHistory.extension:eventHistory, MedicationAdministration.eventHistory.reference, MedicationAdministration.eventHistory.type, MedicationAdministration.eventHistory.identifier, MedicationAdministration.eventHistory.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.meta.extension, MedicationAdministration.meta.extension:meta, MedicationAdministration.text.extension, MedicationAdministration.text.extension:text, MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.identifier.extension, MedicationAdministration.identifier.extension:identifier, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.medication[x].extension, MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject, MedicationAdministration.context.extension, MedicationAdministration.context.extension:context, MedicationAdministration.supportingInformation.extension, MedicationAdministration.supportingInformation.extension:supportingInformation, MedicationAdministration.performer.extension, MedicationAdministration.performer.extension:onBehalfOf, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.reasonReference.extension, MedicationAdministration.reasonReference.extension:reasonReference, MedicationAdministration.request.extension, MedicationAdministration.request.extension:prescription, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.note.extension, MedicationAdministration.note.extension:note, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension, MedicationAdministration.eventHistory.extension, MedicationAdministration.eventHistory.extension:eventHistory | 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()
|
| txt-1 | error | MedicationAdministration.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | MedicationAdministration.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from MedicationAdministration
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration(4.3.0) | 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 Constraints: ext-1 | |
| extension:definition |
0..* | Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.definition Constraints: ext-1 | |
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:notGiven |
?! | 0..1 | boolean | STU3: True if medication not administered (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.notGiven Constraints: ext-1 |
| status |
?!Σ | 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 extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:status |
0..1 | code | STU3: in-progress | on-hold | completed | entered-in-error | stopped | unknown additional codes URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.status Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Constraints: ext-1 | |
| medication[x] |
Σ | 1..1 | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
| medication[x]All Types |
Content/Rules for all Types | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: medication additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| medicationCodeableConcept |
CodeableConcept | |||
| medicationReference |
Reference(Medication) | |||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:subject |
0..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| effective[x] |
Σ | 1..1 | Start and end time of administration | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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 | MedicationAdministration.implicitRules, MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.status, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.medication[x], MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject, MedicationAdministration.effective[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from MedicationAdministration
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration(4.3.0) | Administration of medication to a patient | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:definition |
0..* | Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.definition Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:notGiven |
?! | 0..1 | boolean | STU3: True if medication not administered (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.notGiven Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | External identifier | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..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) | ||||
| instantiates |
Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:partOf |
0..1 | Reference(Resource) | STU3: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| status |
?!Σ | 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. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | STU3: in-progress | on-hold | completed | entered-in-error | stopped | unknown additional codes URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.status Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| 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] |
Σ | 1..1 | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
| medication[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: medication additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:context |
0..1 | Reference(Resource) | STU3: context additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support administration | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:supportingInformation |
0..1 | Reference(Resource) | STU3: supportingInformation additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| effective[x] |
Σ | 1..1 | Start and end time of administration | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| performer |
Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:onBehalfOf |
0..1 | Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B(0.1.0) | Organization) | STU3: Organization organization was acting for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.performer.onBehalfOf Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actor |
0..1 | Reference(Resource) | STU3: Individual who was performing URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reasonReference |
0..1 | Reference(Resource) | STU3: Condition or Observation that supports why the medication was administered additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:prescription |
0..1 | Reference(Resource) | STU3: prescription additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:device |
0..1 | Reference(Resource) | STU3: device additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Information about the administration | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationAdministration.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| dosage |
C | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| text |
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 |
0..1 | SimpleQuantity(4.3.0) | Amount of medication per dose | |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:eventHistory |
0..1 | Reference(Resource) | STU3: eventHistory additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
Σ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) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.partOf.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.statusReason | Base | example | SNOMED CT Reason Medication Not Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.category | Base | preferred | MedicationAdministration Category Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.context.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.supportingInformation.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.function | Base | example | MedicationAdministration Performer Function Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.reasonCode | Base | example | Reason Medication Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.reasonReference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.request.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.device.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.route | Base | example | SNOMED CT Route Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.eventHistory.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | MedicationAdministration.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | MedicationAdministration.meta, MedicationAdministration.meta.extension, MedicationAdministration.meta.extension:meta, MedicationAdministration.meta.versionId, MedicationAdministration.meta.lastUpdated, MedicationAdministration.meta.source, MedicationAdministration.meta.profile, MedicationAdministration.meta.security, MedicationAdministration.meta.tag, MedicationAdministration.implicitRules, MedicationAdministration.language, MedicationAdministration.text, MedicationAdministration.text.extension, MedicationAdministration.text.extension:text, MedicationAdministration.text.status, MedicationAdministration.text.div, MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.identifier, MedicationAdministration.identifier.extension, MedicationAdministration.identifier.extension:identifier, MedicationAdministration.identifier.use, MedicationAdministration.identifier.type, MedicationAdministration.identifier.system, MedicationAdministration.identifier.value, MedicationAdministration.identifier.period, MedicationAdministration.identifier.assigner, MedicationAdministration.instantiates, MedicationAdministration.partOf, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.partOf.reference, MedicationAdministration.partOf.type, MedicationAdministration.partOf.identifier, MedicationAdministration.partOf.display, MedicationAdministration.status, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.statusReason, MedicationAdministration.category, MedicationAdministration.medication[x], MedicationAdministration.medication[x].extension, MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject, MedicationAdministration.subject.reference, MedicationAdministration.subject.type, MedicationAdministration.subject.identifier, MedicationAdministration.subject.display, MedicationAdministration.context, MedicationAdministration.context.extension, MedicationAdministration.context.extension:context, MedicationAdministration.context.reference, MedicationAdministration.context.type, MedicationAdministration.context.identifier, MedicationAdministration.context.display, MedicationAdministration.supportingInformation, MedicationAdministration.supportingInformation.extension, MedicationAdministration.supportingInformation.extension:supportingInformation, MedicationAdministration.supportingInformation.reference, MedicationAdministration.supportingInformation.type, MedicationAdministration.supportingInformation.identifier, MedicationAdministration.supportingInformation.display, MedicationAdministration.effective[x], MedicationAdministration.performer, MedicationAdministration.performer.extension, MedicationAdministration.performer.extension:onBehalfOf, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.function, MedicationAdministration.performer.actor, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.performer.actor.reference, MedicationAdministration.performer.actor.type, MedicationAdministration.performer.actor.identifier, MedicationAdministration.performer.actor.display, MedicationAdministration.reasonCode, MedicationAdministration.reasonReference, MedicationAdministration.reasonReference.extension, MedicationAdministration.reasonReference.extension:reasonReference, MedicationAdministration.reasonReference.reference, MedicationAdministration.reasonReference.type, MedicationAdministration.reasonReference.identifier, MedicationAdministration.reasonReference.display, MedicationAdministration.request, MedicationAdministration.request.extension, MedicationAdministration.request.extension:prescription, MedicationAdministration.request.reference, MedicationAdministration.request.type, MedicationAdministration.request.identifier, MedicationAdministration.request.display, MedicationAdministration.device, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.device.reference, MedicationAdministration.device.type, MedicationAdministration.device.identifier, MedicationAdministration.device.display, MedicationAdministration.note, MedicationAdministration.note.extension, MedicationAdministration.note.extension:note, MedicationAdministration.note.author[x], MedicationAdministration.note.time, MedicationAdministration.note.text, MedicationAdministration.dosage, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension, MedicationAdministration.dosage.text, MedicationAdministration.dosage.site, MedicationAdministration.dosage.route, MedicationAdministration.dosage.method, MedicationAdministration.dosage.dose, MedicationAdministration.dosage.rate[x], MedicationAdministration.eventHistory, MedicationAdministration.eventHistory.extension, MedicationAdministration.eventHistory.extension:eventHistory, MedicationAdministration.eventHistory.reference, MedicationAdministration.eventHistory.type, MedicationAdministration.eventHistory.identifier, MedicationAdministration.eventHistory.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.meta.extension, MedicationAdministration.meta.extension:meta, MedicationAdministration.text.extension, MedicationAdministration.text.extension:text, MedicationAdministration.extension, MedicationAdministration.extension:definition, MedicationAdministration.modifierExtension, MedicationAdministration.modifierExtension:notGiven, MedicationAdministration.identifier.extension, MedicationAdministration.identifier.extension:identifier, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.status.extension, MedicationAdministration.status.extension:status, MedicationAdministration.medication[x].extension, MedicationAdministration.medication[x].extension:alternateReference, MedicationAdministration.subject.extension, MedicationAdministration.subject.extension:subject, MedicationAdministration.context.extension, MedicationAdministration.context.extension:context, MedicationAdministration.supportingInformation.extension, MedicationAdministration.supportingInformation.extension:supportingInformation, MedicationAdministration.performer.extension, MedicationAdministration.performer.extension:onBehalfOf, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.reasonReference.extension, MedicationAdministration.reasonReference.extension:reasonReference, MedicationAdministration.request.extension, MedicationAdministration.request.extension:prescription, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.note.extension, MedicationAdministration.note.extension:note, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension, MedicationAdministration.eventHistory.extension, MedicationAdministration.eventHistory.extension:eventHistory | 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()
|
| txt-1 | error | MedicationAdministration.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | MedicationAdministration.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from MedicationAdministration
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change