Retrieval of Real World Data for Clinical Research, published by HL7 International - Biomedical Research & Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/vulcan-rwd/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: MedicationAdministrationRwd

A profile on MedicationAdministration that indicates the minimum set of attributes required for finding patients who may be taking certain medications.

Usage:

• Refer to this Resource Profile: MedicationStatementRwd
• Examples for this Resource Profile: MedicationAdministration/RWDMedicationAdministration

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from MedicationAdministration

Name	Flags	Card.	Type	Description & Constraints
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	CodeableConcept, Reference(Medication)	What was administered Slice: Unordered, Open by type:$this
medicationReference		0..1	Reference(IPA-Medication)	What was administered
subject	S	1..1	Reference(IPA-Patient)	Who received medication
effective[x]	S	1..1	dateTime, Period	Start and end time of administration
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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.
Slices for medication[x]	SΣ	1..1		What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationReference	Σ	0..1	Reference(IPA-Medication)	What was administered
subject	SΣ	1..1	Reference(IPA-Patient)	Who received medication
effective[x]	SΣ	1..1		Start and end time of administration
effectiveDateTime			dateTime
effectivePeriod			Period
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationAdministration.status	required	MedicationAdministration Status Codes
MedicationAdministration.medication[x]	example	SNOMEDCTMedicationCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
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 Bindings Purpose AllLanguages Max Binding
text		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		0..*	Identifier	External identifier
instantiates	Σ	0..*	uri	Instantiates protocol or definition
partOf	Σ	0..*	Reference(MedicationAdministration | Procedure)	Part of referenced event
status	?!SΣ	1..1	code	in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
statusReason		0..*	CodeableConcept	Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
category		0..1	CodeableConcept	Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.
Slices for medication[x]	SΣ	1..1		What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationReference	Σ	0..1	Reference(IPA-Medication)	What was administered
subject	SΣ	1..1	Reference(IPA-Patient)	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
effectivePeriod			Period
performer	Σ	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	Σ	1..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)	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		0..1	Reference(MedicationRequest)	Request administration performed against
device		0..*	Reference(Device)	Device used to administer
note		0..*	Annotation	Information about the administration
dosage	C	0..1	BackboneElement	Details of how medication was taken
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		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	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationAdministration.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MedicationAdministration.status	required	MedicationAdministration Status Codes
MedicationAdministration.statusReason	example	SNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.category	preferred	MedicationAdministration Category Codes
MedicationAdministration.medication[x]	example	SNOMEDCTMedicationCodes
MedicationAdministration.performer.function	example	MedicationAdministration Performer Function Codes
MedicationAdministration.reasonCode	example	ReasonMedicationGivenCodes
MedicationAdministration.dosage.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationAdministration.dosage.route	example	SNOMEDCTRouteCodes
MedicationAdministration.dosage.method	example	SNOMEDCTAdministrationMethodCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

• IPA-Medication (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication)
• IPA-Patient (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient)

Slices

This structure defines the following Slices:

• The element MedicationAdministration.medication[x] is sliced based on the value of type:$this

Differential View

This structure is derived from MedicationAdministration

Name	Flags	Card.	Type	Description & Constraints
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	CodeableConcept, Reference(Medication)	What was administered Slice: Unordered, Open by type:$this
medicationReference		0..1	Reference(IPA-Medication)	What was administered
subject	S	1..1	Reference(IPA-Patient)	Who received medication
effective[x]	S	1..1	dateTime, Period	Start and end time of administration
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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.
Slices for medication[x]	SΣ	1..1		What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationReference	Σ	0..1	Reference(IPA-Medication)	What was administered
subject	SΣ	1..1	Reference(IPA-Patient)	Who received medication
effective[x]	SΣ	1..1		Start and end time of administration
effectiveDateTime			dateTime
effectivePeriod			Period
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationAdministration.status	required	MedicationAdministration Status Codes
MedicationAdministration.medication[x]	example	SNOMEDCTMedicationCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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 Bindings Purpose AllLanguages Max Binding
text		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		0..*	Identifier	External identifier
instantiates	Σ	0..*	uri	Instantiates protocol or definition
partOf	Σ	0..*	Reference(MedicationAdministration | Procedure)	Part of referenced event
status	?!SΣ	1..1	code	in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
statusReason		0..*	CodeableConcept	Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
category		0..1	CodeableConcept	Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.
Slices for medication[x]	SΣ	1..1		What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationReference	Σ	0..1	Reference(IPA-Medication)	What was administered
subject	SΣ	1..1	Reference(IPA-Patient)	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
effectivePeriod			Period
performer	Σ	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	Σ	1..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)	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		0..1	Reference(MedicationRequest)	Request administration performed against
device		0..*	Reference(Device)	Device used to administer
note		0..*	Annotation	Information about the administration
dosage	C	0..1	BackboneElement	Details of how medication was taken
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		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	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MedicationAdministration.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MedicationAdministration.status	required	MedicationAdministration Status Codes
MedicationAdministration.statusReason	example	SNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.category	preferred	MedicationAdministration Category Codes
MedicationAdministration.medication[x]	example	SNOMEDCTMedicationCodes
MedicationAdministration.performer.function	example	MedicationAdministration Performer Function Codes
MedicationAdministration.reasonCode	example	ReasonMedicationGivenCodes
MedicationAdministration.dosage.site	example	SNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationAdministration.dosage.route	example	SNOMEDCTRouteCodes
MedicationAdministration.dosage.method	example	SNOMEDCTAdministrationMethodCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

• IPA-Medication (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication)
• IPA-Patient (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient)

Slices

This structure defines the following Slices:

• The element MedicationAdministration.medication[x] is sliced based on the value of type:$this

Other representations of profile: CSV, Excel, Schematron