HL7.FHIR.US.NHSN-ADE\MedicationAdministration - Antidiabetics

NHSN Reporting: Adverse Drug Events - Glycemic Control
0.1.0 - CI Build

NHSN Reporting: Adverse Drug Events - Glycemic Control, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/fhir-nhsn-ade-ig/ and changes regularly. See the Directory of published versions

Resource Profile: MedicationAdministration - Antidiabetics

Defining URL:

http://hl7.org/fhir/us/nhsn-ade/StructureDefinition/MedicationAdministration-Antidiabetics

Version:

0.1.0

Name:

MedicationAdministrationAntidiabetics

Title:

MedicationAdministration Antidiabetic Drugs

Status:

Active as of 1/10/22, 5:39 AM

Definition:

This profile represents the administration of an antidiabetic drug.

Publisher:

HL7 International - Public Health Work Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/nhsn-ade/StructureDefinition/MedicationAdministration-Antidiabetics

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from MedicationAdministration

Summary

Mandatory: 1 element
Must-Support: 6 elements

Slices

This structure defines the following Slices:

The element MedicationAdministration.medicationCodeableConcept.coding is sliced based on the value of pattern:$this

This structure is derived from MedicationAdministration

Name	Flags	Card.	Type	Description & Constraints
MedicationAdministration		0..*	MedicationAdministration	Administration of medication to a patient
medicationCodeableConcept		1..1	CodeableConcept	What was administered
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:oralAntiDiabeticCode	S	0..1	Coding	Oral antidiabetic meds Binding: Oral Antidiabetic Medications (required): Oral antidiabetic codes
coding:injectAntiDiabeticCode	S	0..1	Coding	Injectable antidiabetic meds Binding: Injectable Antidiabetic Medications (required): Injectable antidiabetic codes
effective[x]	S	1..1	dateTime, Period	Start and end time of administration
dosage	S	0..1	BackboneElement	Details of how medication was taken
route	S	0..1	CodeableConcept	Path of substance into body
dose	S	0..1	SimpleQuantity	Amount of medication per dose
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
MedicationAdministration		0..*	MedicationAdministration	Administration of medication to a patient
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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	?!Σ	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]	Σ	1..1	CodeableConcept	What was administered Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
medication[x]:medicationCodeableConcept	Σ	1..1	CodeableConcept	What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:oralAntiDiabeticCode	SΣ	0..1	Coding	Oral antidiabetic meds Binding: Oral Antidiabetic Medications (required): Oral antidiabetic codes
coding:injectAntiDiabeticCode	SΣ	0..1	Coding	Injectable antidiabetic meds Binding: Injectable Antidiabetic Medications (required): Injectable antidiabetic codes
text	Σ	0..1	string	Plain text representation of the concept
subject	Σ	1..1	Reference(Patient \| Group)	Who received medication
context		0..1	Reference(Encounter \| EpisodeOfCare)	Encounter or Episode of Care administered as part of
supportingInformation		0..*	Reference(Resource)	Additional information to support administration
effective[x]	SΣ	1..1		Start and end time of administration
effectiveDateTime			dateTime
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	SI	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	S	0..1	CodeableConcept	Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
method		0..1	CodeableConcept	How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
dose	S	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

Name	Flags	Card.	Type	Description & Constraints
MedicationAdministration		0..*	MedicationAdministration	Administration of medication to a patient
medication[x]:medicationCodeableConcept	Σ	1..1	CodeableConcept	What was administered
coding:oralAntiDiabeticCode	Σ	0..1	Coding	Oral antidiabetic meds Binding: Oral Antidiabetic Medications (required): Oral antidiabetic codes
coding:injectAntiDiabeticCode	Σ	0..1	Coding	Injectable antidiabetic meds Binding: Injectable Antidiabetic Medications (required): Injectable antidiabetic codes
effective[x]	Σ	1..1		Start and end time of administration
effectiveDateTime			dateTime
effectivePeriod			Period
dosage	I	0..1	BackboneElement	Details of how medication was taken
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.
dose		0..1	SimpleQuantity	Amount of medication per dose
Documentation for this format

This structure is derived from MedicationAdministration

Summary

Mandatory: 1 element
Must-Support: 6 elements

Slices

This structure defines the following Slices:

The element MedicationAdministration.medicationCodeableConcept.coding is sliced based on the value of pattern:$this

Differential View

This structure is derived from MedicationAdministration

Name	Flags	Card.	Type	Description & Constraints
MedicationAdministration		0..*	MedicationAdministration	Administration of medication to a patient
medicationCodeableConcept		1..1	CodeableConcept	What was administered
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:oralAntiDiabeticCode	S	0..1	Coding	Oral antidiabetic meds Binding: Oral Antidiabetic Medications (required): Oral antidiabetic codes
coding:injectAntiDiabeticCode	S	0..1	Coding	Injectable antidiabetic meds Binding: Injectable Antidiabetic Medications (required): Injectable antidiabetic codes
effective[x]	S	1..1	dateTime, Period	Start and end time of administration
dosage	S	0..1	BackboneElement	Details of how medication was taken
route	S	0..1	CodeableConcept	Path of substance into body
dose	S	0..1	SimpleQuantity	Amount of medication per dose
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MedicationAdministration		0..*	MedicationAdministration	Administration of medication to a patient
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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	?!Σ	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]	Σ	1..1	CodeableConcept	What was administered Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
medication[x]:medicationCodeableConcept	Σ	1..1	CodeableConcept	What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:oralAntiDiabeticCode	SΣ	0..1	Coding	Oral antidiabetic meds Binding: Oral Antidiabetic Medications (required): Oral antidiabetic codes
coding:injectAntiDiabeticCode	SΣ	0..1	Coding	Injectable antidiabetic meds Binding: Injectable Antidiabetic Medications (required): Injectable antidiabetic codes
text	Σ	0..1	string	Plain text representation of the concept
subject	Σ	1..1	Reference(Patient \| Group)	Who received medication
context		0..1	Reference(Encounter \| EpisodeOfCare)	Encounter or Episode of Care administered as part of
supportingInformation		0..*	Reference(Resource)	Additional information to support administration
effective[x]	SΣ	1..1		Start and end time of administration
effectiveDateTime			dateTime
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	SI	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	S	0..1	CodeableConcept	Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
method		0..1	CodeableConcept	How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
dose	S	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

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
MedicationAdministration.language	preferred	CommonLanguages Max Binding: AllLanguages
MedicationAdministration.status	required	MedicationAdministration Status Codes
MedicationAdministration.statusReason	example	SNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.category	preferred	MedicationAdministration Category Codes
MedicationAdministration.medication[x]	example	SNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:oralAntiDiabeticCode	required	Oral Antidiabetic Medications
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:injectAntiDiabeticCode	required	Injectable Antidiabetic Medications
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	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	MedicationAdministration.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.instantiates	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.statusReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.medication[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept.coding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept.coding:oralAntiDiabeticCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept.coding:injectAntiDiabeticCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.medication[x]:medicationCodeableConcept.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.context	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.supportingInformation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.effective[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.performer.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.performer.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.performer.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.performer.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.performer.function	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.performer.actor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.request	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.device	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.dosage	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
mad-1	error	MedicationAdministration.dosage	SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists()
ele-1	error	MedicationAdministration.dosage.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.dosage.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.dosage.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationAdministration.dosage.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationAdministration.dosage.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.dosage.site	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.dosage.route	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.dosage.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.dosage.dose	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.dosage.rate[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationAdministration.eventHistory	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())