{ "description": "This resource is part of Infusion as defined by the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) version 3.2, release 2017.\\r\\n\\r\\nThe administering system contains the entire system making the fluid run from the infusion bag via the cannula/catheter to the patient. This also includes any three-way valves/connecting joints used.", "_filename": "zib-Infusion-AdministeringSystem.json", "package_name": "nictiz.fhir.nl.stu3.zib2017", "date": null, "derivation": "constraint", "publisher": "Nictiz", "fhirVersion": "3.0.2", "purpose": "The purpose of an infusion is usually to administer fluid and/or medication. \r\nInformation on present infusions is recorded to inform other health professionals. This information is of importance in determining the care required for the patient and in safely administering medication. In a transfer situation, the information offers the option to realize continuity of care by organizing specific expertise and materials in advance, for example.", "name": "Zib Infusion AdministeringSystem", "mapping": [ { "uri": "https://zibs.nl/wiki/Infusion-v3.2(2017EN)", "name": "HCIM Infusion-v3.2(2017EN)", "identity": "hcim-infusion-v3.2-2017EN" } ], "abstract": false, "copyright": "CC0", "type": "MedicationAdministration", "experimental": null, "resourceType": "StructureDefinition", "title": "HCIM Infusion AdministeringSystem", "package_version": "2.3.1", "snapshot": { "element": [ { "constraint": [ { "key": "dom-2", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource", "severity": "error", "expression": "contained.contained.empty()" }, { "key": "dom-1", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource", "severity": "error", "expression": "contained.text.empty()" }, { "key": "dom-4", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource", "severity": "error", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" }, { "key": "dom-3", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource", "severity": "error", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()" }, { "key": "mad-2", "human": "Reason not given is only permitted if NotGiven is true", "xpath": "not(exists(f:reasonNotGiven) and f:notGiven/@value=false())", "severity": "error", "expression": "reasonNotGiven.empty() or notGiven = true" }, { "key": "mad-3", "human": "Reason given is only permitted if NotGiven is false", "xpath": "not(exists(f:reasonCode) and f:notGiven/@value=true())", "severity": "error", "expression": "reasonCode.empty() or notGiven.empty() or notGiven = 'false'" } ], "path": "MedicationAdministration", "min": 0, "definition": "Medication administration is the registration of the individual administrations of the medicine on the patient by the administrator (e.g. a nurse or patient themselves), in relation to the entered agreements.", "short": "MedicationAdministration", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "..Event", "identity": "workflow" }, { "map": "SubstanceAdministration", "identity": "rim" }, { "map": "clinical.medication", "identity": "w5" }, { "map": "NL-CM:9.13.20928", "comment": "MedicationAdministration", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" }, { "map": "NL-CM:16.1.3", "comment": "MedicationAdministration", "identity": "hcim-plannedcareactivityfortransfer-v1.2.1-2015EN" }, { "map": "NL-CM:16.1.3", "comment": "MedicationAdministration", "identity": "hcim-plannedcareactivityfortransfer-v3.0-2016EN" }, { "map": "NL-CM:16.1.3", "comment": "MedicationAdministration", "identity": "hcim-plannedcareactivityfortransfer-v3.1-2017EN" }, { "map": "NL-CM:10.2.2", "comment": "InfusionFluid", "identity": "hcim-infusion-v3.2-2017EN" } ], "alias": [ "MedicatieToediening" ], "max": "*", "id": "MedicationAdministration", "comment": "The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html).", "base": { "max": "*", "min": 0, "path": "Resource" } }, { "path": "MedicationAdministration.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "short": "Logical id of this artifact", "type": [ { "code": "id" } ], "max": "1", "id": "MedicationAdministration.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 }, { "path": "MedicationAdministration.meta", "min": 0, "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "max": "1", "id": "MedicationAdministration.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "path": "MedicationAdministration.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.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "max": "1", "id": "MedicationAdministration.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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "isSummary": true }, { "path": "MedicationAdministration.language", "min": 0, "definition": "The base language in which the resource is written.", "short": "Language of the resource content", "type": [ { "code": "code" } ], "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "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.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "max": "1", "id": "MedicationAdministration.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" } }, { "path": "MedicationAdministration.text", "min": 0, "definition": "A human-readable narrative that contains a summary of the resource, and may 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.", "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": "MedicationAdministration.text", "condition": [ "dom-1" ], "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 in formation is added later.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" } }, { "path": "MedicationAdministration.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.", "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "MedicationAdministration.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.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" } }, { "path": "MedicationAdministration.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "N/A", "identity": "rim" } ], "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "MedicationAdministration.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" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.extension", "min": 0, "definition": "Date and time in the medication or administration agreement to which this administration pertains. Since multiple times can be indicated in one medication/administration agreement, this can be used to identify the agreed time in the event of e.g. early administration or a late administration.", "short": "AgreedDateTime", "mapping": [ { "map": "N/A", "identity": "rim" }, { "map": "n/a", "identity": "rim" }, { "map": "NL-CM:9.13.23171", "comment": "AgreedDateTime", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime" } ], "sliceName": "agreedDateTime", "alias": [ "extensions", "user content", "AfgesprokenDatumTijd" ], "max": "*", "id": "MedicationAdministration.extension:agreedDateTime", "condition": [ "ele-1" ], "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" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.extension", "min": 0, "definition": "Was a double check performed prior to the administration? This is only legally required for certain medication.", "short": "DoubleCheckPerformed", "mapping": [ { "map": "N/A", "identity": "rim" }, { "map": "n/a", "identity": "rim" }, { "map": "NL-CM:9.13.23168", "comment": "DoubleCheckPerformed", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed" } ], "sliceName": "doubleCheckPerformed", "alias": [ "extensions", "user content", "DubbeleControleUitgevoerd" ], "max": "1", "id": "MedicationAdministration.extension:doubleCheckPerformed", "condition": [ "ele-1" ], "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" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.extension", "min": 0, "definition": "This extension is to describe which overarching medication treatment this information is part of. This is done by the use of an identifier of that medication treatment.", "short": "Medicational Treatment", "mapping": [ { "map": "N/A", "identity": "rim" }, { "map": "n/a", "identity": "rim" }, { "map": "mp-dataelement900-22092", "comment": "Medicamenteuze behandeling", "identity": "Medication-Process-v09" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment" } ], "sliceName": "medicationTreatment", "alias": [ "extensions", "user content", "Medicamenteuze behandeling" ], "max": "1", "id": "MedicationAdministration.extension:medicationTreatment", "condition": [ "ele-1" ], "comment": "No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided.", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.extension", "min": 0, "definition": "Optional Extension Element - found in all resources.", "short": "Optional Extensions Element", "mapping": [ { "map": "N/A", "identity": "rim" }, { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration" } ], "sliceName": "deviatingAdministration", "alias": [ "extensions", "user content" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration", "condition": [ "ele-1" ], "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" } }, { "path": "MedicationAdministration.extension.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.extension.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "MedicationAdministration.extension:deviatingAdministration.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" } }, { "path": "MedicationAdministration.extension.extension", "min": 0, "definition": "In the administration, was there a deviation from the medication or administration agreement? This can be a deviation in product, time, amount, route of administration or administering speed or foregoing administration altogether", "short": "DeviatingAdministration", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "NL-CM:9.13.23167", "comment": "DeviatingAdministration", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Extension" } ], "sliceName": "deviation", "alias": [ "extensions", "user content", "AfwijkendeToediening" ], "max": "*", "id": "MedicationAdministration.extension:deviatingAdministration.extension:deviation", "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" } }, { "path": "MedicationAdministration.extension.extension.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.extension:deviation.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.extension.extension.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "0", "id": "MedicationAdministration.extension:deviatingAdministration.extension:deviation.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" } }, { "path": "MedicationAdministration.extension.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "deviation", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "uri" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.extension:deviation.url", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "path": "MedicationAdministration.extension.extension.valueBoolean", "min": 0, "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "short": "Value of extension", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "sliceName": "valueBoolean", "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.extension:deviation.value[x]:valueBoolean", "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "path": "MedicationAdministration.extension.extension", "min": 0, "definition": "Reason why the medication was not taken or administered or was taken or administered differently. Here, you can choose to enter text or one of the codes.", "short": "MedicationAdministrationReasonForDeviation", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "NL-CM:9.13.23166", "comment": "MedicationAdministrationReasonForDeviation", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Extension" } ], "sliceName": "reasonForDeviation", "binding": { "strength": "extensible", "valueSetReference": { "display": "MedicatieToedieningRedenVanAfwijkenCodelijst", "reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.3--20171231000000" } }, "alias": [ "extensions", "user content", "MedicatieToedieningRedenVanAfwijken" ], "max": "*", "id": "MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation", "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" } }, { "path": "MedicationAdministration.extension.extension.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.extension.extension.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "0", "id": "MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation.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" } }, { "path": "MedicationAdministration.extension.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "reasonForDeviation", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "uri" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation.url", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "path": "MedicationAdministration.extension.extension.valueCodeableConcept", "min": 0, "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "short": "Value of extension", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "sliceName": "valueCodeableConcept", "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation.value[x]:valueCodeableConcept", "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "path": "MedicationAdministration.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "uri" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.extension:deviatingAdministration.url", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "path": "MedicationAdministration.extension.value[x]", "min": 0, "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "short": "Value of extension", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Meta" } ], "max": "0", "id": "MedicationAdministration.extension:deviatingAdministration.value[x]", "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "path": "MedicationAdministration.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. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "MedicationAdministration.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" } }, { "path": "MedicationAdministration.identifier", "min": 0, "definition": "External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.", "short": "External identifier", "mapping": [ { "map": "…identifier", "identity": "workflow" }, { "map": ".id", "identity": "rim" }, { "map": "id", "identity": "w5" }, { "map": "NL-CM:0.0.6", "comment": "IdentificationNumber", "identity": "hcim-basicelements-v1.0-2017EN" } ], "type": [ { "code": "Identifier" } ], "max": "*", "id": "MedicationAdministration.identifier", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.identifier" } }, { "path": "MedicationAdministration.definition", "min": 0, "definition": "A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.", "short": "Instantiates protocol or definition", "mapping": [ { "map": "…definition", "identity": "workflow" }, { "map": ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" } ], "max": "*", "id": "MedicationAdministration.definition", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.definition" }, "isSummary": true }, { "path": "MedicationAdministration.partOf", "min": 0, "definition": "A larger event of which this particular event is a component or step.", "short": "Part of referenced event", "mapping": [ { "map": "…part of", "identity": "workflow" }, { "map": ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" } ], "max": "*", "id": "MedicationAdministration.partOf", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.partOf" }, "isSummary": true }, { "path": "MedicationAdministration.status", "min": 1, "definition": "The status of the administration, as a description of the stage within the administering process. Only the status codes ‘completed’ and ‘cancelled’ apply to indivisible products (such as tablets or suppositories). For divisible products (such as infusions), doses can also be ‘suspended’ or ‘aborted’. \r\n\r\nWhen documenting this, the following interpretations are used: \r\nActive: The product is administered.\r\nInterrupted: Use has (temporarily) been interrupted, because of a side effect, for example. Later, the patient and/or doctor can decide whether or not to resume or discontinue use.\r\nDiscontinued: Administration has stopped.\r\nCompleted: Administration has been completed.\r\n\r\nNot started: The product was never administered.", "isModifier": true, "short": "MedicationAdministrationStatus", "mapping": [ { "map": "…status", "identity": "workflow" }, { "map": "RXA-20-Completion Status", "identity": "v2" }, { "map": ".statusCode", "identity": "rim" }, { "map": "status", "identity": "w5" }, { "map": "NL-CM:9.13.21191", "comment": "MedicationAdministrationStatus", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationStatus" } ], "description": "A set of codes indicating the current status of a MedicationAdministration.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-admin-status" } }, "alias": [ "MedicatieToedieningStatus" ], "max": "1", "id": "MedicationAdministration.status", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "base": { "max": "1", "min": 1, "path": "MedicationAdministration.status" }, "isSummary": true }, { "path": "MedicationAdministration.status.id", "min": 0, "definition": "unique id for the element within a resource (for internal references)", "short": "xml:id (or equivalent in JSON)", "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.status.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.status.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "short": "Additional Content defined by implementations", "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "MedicationAdministration.status.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" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/code-specification", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.status.extension", "min": 0, "definition": "The status of the order / recommendation.", "short": "OrderStatus", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" }, { "map": "NL-CM:16.1.9", "comment": "OrderStatus", "identity": "hcim-plannedcareactivityfortransfer-v1.2.1-2015EN" }, { "map": "NL-CM:16.1.9", "comment": "OrderStatus", "identity": "hcim-plannedcareactivityfortransfer-v3.0-2016EN" }, { "map": "NL-CM:16.1.9", "comment": "OrderStatus", "identity": "hcim-plannedcareactivityfortransfer-v3.1-2017EN" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/code-specification" } ], "sliceName": "orderStatus", "alias": [ "extensions", "user content", "Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet.", "OrderStatus" ], "max": "1", "id": "MedicationAdministration.status.extension:orderStatus", "condition": [ "ele-1" ], "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" } }, { "path": "MedicationAdministration.status.value", "min": 0, "definition": "Primitive value for code", "short": "Primitive value for code", "type": [ { "_code": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type", "valueString": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type", "valueString": "xsd:token" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type", "valueString": "xsd:token" } ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[^\\s]+([\\s]?[^\\s]+)*" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.status.value", "base": { "max": "1", "min": 0, "path": "string.value" } }, { "path": "MedicationAdministration.category", "min": 1, "definition": "Indicates the type of medication administration and where the medication is expected to be consumed or administered.", "short": "Type of medication usage", "mapping": [ { "map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationCategory" } ], "description": "A coded concept describing where the medication administered is expected to occur", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/medication-admin-category" } }, "max": "1", "id": "MedicationAdministration.category", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.category" } }, { "path": "MedicationAdministration.category.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.category.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.category.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "MedicationAdministration.category.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" } }, { "path": "MedicationAdministration.category.coding", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "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" } ], "slicing": { "rules": "open", "discriminator": [ { "path": "code", "type": "value" } ] }, "type": [ { "code": "Coding" } ], "max": "*", "id": "MedicationAdministration.category.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": "MedicationAdministration.category.coding", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "definition": "Category SNOMED code used for indexing/retrieval of the HCIM MedicationAdministration. The SNOMED code 18629005 for this resource is stated in the Medication Process v09.", "short": "MedicationAdministrationCode", "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": "MedicationAdministrationCode", "max": "*", "id": "MedicationAdministration.category.coding:MedicationAdministrationCode", "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": "MedicationAdministration.category.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.category.coding:MedicationAdministrationCode.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.category.coding.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "MedicationAdministration.category.coding:MedicationAdministrationCode.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" } }, { "path": "MedicationAdministration.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "short": "Identity of the terminology system", "fixedUri": "http://snomed.info/sct", "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": "MedicationAdministration.category.coding:MedicationAdministrationCode.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 de-reference to some definition that establish the system clearly and unambiguously.", "base": { "max": "1", "min": 0, "path": "Coding.system" }, "isSummary": true }, { "path": "MedicationAdministration.category.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.", "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": "MedicationAdministration.category.coding:MedicationAdministrationCode.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 }, { "path": "MedicationAdministration.category.coding.code", "fixedCode": "18629005", "requirements": "Need to refer to a particular code in the system.", "min": 0, "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).", "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": "MedicationAdministration.category.coding:MedicationAdministrationCode.code", "base": { "max": "1", "min": 0, "path": "Coding.code" }, "isSummary": true }, { "path": "MedicationAdministration.category.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": 0, "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "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": "MedicationAdministration.category.coding:MedicationAdministrationCode.display", "defaultValueString": "Administration of drug or medicament (procedure)", "base": { "max": "1", "min": 0, "path": "Coding.display" }, "isSummary": true }, { "path": "MedicationAdministration.category.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 - i.e. off a pick list of available items (codes or displays).", "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": "MedicationAdministration.category.coding:MedicationAdministrationCode.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 }, { "path": "MedicationAdministration.category.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.", "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": "MedicationAdministration.category.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 }, { "path": "MedicationAdministration.medicationReference", "min": 1, "definition": "The product taken or administered. This is usually medication. Food, blood products, aids and bandages do not strictly fall under the category of medication, but can be reported as well. \r\n\r\nIn principle, this will be the prescribed product, but the administrator may substitute it by replacing the product with an equivalent product. For example: two 50mg tablets can be administered instead of one 100mg tablet.", "short": "AdministrationProduct", "mapping": [ { "map": "…code", "identity": "workflow" }, { "map": "RXA-5-Administered Code", "identity": "v2" }, { "map": ".participation[typeCode=CSM].role[classCode=ADMM]", "identity": "rim" }, { "map": "what", "identity": "w5" }, { "map": "NL-CM:9.13.20929", "comment": "AdministrationProduct", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-Product" } ], "sliceName": "medicationReference", "alias": [ "Product", "Geneesmiddel", "Toedieningsproduct" ], "max": "1", "id": "MedicationAdministration.medication[x]:medicationReference", "comment": "-", "base": { "max": "1", "min": 1, "path": "MedicationAdministration.medication[x]" }, "isSummary": true }, { "path": "MedicationAdministration.subject", "min": 1, "definition": "The person or animal or group receiving the medication.", "short": "Who received medication", "mapping": [ { "map": "…subject", "identity": "workflow" }, { "map": "PID-3-Patient ID List", "identity": "v2" }, { "map": ".participation[typeCode=SBJ].role[classCode=PAT]", "identity": "rim" }, { "map": "who.focus", "identity": "w5" }, { "map": "NL-CM:0.0.11", "comment": "Subject", "identity": "hcim-basicelements-v1.0-2017EN" } ], "type": [ { "code": "Reference", "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "max": "1", "id": "MedicationAdministration.subject", "base": { "max": "1", "min": 1, "path": "MedicationAdministration.subject" }, "isSummary": true }, { "path": "MedicationAdministration.context", "min": 0, "definition": "The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.", "short": "Encounter or Episode of Care administered as part of", "mapping": [ { "map": "…context", "identity": "workflow" }, { "map": "PV1-19-Visit Number", "identity": "v2" }, { "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]", "identity": "rim" }, { "map": "context", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "max": "1", "id": "MedicationAdministration.context", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.context" } }, { "path": "MedicationAdministration.supportingInformation", "min": 0, "definition": "Medication or administration agreement on which this administration.is based.", "short": "RelatedAgreement / MedicationAgreement / AdministrationAgreement", "mapping": [ { "map": ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]", "identity": "rim" }, { "map": "context", "identity": "w5" }, { "map": "NL-CM:9.13.23169", "comment": "RelatedAgreement", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" }, { "map": "NL-CM:9.13.23170", "comment": "MedicationAgreement", "identity": "hcim-MedicationAdministration2-v1.0-2017EN" }, { "map": "NL-CM:9.13.23237", "comment": "AdministrationAgreement", "identity": "hcim-MedicationAdministration2-v1.0-2017EN" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" }, { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-Dispense" }, { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-Product" }, { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-DispenseRequest" }, { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement" }, { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement" }, { "code": "Reference", "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration" } ], "alias": [ "GerelateerdeAfspraak", "Medicatieafspraak", "Toedieningsafspraak" ], "max": "*", "id": "MedicationAdministration.supportingInformation", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.supportingInformation" } }, { "path": "MedicationAdministration.effective[x]", "min": 1, "definition": "The date and time at which the medication was administered.", "short": "AdministrationDateTime", "mapping": [ { "map": "…occurrence[x]", "identity": "workflow" }, { "map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration", "identity": "v2" }, { "map": ".effectiveTime", "identity": "rim" }, { "map": "when.done", "identity": "w5" }, { "map": "NL-CM:9.13.21193", "comment": "AdministrationDateTime", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" }, { "map": "NL-CM:16.1.10", "comment": "StartDate", "identity": "hcim-plannedcareactivityfortransfer-v1.2.1-2015EN" }, { "map": "NL-CM:16.1.10", "comment": "StartDate", "identity": "hcim-plannedcareactivityfortransfer-v3.0-2016EN" }, { "map": "NL-CM:16.1.10", "comment": "StartDate", "identity": "hcim-plannedcareactivityfortransfer-v3.1-2017EN" }, { "map": "NL-CM:16.1.11", "comment": "EndDate", "identity": "hcim-plannedcareactivityfortransfer-v1.2.1-2015EN" }, { "map": "NL-CM:16.1.11", "comment": "EndDate", "identity": "hcim-plannedcareactivityfortransfer-v3.0-2016EN" }, { "map": "NL-CM:16.1.11", "comment": "EndDate", "identity": "hcim-plannedcareactivityfortransfer-v3.1-2017EN" }, { "map": "NL-CM:0.0.14", "comment": "DateTime", "identity": "hcim-basicelements-v1.0-2017EN" } ], "type": [ { "code": "dateTime" }, { "code": "Period" } ], "alias": [ "ToedieningsDatumTijd" ], "max": "1", "id": "MedicationAdministration.effective[x]", "base": { "max": "1", "min": 1, "path": "MedicationAdministration.effective[x]" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" } ], "path": "MedicationAdministration.performer", "min": 0, "definition": "Container of the Administrator concept. This container contains all data elements of the Administrator concept. The concept describes the person who administered the product. This is a professional authorised administrator, the patient themselves or the caregiver, for example.", "short": "Administrator", "mapping": [ { "map": "…performer", "identity": "workflow" }, { "map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)", "identity": "v2" }, { "map": ".participation[typeCode=PRF]", "identity": "rim" }, { "map": "who.actor", "identity": "w5" }, { "map": "NL-CM:9.13.21196", "comment": "Administrator", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" }, { "map": "NL-CM:0.0.7", "comment": "Author", "identity": "hcim-basicelements-v1.0-2017EN" } ], "type": [ { "code": "BackboneElement" } ], "alias": [ "Toediener" ], "max": "*", "id": "MedicationAdministration.performer", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.performer" }, "isSummary": true }, { "path": "MedicationAdministration.performer.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.performer.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.performer.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "MedicationAdministration.performer.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" } }, { "path": "MedicationAdministration.performer.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "MedicationAdministration.performer.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" }, "isSummary": true }, { "path": "MedicationAdministration.performer.actor", "min": 1, "definition": "The device, practitioner, etc. who performed the action.", "short": "Individual who was performing", "mapping": [ { "map": "….actor", "identity": "workflow" }, { "map": ".role", "identity": "rim" }, { "map": "NL-CM:9.13.23380", "comment": "Patient", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" }, { "map": "NL-CM:9.13.23172", "comment": "HealthProfessional", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" }, { "map": "NL-CM:9.13.23355", "comment": "Caregiver", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Reference", "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner" }, { "code": "Reference", "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-patient" }, { "code": "Reference", "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "max": "1", "id": "MedicationAdministration.performer.actor", "comment": "The health professional's specialty, role, and organization are captured and communicated through the PractitionerRole Resource based on the nl-core-practitionerrole profile.", "base": { "max": "1", "min": 1, "path": "MedicationAdministration.performer.actor" }, "isSummary": true }, { "path": "MedicationAdministration.performer.actor.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.performer.actor.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.performer.actor.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "MedicationAdministration.performer.actor.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" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.performer.actor.extension", "min": 0, "definition": "Optional Extension Element - found in all resources.", "short": "Optional Extensions Element", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference" } ], "sliceName": "practitionerRole", "alias": [ "extensions", "user content" ], "max": "1", "id": "MedicationAdministration.performer.actor.extension:practitionerRole", "condition": [ "ele-1" ], "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" } }, { "path": "MedicationAdministration.performer.actor.reference", "min": 0, "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "short": "Literal reference, Relative, internal or absolute URL", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "MedicationAdministration.performer.actor.reference", "condition": [ "ref-1" ], "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "base": { "max": "1", "min": 0, "path": "Reference.reference" }, "isSummary": true }, { "path": "MedicationAdministration.performer.actor.identifier", "min": 0, "definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "short": "Logical reference, when literal reference is not known", "mapping": [ { "map": ".identifier", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "max": "1", "id": "MedicationAdministration.performer.actor.identifier", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "base": { "max": "1", "min": 0, "path": "Reference.identifier" }, "isSummary": true }, { "path": "MedicationAdministration.performer.actor.display", "min": 0, "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "short": "Text alternative for the resource", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "MedicationAdministration.performer.actor.display", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "base": { "max": "1", "min": 0, "path": "Reference.display" }, "isSummary": true }, { "path": "MedicationAdministration.performer.onBehalfOf", "min": 0, "definition": "The organization the device or practitioner was acting on behalf of.", "short": "Organization organization was acting for", "mapping": [ { "map": "….onBehalfOf", "identity": "workflow" }, { "map": ".role.scopingOrganization", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-organization" } ], "max": "1", "id": "MedicationAdministration.performer.onBehalfOf", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.performer.onBehalfOf" } }, { "path": "MedicationAdministration.notGiven", "min": 0, "definition": "Set this to true if the record is saying that the medication was NOT administered.", "isModifier": true, "short": "True if medication not administered", "mapping": [ { "map": "…notDone", "identity": "workflow" }, { "map": "RXA-20-Completion Status='NA'", "identity": "v2" }, { "map": ".actionNegationInd", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "meaningWhenMissing": "If this is missing, then the medication was administered", "max": "1", "id": "MedicationAdministration.notGiven", "comment": "This element is labeled as a modifier because it indicates that a administration didn't happen.", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.notGiven" }, "isSummary": true }, { "path": "MedicationAdministration.reasonNotGiven", "min": 0, "definition": "A code indicating why the administration was not performed.", "short": "Reason administration not performed", "mapping": [ { "map": "…notDoneReason", "identity": "workflow" }, { "map": "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationNegationReason" } ], "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" } }, "max": "*", "id": "MedicationAdministration.reasonNotGiven", "condition": [ "mad-2" ], "base": { "max": "*", "min": 0, "path": "MedicationAdministration.reasonNotGiven" } }, { "path": "MedicationAdministration.reasonCode", "min": 0, "definition": "A code indicating why the medication was given.", "short": "Reason administration performed", "mapping": [ { "map": "…reasonGivenCodeableConcept", "identity": "workflow" }, { "map": "RXE-27 Give Indication", "identity": "v2" }, { "map": ".reasonCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationReason" } ], "description": "A set of codes indicating the reason why the MedicationAdministration was made.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" } }, "max": "*", "id": "MedicationAdministration.reasonCode", "condition": [ "mad-3" ], "base": { "max": "*", "min": 0, "path": "MedicationAdministration.reasonCode" } }, { "path": "MedicationAdministration.reasonReference", "min": 0, "definition": "Condition or observation that supports why the medication was administered.", "short": "Condition or Observation that supports why the medication was administered", "mapping": [ { "map": "…reasonReference", "identity": "workflow" }, { "map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value", "identity": "rim" }, { "map": "no mapping", "identity": "w3c.prov" }, { "map": "why", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ], "max": "*", "id": "MedicationAdministration.reasonReference", "comment": "This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.reasonReference" } }, { "path": "MedicationAdministration.prescription", "min": 0, "definition": "The original request, instruction or authority to perform the administration.", "short": "Request administration performed against", "mapping": [ { "map": "…basedOn", "identity": "workflow" }, { "map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number", "identity": "v2" }, { "map": "InFullfillmentOf->SubstanceAdministration", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" } ], "max": "1", "id": "MedicationAdministration.prescription", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.prescription" } }, { "path": "MedicationAdministration.device", "min": 0, "definition": "The device used in administering the medication to the patient. For example, a particular infusion pump.", "short": "Device used to administer", "mapping": [ { "map": "PRT-10 Participation Device / RXR-3 Administrative Device", "identity": "v2" }, { "map": "device->Access OR device->AssignedDevice", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "max": "*", "id": "MedicationAdministration.device", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.device" } }, { "path": "MedicationAdministration.device.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.device.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.device.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "MedicationAdministration.device.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" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "MedicationAdministration.device.extension", "min": 0, "definition": "A description of medical devices required for administering the infusion fluid and placing the catheter, such as a volumetric infusion pump, syringe and infusion bag.", "short": "Peripheral", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" }, { "map": "NL-CM:10.2.6", "comment": "Peripheral", "identity": "hcim-infusion-v3.2-2017EN" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice" } ], "sliceName": "Peripheral", "alias": [ "extensions", "user content", "Randapparaat" ], "max": "*", "id": "MedicationAdministration.device.extension:Peripheral", "condition": [ "ele-1" ], "comment": "Use the direct reference to the Device resource (MedicationAdministration.device.reference) when no meta data regarding the use of the device is available or needed.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "MedicationAdministration.device.reference", "min": 0, "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "short": "Literal reference, Relative, internal or absolute URL", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "MedicationAdministration.device.reference", "condition": [ "ref-1" ], "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "base": { "max": "1", "min": 0, "path": "Reference.reference" }, "isSummary": true }, { "path": "MedicationAdministration.device.identifier", "min": 0, "definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "short": "Logical reference, when literal reference is not known", "mapping": [ { "map": ".identifier", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "max": "1", "id": "MedicationAdministration.device.identifier", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "base": { "max": "1", "min": 0, "path": "Reference.identifier" }, "isSummary": true }, { "path": "MedicationAdministration.device.display", "min": 0, "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "short": "Text alternative for the resource", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "MedicationAdministration.device.display", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "base": { "max": "1", "min": 0, "path": "Reference.display" }, "isSummary": true }, { "path": "MedicationAdministration.note", "min": 0, "definition": "Comments on administering the medication.", "short": "Comment", "mapping": [ { "map": "…note", "identity": "workflow" }, { "map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value", "identity": "rim" }, { "map": "NL-CM:9.13.21337", "comment": "Comment", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Annotation" } ], "alias": [ "Toelichting" ], "max": "*", "id": "MedicationAdministration.note", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.note" } }, { "path": "MedicationAdministration.note.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.note.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.note.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "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": "MedicationAdministration.note.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" } }, { "path": "MedicationAdministration.note.author[x]", "min": 0, "definition": "The individual responsible for making the annotation.", "short": "Individual responsible for the annotation", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Act.participant[typeCode=AUT].role", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "string" } ], "max": "1", "id": "MedicationAdministration.note.author[x]", "base": { "max": "1", "min": 0, "path": "Annotation.author[x]" }, "isSummary": true }, { "path": "MedicationAdministration.note.time", "min": 0, "definition": "Indicates when this particular annotation was made.", "short": "When the annotation was made", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Act.effectiveTime", "identity": "rim" } ], "type": [ { "code": "dateTime" } ], "max": "1", "id": "MedicationAdministration.note.time", "base": { "max": "1", "min": 0, "path": "Annotation.time" }, "isSummary": true }, { "path": "MedicationAdministration.note.text", "min": 1, "definition": "A comment on the administering system.", "short": "AdministeringSystemComment", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Act.text", "identity": "rim" }, { "map": "NL-CM:10.2.12", "comment": "AdministeringSystemComment", "identity": "hcim-infusion-v3.2-2017EN" } ], "type": [ { "code": "string" } ], "alias": [ "ToedieningsSysteemToelichting" ], "max": "1", "id": "MedicationAdministration.note.text", "base": { "max": "1", "min": 1, "path": "Annotation.text" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "mad-1", "human": "SHALL have at least one of dosage.dose or dosage.rate[x]", "xpath": "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])", "severity": "error", "expression": "dose.exists() or rate.exists()" } ], "path": "MedicationAdministration.dosage", "min": 0, "definition": "Describes the medication dosage information details e.g. dose, rate, site, route, etc.", "short": "Details of how medication was taken", "mapping": [ { "map": "component->SubstanceAdministrationEvent", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "1", "id": "MedicationAdministration.dosage", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage" } }, { "path": "MedicationAdministration.dosage.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.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "MedicationAdministration.dosage.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "MedicationAdministration.dosage.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "MedicationAdministration.dosage.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" } }, { "path": "MedicationAdministration.dosage.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "MedicationAdministration.dosage.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" }, "isSummary": true }, { "path": "MedicationAdministration.dosage.text", "min": 0, "definition": "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.", "short": "Free text dosage instructions e.g. SIG", "mapping": [ { "map": ".text", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "MedicationAdministration.dosage.text", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage.text" } }, { "path": "MedicationAdministration.dosage.site", "min": 0, "definition": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".", "short": "Body site administered to", "mapping": [ { "map": "RXR-2 Administration Site / RXR-6 Administration Site Modifier", "identity": "v2" }, { "map": ".approachSiteCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationSite" } ], "description": "A coded concept describing the site location the medicine enters into or onto the body.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/approach-site-codes" } }, "max": "1", "id": "MedicationAdministration.dosage.site", "comment": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage.site" } }, { "path": "MedicationAdministration.dosage.route", "min": 1, "definition": "he route through which the medication is administered (oral, nasal, intravenous,...)", "short": "RouteOfAdministration", "mapping": [ { "map": "RXR-1-Route", "identity": "v2" }, { "map": ".routeCode", "identity": "rim" }, { "map": "NL-CM:9.13.21195", "comment": "RouteOfAdministration", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RouteOfAdministration" } ], "description": "MedicatieToedieningToedieningswegCodelijst", "valueSetReference": { "display": "MedicatieToedieningToedieningswegCodelijst", "reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.2--20171231000000" } }, "alias": [ "Toedieningsweg" ], "max": "1", "id": "MedicationAdministration.dosage.route", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage.route" } }, { "path": "MedicationAdministration.dosage.method", "min": 0, "definition": "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.", "short": "How drug was administered", "mapping": [ { "map": "RXR-4-Administration Method", "identity": "v2" }, { "map": ".methodCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationMethod" } ], "description": "A coded concept describing the technique by which the medicine is administered.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/administration-method-codes" } }, "max": "1", "id": "MedicationAdministration.dosage.method", "comment": "One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage.method" } }, { "path": "MedicationAdministration.dosage.dose", "min": 1, "definition": "Amount of the administered product", "short": "AdministeredAmount", "mapping": [ { "map": "RXA-6 Administered Amount / RXA-7 Administered Units", "identity": "v2" }, { "map": ".doseQuantity", "identity": "rim" }, { "map": "NL-CM:9.13.21194", "comment": "AdministeredAmount", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "binding": { "strength": "required", "description": "GstdTabel902", "valueSetReference": { "display": "GstdTabel902", "reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453" } }, "alias": [ "ToegediendeHoeveelheid" ], "max": "1", "id": "MedicationAdministration.dosage.dose", "comment": "If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage.dose" } }, { "path": "MedicationAdministration.dosage.rate[x]", "min": 0, "definition": "The administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. \r\nEntering an interval (such as 0-10 ml/hour) is also a commonly used option. \r\n\r\nFor example, with an administering speed of 10ml/hour: \r\namount = 10,\r\ndose unit = ml\r\n\r\ntime unit = hour", "short": "AdministeringSpeed", "mapping": [ { "map": "RXA-12-Administered Per (Time Unit)", "identity": "v2" }, { "map": ".rateQuantity", "identity": "rim" }, { "map": "NL-CM:9.13.23159", "comment": "AdministeringSpeed", "identity": "hcim-medicationadministration2-v1.0.1-2017EN" } ], "type": [ { "code": "Ratio" }, { "code": "Quantity", "profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "alias": [ "Toedieningssnelheid" ], "max": "1", "id": "MedicationAdministration.dosage.rate[x]", "comment": "If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.", "base": { "max": "1", "min": 0, "path": "MedicationAdministration.dosage.rate[x]" } }, { "path": "MedicationAdministration.eventHistory", "min": 0, "definition": "A summary of the events of interest that have occurred, such as when the administration was verified.", "short": "A list of events of interest in the lifecycle", "mapping": [ { "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance" } ], "max": "*", "id": "MedicationAdministration.eventHistory", "comment": "This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.", "base": { "max": "*", "min": 0, "path": "MedicationAdministration.eventHistory" } } ] }, "status": "active", "id": "116e5881-cde8-4ae8-a259-bf7e8dd8c73c", "kind": "resource", "url": "http://nictiz.nl/fhir/StructureDefinition/zib-Infusion-AdministeringSystem", "version": "1.0.1", "differential": { "element": [ { "id": "MedicationAdministration", "path": "MedicationAdministration", "mapping": [ { "map": "NL-CM:10.2.2", "comment": "InfusionFluid", "identity": "hcim-infusion-v3.2-2017EN" } ] }, { "id": "MedicationAdministration.device.extension", "path": "MedicationAdministration.device.extension", "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] } }, { "path": "MedicationAdministration.device.extension", "definition": "A description of medical devices required for administering the infusion fluid and placing the catheter, such as a volumetric infusion pump, syringe and infusion bag.", "short": "Peripheral", "mapping": [ { "map": "NL-CM:10.2.6", "comment": "Peripheral", "identity": "hcim-infusion-v3.2-2017EN" } ], "type": [ { "code": "Extension", "profile": "http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice" } ], "sliceName": "Peripheral", "alias": [ "Randapparaat" ], "id": "MedicationAdministration.device.extension:Peripheral", "comment": "Use the direct reference to the Device resource (MedicationAdministration.device.reference) when no meta data regarding the use of the device is available or needed." }, { "id": "MedicationAdministration.note.text", "path": "MedicationAdministration.note.text", "alias": [ "ToedieningsSysteemToelichting" ], "short": "AdministeringSystemComment", "mapping": [ { "map": "NL-CM:10.2.12", "comment": "AdministeringSystemComment", "identity": "hcim-infusion-v3.2-2017EN" } ], "definition": "A comment on the administering system." } ] }, "contact": [ { "name": "Nictiz", "telecom": [ { "use": "work", "value": "https://www.nictiz.nl", "system": "url" } ] } ], "baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration" }