Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-medicationdefinition | Version: 1.1.0-cibuild | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRMIMedicationDefinition | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.8 |
Represents the definition of a medication, suitable for use in various contexts
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
artifactUrl | S | 0..1 | uri | Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
artifactVersion | S | 0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
identifier | S | 0..* | Identifier | Business identifier for this medication |
code | S | 0..1 | CodeableConcept | Codes that identify this medication |
ingredient | S | 0..* | BackboneElement | Active or inactive ingredient |
Slices for item[x] | S | 1..1 | CodeableConcept, Reference(Substance | Medication) | The actual ingredient or content Slice: Unordered, Open by type:$this |
item[x]:itemReference | 0..1 | Reference(Substance | Medication) | The actual ingredient or content | |
Slices for extension | Content/Rules for all slices | |||
artifactReference | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
extension | 0..0 | |||
value[x] | 1..1 | uri | Value of extension | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
artifactVersion | S | 0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifier for this medication |
code | SΣ | 0..1 | CodeableConcept | Codes that identify 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: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
ingredient | S | 0..* | BackboneElement | Active or inactive ingredient |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for item[x] | S | 1..1 | The actual ingredient or content Slice: Unordered, Open by type:$this | |
itemCodeableConcept | CodeableConcept | |||
itemReference | Reference(Substance | Medication) | |||
item[x]:itemReference | 0..1 | Reference(Substance | Medication) | The actual ingredient or content | |
Slices for extension | Content/Rules for all slices | |||
artifactReference | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
value[x] | 1..1 | uri | Value of extension | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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 | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |||||
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.
| |||||
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | ||||
artifactVersion | S | 0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifier for this medication | ||||
code | SΣ | 0..1 | CodeableConcept | Codes that identify 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: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||
ingredient | S | 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] | S | 1..1 | The actual ingredient or content Slice: Unordered, Open by type:$this | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Substance | Medication) | |||||||
item[x]:itemReference | 0..1 | Reference(Substance | Medication) | The actual ingredient or content | |||||
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 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
value[x] | 1..1 | uri | Value of extension | |||||
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 | |||||
batch | 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 | ||||
lotNumber | 0..1 | string | Identifier assigned to batch | |||||
expirationDate | 0..1 | dateTime | When batch will expire | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | ||||
Medication.form | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | ||||
Medication.ingredient.item[x]:itemReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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() |
This structure is derived from Medication
Summary
Must-Support: 7 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
artifactUrl | S | 0..1 | uri | Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
artifactVersion | S | 0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
identifier | S | 0..* | Identifier | Business identifier for this medication |
code | S | 0..1 | CodeableConcept | Codes that identify this medication |
ingredient | S | 0..* | BackboneElement | Active or inactive ingredient |
Slices for item[x] | S | 1..1 | CodeableConcept, Reference(Substance | Medication) | The actual ingredient or content Slice: Unordered, Open by type:$this |
item[x]:itemReference | 0..1 | Reference(Substance | Medication) | The actual ingredient or content | |
Slices for extension | Content/Rules for all slices | |||
artifactReference | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
extension | 0..0 | |||
value[x] | 1..1 | uri | Value of extension | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
artifactVersion | S | 0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifier for this medication |
code | SΣ | 0..1 | CodeableConcept | Codes that identify 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: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
ingredient | S | 0..* | BackboneElement | Active or inactive ingredient |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for item[x] | S | 1..1 | The actual ingredient or content Slice: Unordered, Open by type:$this | |
itemCodeableConcept | CodeableConcept | |||
itemReference | Reference(Substance | Medication) | |||
item[x]:itemReference | 0..1 | Reference(Substance | Medication) | The actual ingredient or content | |
Slices for extension | Content/Rules for all slices | |||
artifactReference | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
value[x] | 1..1 | uri | Value of extension | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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 | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |||||
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.
| |||||
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | ||||
artifactVersion | S | 0..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifier for this medication | ||||
code | SΣ | 0..1 | CodeableConcept | Codes that identify 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: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||
ingredient | S | 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] | S | 1..1 | The actual ingredient or content Slice: Unordered, Open by type:$this | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Substance | Medication) | |||||||
item[x]:itemReference | 0..1 | Reference(Substance | Medication) | The actual ingredient or content | |||||
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 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
value[x] | 1..1 | uri | Value of extension | |||||
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 | |||||
batch | 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 | ||||
lotNumber | 0..1 | string | Identifier assigned to batch | |||||
expirationDate | 0..1 | dateTime | When batch will expire | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | ||||
Medication.form | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | ||||
Medication.ingredient.item[x]:itemReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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() |
This structure is derived from Medication
Summary
Must-Support: 7 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron