{ "description": "Definition of the medication", "_filename": "StructureDefinition-ch-emed-medication.json", "package_name": "ch.fhir.ig.ch-emed", "date": "2022-12-21T12:57:16+01:00", "derivation": "constraint", "publisher": "HL7 Switzerland", "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "CH", "system": "urn:iso:std:iso:3166" } ] } ], "name": "CHEMEDMedication", "mapping": [ { "uri": "http://ncpdp.org/SCRIPT10_6", "name": "Mapping to NCPDP SCRIPT 10.6", "identity": "script10.6" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping", "identity": "w5" }, { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" } ], "abstract": false, "copyright": "CC-BY-SA-4.0", "type": "Medication", "experimental": "false", "resourceType": "StructureDefinition", "title": "CH EMED Medication", "package_version": "3.0.0", "snapshot": { "element": [ { "constraint": [ { "key": "dom-2", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.contained.empty()" }, { "key": "dom-3", "human": "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", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "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()" }, { "key": "dom-4", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" }, { "key": "dom-5", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.meta.security.empty()" }, { "key": "dom-6", "human": "A resource should have narrative for robust management", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "warning", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "expression": "text.`div`.exists()" }, { "key": "ch-emed-med-1", "human": "Medication or ingredient name has to be specified", "severity": "error", "expression": "code.text.exists() or ingredient.itemCodeableConcept.text.exists()" } ], "path": "Medication", "min": 0, "definition": "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.", "isModifier": false, "short": "CH EMED Medication", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed", "identity": "script10.6" }, { "map": "ManufacturedProduct[classCode=ADMM]", "identity": "rim" } ], "max": "*", "id": "Medication", "base": { "max": "*", "min": 0, "path": "Medication" }, "isSummary": false }, { "path": "Medication.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "isModifier": false, "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id" } ] } ], "max": "1", "id": "Medication.id", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "base": { "max": "1", "min": 0, "path": "Resource.id" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.meta", "min": 0, "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "isModifier": false, "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "max": "1", "id": "Medication.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.implicitRules", "min": 0, "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "max": "1", "id": "Medication.implicitRules", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.language", "min": 0, "definition": "The base language in which the resource is written.", "isModifier": false, "short": "Language of the resource content", "type": [ { "code": "code" } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/languages", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "A human language." }, "max": "1", "id": "Medication.language", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "base": { "max": "1", "min": 0, "path": "Resource.language" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.text", "min": 0, "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "isModifier": false, "short": "Text summary of the resource, for human interpretation", "mapping": [ { "map": "Act.text?", "identity": "rim" } ], "type": [ { "code": "Narrative" } ], "alias": [ "narrative", "html", "xhtml", "display" ], "max": "1", "id": "Medication.text", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "isSummary": false }, { "path": "Medication.contained", "min": 0, "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "isModifier": false, "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "Medication.contained", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.modifierExtension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.identifier", "min": 0, "definition": "Business identifier for this medication.", "isModifier": false, "short": "Business identifier for this medication", "mapping": [ { "map": "FiveWs.identifier", "identity": "w5" }, { "map": ".id", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "max": "*", "id": "Medication.identifier", "comment": "The serial number could be included as an identifier.", "base": { "max": "*", "min": 0, "path": "Medication.identifier" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code", "min": 0, "definition": "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", "isModifier": false, "short": "Codes that identify this medication", "mapping": [ { "map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription", "identity": "script10.6" }, { "map": "FiveWs.class", "identity": "w5" }, { "map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code", "identity": "v2" }, { "map": ".code", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/medication-codes", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationFormalRepresentation" } ], "description": "A coded concept that defines the type of a medication." }, "max": "1", "id": "Medication.code", "comment": "Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: \"A coding may be marked as a \"userSelected\" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).", "base": { "max": "1", "min": 0, "path": "Medication.code" }, "isSummary": true }, { "path": "Medication.code.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.code.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.code.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.code.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "isModifier": false, "short": "Code of the medication (GTIN)", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "slicing": { "rules": "open", "discriminator": [ { "path": "system", "type": "value" } ] }, "type": [ { "code": "Coding" } ], "max": "*", "id": "Medication.code.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "isModifier": false, "short": "Code defined by a terminology system", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "sliceName": "GTIN", "max": "*", "id": "Medication.code.coding:GTIN", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "path": "Medication.code.coding.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.code.coding:GTIN.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.code.coding.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.code.coding:GTIN.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "isModifier": false, "short": "Global Trade Item Number (GS1)", "fixedUri": "urn:oid:2.51.1.1", "mapping": [ { "map": "C*E.3", "identity": "v2" }, { "map": "./codeSystem", "identity": "rim" }, { "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem", "identity": "orim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "Medication.code.coding:GTIN.system", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "base": { "max": "1", "min": 0, "path": "Coding.system" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding.version", "min": 0, "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "isModifier": false, "short": "Version of the system - if relevant", "mapping": [ { "map": "C*E.7", "identity": "v2" }, { "map": "./codeSystemVersion", "identity": "rim" }, { "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion", "identity": "orim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Medication.code.coding:GTIN.version", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "base": { "max": "1", "min": 0, "path": "Coding.version" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "min": 1, "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "isModifier": false, "short": "Symbol in syntax defined by the system", "mapping": [ { "map": "C*E.1", "identity": "v2" }, { "map": "./code", "identity": "rim" }, { "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code", "identity": "orim" } ], "type": [ { "code": "code" } ], "max": "1", "id": "Medication.code.coding:GTIN.code", "base": { "max": "1", "min": 0, "path": "Coding.code" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "isModifier": false, "short": "Representation defined by the system", "mapping": [ { "map": "C*E.2 - but note this is not well followed", "identity": "v2" }, { "map": "CV.displayName", "identity": "rim" }, { "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "Medication.code.coding:GTIN.display", "base": { "max": "1", "min": 0, "path": "Coding.display" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "isModifier": false, "short": "If this coding was chosen directly by the user", "mapping": [ { "map": "Sometimes implied by being first", "identity": "v2" }, { "map": "CD.codingRationale", "identity": "rim" }, { "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]", "identity": "orim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Medication.code.coding:GTIN.userSelected", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 1, "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "isModifier": false, "short": "Medication name", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "Medication.code.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.status", "min": 0, "definition": "A code to indicate if the medication is in active use.", "isModifier": true, "short": "active | inactive | entered-in-error", "mapping": [ { "map": ".statusCode", "identity": "rim" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medication-status|4.0.1", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationStatus" } ], "description": "A coded concept defining if the medication is in active use." }, "max": "1", "id": "Medication.status", "comment": "This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product \"ABC Hospital Special Cream\" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to \"entered in error\". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.", "base": { "max": "1", "min": 0, "path": "Medication.status" }, "isModifierReason": "This element changes the interpretation of all descriptive attributes.", "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.manufacturer", "min": 0, "definition": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.", "isModifier": false, "short": "Manufacturer of the item", "mapping": [ { "map": "no mapping", "identity": "script10.6" }, { "map": "FiveWs.actor", "identity": "w5" }, { "map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name", "identity": "v2" }, { "map": ".player.scopingRole[typeCode=MANU].scoper", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "max": "1", "id": "Medication.manufacturer", "base": { "max": "1", "min": 0, "path": "Medication.manufacturer" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form", "min": 0, "definition": "Describes the form of the item. Powder; tablets; capsule.", "isModifier": false, "short": "Galenic form", "mapping": [ { "map": "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode", "identity": "script10.6" }, { "map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form", "identity": "v2" }, { "map": ".formCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "http://fhir.ch/ig/ch-emed/ValueSet/edqm-pharmaceuticaldoseform" }, "max": "1", "id": "Medication.form", "comment": "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.", "base": { "max": "1", "min": 0, "path": "Medication.form" }, "isSummary": false }, { "path": "Medication.form.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.form.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.form.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.form.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 1, "definition": "A reference to a code defined by a terminology system.", "isModifier": false, "short": "Code defined by a terminology system", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "mustSupport": true, "max": "*", "id": "Medication.form.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "path": "Medication.form.coding.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.form.coding.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.form.coding.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.form.coding.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "isModifier": false, "short": "Identity of the terminology system", "mapping": [ { "map": "C*E.3", "identity": "v2" }, { "map": "./codeSystem", "identity": "rim" }, { "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem", "identity": "orim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "Medication.form.coding.system", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "base": { "max": "1", "min": 0, "path": "Coding.system" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.coding.version", "min": 0, "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "isModifier": false, "short": "Version of the system - if relevant", "mapping": [ { "map": "C*E.7", "identity": "v2" }, { "map": "./codeSystemVersion", "identity": "rim" }, { "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion", "identity": "orim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Medication.form.coding.version", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "base": { "max": "1", "min": 0, "path": "Coding.version" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.coding.code", "requirements": "Need to refer to a particular code in the system.", "min": 1, "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "isModifier": false, "short": "Symbol in syntax defined by the system", "mapping": [ { "map": "C*E.1", "identity": "v2" }, { "map": "./code", "identity": "rim" }, { "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code", "identity": "orim" } ], "type": [ { "code": "code" } ], "max": "1", "id": "Medication.form.coding.code", "base": { "max": "1", "min": 0, "path": "Coding.code" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "isModifier": false, "short": "Representation defined by the system", "mapping": [ { "map": "C*E.2 - but note this is not well followed", "identity": "v2" }, { "map": "CV.displayName", "identity": "rim" }, { "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "Medication.form.coding.display", "base": { "max": "1", "min": 0, "path": "Coding.display" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "isModifier": false, "short": "If this coding was chosen directly by the user", "mapping": [ { "map": "Sometimes implied by being first", "identity": "v2" }, { "map": "CD.codingRationale", "identity": "rim" }, { "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]", "identity": "orim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Medication.form.coding.userSelected", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.form.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "isModifier": false, "short": "Plain text representation of the concept", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "Medication.form.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "rat-1", "human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present", "source": "http://hl7.org/fhir/StructureDefinition/Ratio", "severity": "error", "expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())" } ], "path": "Medication.amount", "min": 0, "definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.", "isModifier": false, "short": "Package size", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "v2" }, { "map": "RTO", "identity": "rim" } ], "type": [ { "code": "Ratio", "profile": [ "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ratio" ] } ], "max": "1", "id": "Medication.amount", "condition": [ "ele-1" ], "comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.", "base": { "max": "1", "min": 0, "path": "Medication.amount" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.ingredient", "min": 0, "definition": "Identifies a particular constituent of interest in the product.", "isModifier": false, "short": "Active or inactive ingredient", "mapping": [ { "map": ".scopesRole[typeCode=INGR]", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "*", "id": "Medication.ingredient", "comment": "The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.", "base": { "max": "*", "min": 0, "path": "Medication.ingredient" }, "isSummary": false }, { "path": "Medication.ingredient.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.ingredient.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.ingredient.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.ingredient.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.ingredient.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "isModifier": true, "short": "Extensions that cannot be ignored even if unrecognized", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Medication.ingredient.modifierExtension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.ingredient.item[x]", "requirements": "The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).", "min": 1, "definition": "The actual ingredient - either a substance (simple ingredient) or another medication of a medication.", "isModifier": false, "short": "The actual ingredient or content", "mapping": [ { "map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription", "identity": "script10.6" }, { "map": "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code", "identity": "v2" }, { "map": ".player", "identity": "rim" } ], "slicing": { "rules": "closed", "ordered": false, "discriminator": [ { "path": "$this", "type": "type" } ] }, "type": [ { "code": "CodeableConcept" } ], "max": "1", "id": "Medication.ingredient.item[x]", "base": { "max": "1", "min": 1, "path": "Medication.ingredient.item[x]" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.ingredient.item[x]", "requirements": "The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).", "min": 1, "definition": "The actual ingredient - either a substance (simple ingredient) or another medication of a medication.", "isModifier": false, "short": "The actual ingredient or content", "mapping": [ { "map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription", "identity": "script10.6" }, { "map": "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code", "identity": "v2" }, { "map": ".player", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "sliceName": "itemCodeableConcept", "max": "1", "id": "Medication.ingredient.item[x]:itemCodeableConcept", "base": { "max": "1", "min": 1, "path": "Medication.ingredient.item[x]" }, "isSummary": false }, { "path": "Medication.ingredient.item[x].id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.ingredient.item[x]:itemCodeableConcept.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.ingredient.item[x].extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.ingredient.item[x]:itemCodeableConcept.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.ingredient.item[x].coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "isModifier": false, "short": "Ingredients coded with SNOMED CT", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "binding": { "strength": "extensible", "valueSet": "http://fhir.ch/ig/ch-emed/ValueSet/ActivePharmaceuticalIngredient" }, "max": "*", "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.ingredient.item[x].text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 1, "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "isModifier": false, "short": "Ingredient name", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "Medication.ingredient.item[x]:itemCodeableConcept.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.ingredient.isActive", "requirements": "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).", "min": 0, "definition": "Indication of whether this ingredient affects the therapeutic action of the drug.", "isModifier": false, "short": "Active ingredient indicator", "mapping": [ { "map": "NA", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Medication.ingredient.isActive", "base": { "max": "1", "min": 0, "path": "Medication.ingredient.isActive" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "rat-1", "human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present", "source": "http://hl7.org/fhir/StructureDefinition/Ratio", "severity": "error", "expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())" } ], "path": "Medication.ingredient.strength", "min": 0, "definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.", "isModifier": false, "short": "Dose per unit", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "v2" }, { "map": "RTO", "identity": "rim" } ], "type": [ { "code": "Ratio", "profile": [ "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ratio" ] } ], "mustSupport": true, "max": "1", "id": "Medication.ingredient.strength", "condition": [ "ele-1" ], "comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.", "base": { "max": "1", "min": 0, "path": "Medication.ingredient.strength" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.batch", "min": 0, "definition": "Information that only applies to packages (not products).", "isModifier": false, "short": "Details about packaged medications", "mapping": [ { "map": "no mapping", "identity": "script10.6" }, { "map": ".player[classCode=CONT]", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "1", "id": "Medication.batch", "base": { "max": "1", "min": 0, "path": "Medication.batch" }, "isSummary": false }, { "path": "Medication.batch.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Medication.batch.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.batch.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Medication.batch.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Medication.batch.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "isModifier": true, "short": "Extensions that cannot be ignored even if unrecognized", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Medication.batch.modifierExtension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.batch.lotNumber", "min": 0, "definition": "The assigned lot number of a batch of the specified product.", "isModifier": false, "short": "Identifier assigned to batch", "mapping": [ { "map": "no mapping", "identity": "script10.6" }, { "map": "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number", "identity": "v2" }, { "map": ".id", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Medication.batch.lotNumber", "base": { "max": "1", "min": 0, "path": "Medication.batch.lotNumber" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Medication.batch.expirationDate", "min": 0, "definition": "When this specific batch of product will expire.", "isModifier": false, "short": "When batch will expire", "mapping": [ { "map": "no mapping", "identity": "script10.6" }, { "map": "RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date", "identity": "v2" }, { "map": "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime", "identity": "rim" } ], "type": [ { "code": "dateTime" } ], "max": "1", "id": "Medication.batch.expirationDate", "base": { "max": "1", "min": 0, "path": "Medication.batch.expirationDate" }, "isSummary": false } ] }, "status": "active", "id": "38bfa8d6-89df-443c-842b-1b45deb81b3f", "kind": "resource", "url": "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medication", "version": "3.0.0", "differential": { "element": [ { "id": "Medication", "path": "Medication", "short": "CH EMED Medication", "constraint": [ { "key": "ch-emed-med-1", "human": "Medication or ingredient name has to be specified", "severity": "error", "expression": "code.text.exists() or ingredient.itemCodeableConcept.text.exists()" } ] }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "short": "Code of the medication (GTIN)", "slicing": { "rules": "open", "discriminator": [ { "path": "system", "type": "value" } ] } }, { "id": "Medication.code.coding:GTIN", "path": "Medication.code.coding", "sliceName": "GTIN" }, { "id": "Medication.code.coding:GTIN.system", "max": "1", "min": 1, "path": "Medication.code.coding.system", "short": "Global Trade Item Number (GS1)", "fixedUri": "urn:oid:2.51.1.1" }, { "id": "Medication.code.coding:GTIN.code", "max": "1", "min": 1, "path": "Medication.code.coding.code" }, { "id": "Medication.code.coding:GTIN.display", "max": "1", "min": 1, "path": "Medication.code.coding.display" }, { "id": "Medication.code.text", "min": 1, "path": "Medication.code.text", "short": "Medication name", "mustSupport": true }, { "id": "Medication.form", "path": "Medication.form", "short": "Galenic form", "binding": { "strength": "required", "valueSet": "http://fhir.ch/ig/ch-emed/ValueSet/edqm-pharmaceuticaldoseform" } }, { "id": "Medication.form.coding", "min": 1, "path": "Medication.form.coding", "mustSupport": true }, { "id": "Medication.form.coding.system", "min": 1, "path": "Medication.form.coding.system" }, { "id": "Medication.form.coding.code", "min": 1, "path": "Medication.form.coding.code" }, { "id": "Medication.form.coding.display", "min": 1, "path": "Medication.form.coding.display" }, { "id": "Medication.amount", "path": "Medication.amount", "type": [ { "code": "Ratio", "profile": [ "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ratio" ] } ], "short": "Package size" }, { "id": "Medication.ingredient", "path": "Medication.ingredient" }, { "id": "Medication.ingredient.itemCodeableConcept", "path": "Medication.ingredient.itemCodeableConcept" }, { "id": "Medication.ingredient.itemCodeableConcept.coding", "path": "Medication.ingredient.itemCodeableConcept.coding", "short": "Ingredients coded with SNOMED CT", "binding": { "strength": "extensible", "valueSet": "http://fhir.ch/ig/ch-emed/ValueSet/ActivePharmaceuticalIngredient" } }, { "id": "Medication.ingredient.itemCodeableConcept.text", "min": 1, "path": "Medication.ingredient.itemCodeableConcept.text", "short": "Ingredient name", "mustSupport": true }, { "id": "Medication.ingredient.strength", "path": "Medication.ingredient.strength", "type": [ { "code": "Ratio", "profile": [ "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ratio" ] } ], "short": "Dose per unit", "mustSupport": true } ] }, "contact": [ { "name": "HL7 Switzerland", "telecom": [ { "value": "https://www.hl7.ch/", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication" }