Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot International flag

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

Resource Profile: CRMI MedicationKnowledge Definition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-medicationknowledgedefinition Version: 1.0.0-snapshot
Standards status: Trial-use Maturity Level: 1 Computable Name: CRMIMedicationKnowledgeDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.9

Represents the definition of medication knowledge, 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 MedicationKnowledge

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... artifactUrl S 0..1 uri Canonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S 0..1 string Business version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... relatedMedicationKnowledge
.... reference
..... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... associatedMedication
.... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... ingredient
.... Slices for item[x] 1..1 CodeableConcept, Reference(Substance) Medication(s) or substance(s) contained in the medication
Slice: Unordered, Open by type:$this
..... item[x]:itemReference 0..1 Reference(Substance) Medication(s) or substance(s) contained in the medication
...... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
... 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
... artifactUrl S 0..1 uri Canonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 0..1 CodeableConcept Code that identifies this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

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

... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
..... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... associatedMedication 0..* Reference(Medication) A medication resource that is associated with this medication
.... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... ingredient 0..* BackboneElement Active or inactive ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1 Medication(s) or substance(s) contained in the medication
Slice: Unordered, Open by type:$this
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance)
..... item[x]:itemReference 0..1 Reference(Substance) Medication(s) or substance(s) contained in the medication
...... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationKnowledgeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationKnowledgeIf 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-4errorMedicationKnowledgeIf 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-5errorMedicationKnowledgeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationKnowledgeA 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
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... artifactUrl S 0..1 uri Canonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S 0..1 string Business version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 0..1 CodeableConcept Code that identifies this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

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

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

... amount Σ 0..1 SimpleQuantity Amount of drug in package
... synonym Σ 0..* string Additional names for a medication
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... 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
.... type 1..1 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
..... 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
..... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
..... 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): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... associatedMedication 0..* Reference(Medication) A medication resource that is associated with this medication
.... 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
.... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
.... 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): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... productType 0..* CodeableConcept Category of the medication or product
... monograph 0..* BackboneElement Associated documentation about the medication
.... 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
.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference | Media) Associated documentation about the medication
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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
.... Slices for item[x] 1..1 Medication(s) or substance(s) contained in the medication
Slice: Unordered, Open by type:$this
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance)
..... item[x]:itemReference 0..1 Reference(Substance) Medication(s) or substance(s) contained in the medication
...... 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
...... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
...... 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): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example): A coded concept defining the intended route of administration.


... cost 0..* BackboneElement The pricing of the medication
.... 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
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost 1..1 Money The price of the medication
... monitoringProgram 0..* BackboneElement Program under which a medication is reviewed
.... 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
.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... administrationGuidelines 0..* BackboneElement Guidelines for administration of the medication
.... 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
.... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
..... 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
..... type 1..1 CodeableConcept Type of dosage
..... dosage 1..* Dosage Dosage for the medication for the specific guidelines
.... indication[x] 0..1 Indication for use that apply to the specific administration guidelines
..... indicationCodeableConcept CodeableConcept
..... indicationReference Reference(ObservationDefinition)
.... patientCharacteristics 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
..... 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
..... characteristic[x] 1..1 Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConcept CodeableConcept
...... characteristicQuantity Quantity(SimpleQuantity)
..... value 0..* string The specific characteristic
... medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
.... 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
.... type 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..* CodeableConcept Specific category assigned to the medication
... packaging 0..1 BackboneElement Details about packaged medications
.... 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
.... type 0..1 CodeableConcept A code that defines the specific type of packaging that the medication can be found in
Binding: medicationKnowledge Package Type Codes (example): A coded concept defining the type of packaging of a medication.

.... quantity 0..1 SimpleQuantity The number of product units the package would contain if fully loaded
... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
.... 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
.... type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Binding: medicationKnowledge Characteristic Codes (example): A coded concept defining the characteristic types of a medication.

.... value[x] 0..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
... contraindication 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s)
... regulatory 0..* BackboneElement Regulatory information about a medication
.... 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
.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
..... 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
..... type 1..1 CodeableConcept Specifies the type of substitution allowed
..... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
.... schedule 0..* BackboneElement Specifies the schedule of a medication in jurisdiction
..... 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
..... schedule 1..1 CodeableConcept Specifies the specific drug schedule
.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... 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
..... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
..... period 0..1 Duration The period that applies to the maximum number of units
... kinetics 0..* BackboneElement The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... 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
.... areaUnderCurve 0..* SimpleQuantity The drug concentration measured at certain discrete points in time
.... lethalDose50 0..* SimpleQuantity The median lethal dose of a drug
.... halfLifePeriod 0..1 Duration Time required for concentration in the body to decrease by half

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
MedicationKnowledge.relatedMedicationKnowledge.reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationKnowledge.associatedMedication.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationKnowledge.ingredient.item[x]:itemReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationKnowledge.intendedRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationKnowledge.packaging.typeexamplemedicationKnowledge Package Type Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-package-type
from the FHIR Standard
MedicationKnowledge.drugCharacteristic.typeexamplemedicationKnowledge Characteristic Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-characteristic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationKnowledgeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationKnowledgeIf 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-4errorMedicationKnowledgeIf 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-5errorMedicationKnowledgeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationKnowledgeA 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 MedicationKnowledge

Summary

Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationKnowledge.ingredient.item[x]

Maturity: 1

Differential View

This structure is derived from MedicationKnowledge

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... artifactUrl S 0..1 uri Canonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S 0..1 string Business version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... relatedMedicationKnowledge
.... reference
..... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... associatedMedication
.... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... ingredient
.... Slices for item[x] 1..1 CodeableConcept, Reference(Substance) Medication(s) or substance(s) contained in the medication
Slice: Unordered, Open by type:$this
..... item[x]:itemReference 0..1 Reference(Substance) Medication(s) or substance(s) contained in the medication
...... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
... 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
... artifactUrl S 0..1 uri Canonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 0..1 CodeableConcept Code that identifies this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

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

... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
..... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... associatedMedication 0..* Reference(Medication) A medication resource that is associated with this medication
.... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
... ingredient 0..* BackboneElement Active or inactive ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1 Medication(s) or substance(s) contained in the medication
Slice: Unordered, Open by type:$this
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance)
..... item[x]:itemReference 0..1 Reference(Substance) Medication(s) or substance(s) contained in the medication
...... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationKnowledgeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationKnowledgeIf 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-4errorMedicationKnowledgeIf 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-5errorMedicationKnowledgeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationKnowledgeA 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
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... artifactUrl S 0..1 uri Canonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... artifactVersion S 0..1 string Business version of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 0..1 CodeableConcept Code that identifies this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

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

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

... amount Σ 0..1 SimpleQuantity Amount of drug in package
... synonym Σ 0..* string Additional names for a medication
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... 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
.... type 1..1 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
..... 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
..... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
..... 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): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... associatedMedication 0..* Reference(Medication) A medication resource that is associated with this medication
.... 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
.... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
.... 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): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... productType 0..* CodeableConcept Category of the medication or product
... monograph 0..* BackboneElement Associated documentation about the medication
.... 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
.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference | Media) Associated documentation about the medication
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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
.... Slices for item[x] 1..1 Medication(s) or substance(s) contained in the medication
Slice: Unordered, Open by type:$this
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance)
..... item[x]:itemReference 0..1 Reference(Substance) Medication(s) or substance(s) contained in the medication
...... 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
...... artifactReference S 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
...... 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): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example): A coded concept defining the intended route of administration.


... cost 0..* BackboneElement The pricing of the medication
.... 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
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost 1..1 Money The price of the medication
... monitoringProgram 0..* BackboneElement Program under which a medication is reviewed
.... 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
.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... administrationGuidelines 0..* BackboneElement Guidelines for administration of the medication
.... 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
.... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
..... 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
..... type 1..1 CodeableConcept Type of dosage
..... dosage 1..* Dosage Dosage for the medication for the specific guidelines
.... indication[x] 0..1 Indication for use that apply to the specific administration guidelines
..... indicationCodeableConcept CodeableConcept
..... indicationReference Reference(ObservationDefinition)
.... patientCharacteristics 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
..... 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
..... characteristic[x] 1..1 Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConcept CodeableConcept
...... characteristicQuantity Quantity(SimpleQuantity)
..... value 0..* string The specific characteristic
... medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
.... 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
.... type 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..* CodeableConcept Specific category assigned to the medication
... packaging 0..1 BackboneElement Details about packaged medications
.... 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
.... type 0..1 CodeableConcept A code that defines the specific type of packaging that the medication can be found in
Binding: medicationKnowledge Package Type Codes (example): A coded concept defining the type of packaging of a medication.

.... quantity 0..1 SimpleQuantity The number of product units the package would contain if fully loaded
... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
.... 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
.... type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Binding: medicationKnowledge Characteristic Codes (example): A coded concept defining the characteristic types of a medication.

.... value[x] 0..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
... contraindication 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s)
... regulatory 0..* BackboneElement Regulatory information about a medication
.... 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
.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
..... 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
..... type 1..1 CodeableConcept Specifies the type of substitution allowed
..... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
.... schedule 0..* BackboneElement Specifies the schedule of a medication in jurisdiction
..... 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
..... schedule 1..1 CodeableConcept Specifies the specific drug schedule
.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... 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
..... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
..... period 0..1 Duration The period that applies to the maximum number of units
... kinetics 0..* BackboneElement The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... 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
.... areaUnderCurve 0..* SimpleQuantity The drug concentration measured at certain discrete points in time
.... lethalDose50 0..* SimpleQuantity The median lethal dose of a drug
.... halfLifePeriod 0..1 Duration Time required for concentration in the body to decrease by half

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
MedicationKnowledge.relatedMedicationKnowledge.reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationKnowledge.associatedMedication.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationKnowledge.ingredient.item[x]:itemReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationKnowledge.intendedRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationKnowledge.packaging.typeexamplemedicationKnowledge Package Type Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-package-type
from the FHIR Standard
MedicationKnowledge.drugCharacteristic.typeexamplemedicationKnowledge Characteristic Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-characteristic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationKnowledgeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationKnowledgeIf 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-4errorMedicationKnowledgeIf 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-5errorMedicationKnowledgeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationKnowledgeA 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 MedicationKnowledge

Summary

Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationKnowledge.ingredient.item[x]

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron