Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI MedicationDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-medicationdefinition Version: 1.0.0-ballot2
Standards status: Trial-use Maturity Level: 1 Computable Name: CRMIMedicationDefinition

Represents the definition of a medication, suitable for use in various contexts

Usage:

Formal Views of Profile Content

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

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... artifactUrl S0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S0..1stringBusiness version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... code S0..1CodeableConceptCodes that identify this medication
... ingredient S0..*BackboneElementActive or inactive ingredient
.... Slices for item[x] S1..1CodeableConcept, Reference(Substance | Medication)The actual ingredient or content
Slice: Unordered, Open by type:$this
..... item[x]:itemReference 0..1Reference(Substance | Medication)The actual ingredient or content
...... artifactReference S0..1uriThe artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... artifactUrl S0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier for this medication
... code SΣ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... ingredient S0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] S1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemReference 0..1Reference(Substance | Medication)The actual ingredient or content
...... artifactReference S0..1uriThe artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... artifactUrl S0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S0..1stringBusiness version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier for this medication
... code SΣ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount Σ0..1RatioAmount of drug in package
... ingredient S0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] S1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemReference 0..1Reference(Substance | Medication)The actual ingredient or content
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... artifactReference S0..1uriThe artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes
Medication.ingredient.item[x]:itemReference.typeextensibleResourceType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

Summary

Must-Support: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Medication.ingredient.item[x] is sliced based on the value of type:$this

Maturity: 1

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... artifactUrl S0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S0..1stringBusiness version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... code S0..1CodeableConceptCodes that identify this medication
... ingredient S0..*BackboneElementActive or inactive ingredient
.... Slices for item[x] S1..1CodeableConcept, Reference(Substance | Medication)The actual ingredient or content
Slice: Unordered, Open by type:$this
..... item[x]:itemReference 0..1Reference(Substance | Medication)The actual ingredient or content
...... artifactReference S0..1uriThe artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... artifactUrl S0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier for this medication
... code SΣ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... ingredient S0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] S1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemReference 0..1Reference(Substance | Medication)The actual ingredient or content
...... artifactReference S0..1uriThe artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... artifactUrl S0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S0..1stringBusiness version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier for this medication
... code SΣ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount Σ0..1RatioAmount of drug in package
... ingredient S0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] S1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemReference 0..1Reference(Substance | Medication)The actual ingredient or content
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... artifactReference S0..1uriThe artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes
Medication.ingredient.item[x]:itemReference.typeextensibleResourceType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

Summary

Must-Support: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Medication.ingredient.item[x] is sliced based on the value of type:$this

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron