{ "resourceType": "StructureDefinition", "id": "HdBe-MedicationAdministration2", "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-MedicationAdministration2", "name": "HdBeMedicationAdministration2", "title": "HdBe MedicationAdministration2", "status": "draft", "date": "2022-10-17T09:09:13.9562003+00:00", "publisher": "Healthdata.be (Sciensano)", "contact": [ { "name": "Service portal – healthdata.be", "telecom": [ { "system": "url", "value": "https://sciensano.service-now.com/sp", "use": "work" } ] } ], "description": "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.", "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "HdBe-MedicationAdministration2", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MedicationAdministration2", "name": "HdBe logical model MedicationAdministration2" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "uri": "https://zibs.nl/wiki/MedicationAdministration2-v1.1.1(2020EN)", "name": "zib MedicationAdministration2-v1.1.1(2020EN)" }, { "identity": "zib-range-v1.0.1-2020EN", "uri": "https://zibs.nl/wiki/Range-v1.0.1(2020EN)", "name": "zib Range-v1.0.1(2020EN)" }, { "identity": "HdBe-Range", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Range", "name": "HdBe logical model Range" } ], "kind": "resource", "abstract": false, "type": "MedicationAdministration", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "derivation": "constraint", "snapshot": { "element": [ { "id": "MedicationAdministration", "path": "MedicationAdministration", "short": "MedicationAdministration", "definition": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.", "comment": "The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html).", "alias": [ "MedicatieToediening" ], "min": 0, "max": "*", "base": { "path": "MedicationAdministration", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "mad-2", "severity": "error", "human": "Reason not given is only permitted if NotGiven is true", "expression": "reasonNotGiven.empty() or notGiven = true", "xpath": "not(exists(f:reasonNotGiven) and f:notGiven/@value=false())", "source": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" }, { "key": "mad-3", "severity": "error", "human": "Reason given is only permitted if NotGiven is false", "expression": "reasonCode.empty() or notGiven.empty() or notGiven = 'false'", "xpath": "not(exists(f:reasonCode) and f:notGiven/@value=true())", "source": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "..Event" }, { "identity": "rim", "map": "SubstanceAdministration" }, { "identity": "w5", "map": "clinical.medication" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.20928", "comment": "MedicationAdministration" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2" } ] }, { "id": "MedicationAdministration.id", "path": "MedicationAdministration.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "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.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.meta", "path": "MedicationAdministration.meta", "short": "Metadata about the resource", "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.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.implicitRules", "path": "MedicationAdministration.implicitRules", "short": "A set of rules under which this content was created", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.language", "path": "MedicationAdministration.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "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" } ], "strength": "extensible", "description": "A human language." }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.text", "path": "MedicationAdministration.text", "short": "Text summary of the resource, for human interpretation", "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.", "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "MedicationAdministration.contained", "path": "MedicationAdministration.contained", "short": "Contained, inline Resources", "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.", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension", "path": "MedicationAdministration.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:agreedDateTime", "path": "MedicationAdministration.extension", "sliceName": "agreedDateTime", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.AgreedDateTime" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:agreedDateTime.id", "path": "MedicationAdministration.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.extension:agreedDateTime.extension", "path": "MedicationAdministration.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:agreedDateTime.url", "path": "MedicationAdministration.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.AgreedDateTime", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:agreedDateTime.value[x]", "path": "MedicationAdministration.extension.value[x]", "short": "AgreedDateTime", "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.", "alias": [ "AfgesprokenDatumTijd" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23171", "comment": "AgreedDateTime" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AgreedDateTime" } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed", "path": "MedicationAdministration.extension", "sliceName": "doubleCheckPerformed", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.DoubleCheckPerformed" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed.id", "path": "MedicationAdministration.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed.extension", "path": "MedicationAdministration.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed.url", "path": "MedicationAdministration.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.DoubleCheckPerformed", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed.value[x]", "path": "MedicationAdministration.extension.value[x]", "short": "DoubleCheckPerformed", "definition": "Was a double check performed prior to the administration? This is only legally required for certain medication.", "comment": "MedicationAdministration has another way to capture that a double check has been performed, namely by marking a performer as _verifier_. Therefore, if a `performer.actor` exists + `performer.function` = _verifier_ then DoubleCheckPerformed may be assumed _true_.", "alias": [ "DubbeleControleUitgevoerd" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23168", "comment": "DoubleCheckPerformed" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.DoubleCheckPerformed" } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration", "path": "MedicationAdministration.extension", "sliceName": "deviatingAdministration", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.DeviatingAdministration" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration.id", "path": "MedicationAdministration.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration.extension", "path": "MedicationAdministration.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration.url", "path": "MedicationAdministration.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.DeviatingAdministration", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration.value[x]", "path": "MedicationAdministration.extension.value[x]", "short": "DeviatingAdministration", "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.", "alias": [ "AfwijkendeToediening" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23167", "comment": "DeviatingAdministration" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.DeviatingAdministration" } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation", "path": "MedicationAdministration.extension", "sliceName": "medicationAdministrationReasonForDeviation", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.ReasonForDeviation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation.id", "path": "MedicationAdministration.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation.extension", "path": "MedicationAdministration.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation.url", "path": "MedicationAdministration.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.ReasonForDeviation", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation.value[x]", "path": "MedicationAdministration.extension.value[x]", "short": "MedicationAdministrationReasonForDeviation", "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.", "comment": "This MedicationAdministrationReasonForDeviation extension has overlap with `statusReason`. Both concepts allow the documentation of reasons why an administration did not take place, potentially resulting in duplicated information in both places. This extension, however, has a broader scope because it also covers the reasons why administrations are performed differently than the agreement.", "alias": [ "MedicatieToedieningRedenVanAfwijken" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "strength": "required", "valueSet": "https://fhir.healthdata.be/ValueSet/MedicationAdministrationReasonForDeviation" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23166", "comment": "MedicationAdministrationReasonForDeviation" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.MedicationAdministrationReasonForDeviation" } ] }, { "id": "MedicationAdministration.modifierExtension", "path": "MedicationAdministration.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.identifier", "path": "MedicationAdministration.identifier", "short": "External identifier", "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.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "workflow", "map": "…identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "MedicationAdministration.definition", "path": "MedicationAdministration.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.definition", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition" ] }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "…definition" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]" } ] }, { "id": "MedicationAdministration.partOf", "path": "MedicationAdministration.partOf", "short": "Part of referenced event", "definition": "A larger event of which this particular event is a component or step.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.partOf", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" ] }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Procedure" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "…part of" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]" } ] }, { "id": "MedicationAdministration.status", "path": "MedicationAdministration.status", "short": "MedicationAdministrationStatus", "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\n\r\n* Active: The product is administered.\r\n* Suspended: 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\n* Aborted: Administration has stopped.\r\n* Completed: Administration has been completed.\r\n* Canceled: The product was never administered.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "alias": [ "MedicatieToedieningStatus" ], "min": 1, "max": "1", "base": { "path": "MedicationAdministration.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationStatus" } ], "strength": "required", "description": "Use ConceptMap 'MedicationAdministrationStatus-to-MedicationAdministrationStatus' to translate CBB terminology to profile terminology in ValueSet 'MedicationAdministrationStatus'.", "valueSet": "http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1", "_valueSet": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", "valueCanonical": "https://fhir.healthdata.be/ConceptMap/MedicationAdministrationStatus-to-MedicationAdministrationStatus" } ] } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…status" }, { "identity": "v2", "map": "RXA-20-Completion Status" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21191", "comment": "MedicationAdministrationStatus" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.MedicationAdministrationStatus" } ] }, { "id": "MedicationAdministration.category", "path": "MedicationAdministration.category", "short": "Type of medication usage", "definition": "Indicates the type of medication administration and where the medication is expected to be consumed or administered.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 1, "max": "1", "base": { "path": "MedicationAdministration.category", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "patternCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "18629005" } ] }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationCategory" } ], "strength": "preferred", "description": "A coded concept describing where the medication administered is expected to occur" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value" } ] }, { "id": "MedicationAdministration.medication[x]", "path": "MedicationAdministration.medication[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "short": "What was administered", "definition": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", "comment": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.  For example if you require form or lot number, then you must reference the Medication resource. .", "min": 1, "max": "1", "base": { "path": "MedicationAdministration.medication[x]", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationCode" } ], "strength": "example", "description": "Codes identifying substance or product that can be administered." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…code" }, { "identity": "v2", "map": "RXA-5-Administered Code" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=ADMM]" }, { "identity": "w5", "map": "what" } ] }, { "id": "MedicationAdministration.medication[x]:medicationReference", "path": "MedicationAdministration.medication[x]", "sliceName": "medicationReference", "short": "AdministrationProduct", "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.", "comment": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.  For example if you require form or lot number, then you must reference the Medication resource. .", "alias": [ "ToedieningsProduct" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.medication[x]", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication", "https://fhir.healthdata.be/StructureDefinition/HdBe-PharmaceuticalProduct" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…code" }, { "identity": "v2", "map": "RXA-5-Administered Code" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=ADMM]" }, { "identity": "w5", "map": "what" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.20929", "comment": "AdministrationProduct" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministrationProduct" } ] }, { "id": "MedicationAdministration.subject", "path": "MedicationAdministration.subject", "short": "Who received medication", "definition": "The person or animal or group receiving the medication.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 1, "max": "1", "base": { "path": "MedicationAdministration.subject", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group", "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "…subject" }, { "identity": "v2", "map": "PID-3-Patient ID List" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role[classCode=PAT]" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "MedicationAdministration.context", "path": "MedicationAdministration.context", "short": "Encounter or Episode of Care administered as part of", "definition": "The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.context", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "…context" }, { "identity": "v2", "map": "PV1-19-Visit Number" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]" }, { "identity": "w5", "map": "context" } ] }, { "id": "MedicationAdministration.supportingInformation", "path": "MedicationAdministration.supportingInformation", "slicing": { "discriminator": [ { "type": "profile", "path": "resolve()" } ], "rules": "open" }, "short": "Additional information to support administration", "definition": "Additional information (for example, patient height and weight) that supports the administration of the medication.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.supportingInformation", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "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": "w5", "map": "context" } ] }, { "id": "MedicationAdministration.supportingInformation:administrationAgreement", "path": "MedicationAdministration.supportingInformation", "sliceName": "administrationAgreement", "short": "AdministrationAgreement", "definition": "Administration agreement on which this administration is based.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias": [ "Toedieningsafspraak" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.supportingInformation", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource", "https://fhir.healthdata.be/StructureDefinition/HdBe-AdministrationAgreement" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "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": "w5", "map": "context" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23237", "comment": "AdministrationAgreement" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.RelatedAgreement.AdministrationAgreement" } ] }, { "id": "MedicationAdministration.effective[x]", "path": "MedicationAdministration.effective[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "short": "Start and end time of administration", "definition": "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", "min": 1, "max": "1", "base": { "path": "MedicationAdministration.effective[x]", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…occurrence[x]" }, { "identity": "v2", "map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "id": "MedicationAdministration.effective[x]:effectiveDateTime", "path": "MedicationAdministration.effective[x]", "sliceName": "effectiveDateTime", "short": "AdministrationDateTime", "definition": "The date and time at which the medication was administered.", "alias": [ "ToedieningsDatumTijd" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.effective[x]", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…occurrence[x]" }, { "identity": "v2", "map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21193", "comment": "AdministrationDateTime" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministrationDateTime" } ] }, { "id": "MedicationAdministration.performer", "path": "MedicationAdministration.performer", "short": "Administrator", "definition": "The concept describes the person who administered the product. This is a professional authorised administrator, the patient themselves or the caregiver, for example.", "alias": [ "Toediener" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.performer", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…performer" }, { "identity": "v2", "map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.actor" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21196", "comment": "Administrator" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator" } ] }, { "id": "MedicationAdministration.performer.id", "path": "MedicationAdministration.performer.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.performer.extension", "path": "MedicationAdministration.performer.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.performer.modifierExtension", "path": "MedicationAdministration.performer.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.performer.actor", "path": "MedicationAdministration.performer.actor", "short": "Patient / HealthProfessional / Caregiver", "definition": "The concept describes the person who administered the product. This is a professional authorised administrator, the patient themselves or the caregiver, for example.", "comment": "Each occurrence of the CBB HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [HdBe-HealthProfessional-PractitionerRole](https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [HdBe-HealthProfessional-Practitioner](https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.\r\n\r\nIn rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.", "alias": [ "Patiënt", "Zorgverlener", "Mantelzorger" ], "min": 1, "max": "1", "base": { "path": "MedicationAdministration.performer.actor", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "https://fhir.healthdata.be/StructureDefinition/pattern-HealthProfessionalReference" ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device", "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient", "https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-PractitionerRole", "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "….actor" }, { "identity": "rim", "map": ".role" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23380", "comment": "Patient" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23172", "comment": "HealthProfessional" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23355", "comment": "Caregiver" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator.Patient" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator.HealthProfessional" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator.Caregiver" } ] }, { "id": "MedicationAdministration.performer.onBehalfOf", "path": "MedicationAdministration.performer.onBehalfOf", "short": "Organization organization was acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.performer.onBehalfOf", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "….onBehalfOf" }, { "identity": "rim", "map": ".role.scopingOrganization" } ] }, { "id": "MedicationAdministration.notGiven", "path": "MedicationAdministration.notGiven", "short": "True if medication not administered", "definition": "Set this to true if the record is saying that the medication was NOT administered.", "comment": "This element is labeled as a modifier because it indicates that a administration didn't happen.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.notGiven", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "meaningWhenMissing": "If this is missing, then the medication was administered", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "…notDone" }, { "identity": "v2", "map": "RXA-20-Completion Status='NA'" }, { "identity": "rim", "map": ".actionNegationInd" } ] }, { "id": "MedicationAdministration.reasonNotGiven", "path": "MedicationAdministration.reasonNotGiven", "short": "Reason administration not performed", "definition": "A code indicating why the administration was not performed.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.reasonNotGiven", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1", "mad-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationNegationReason" } ], "strength": "example", "description": "A set of codes indicating the reason why the MedicationAdministration is negated." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "…notDoneReason" }, { "identity": "v2", "map": "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value" } ] }, { "id": "MedicationAdministration.reasonCode", "path": "MedicationAdministration.reasonCode", "short": "Reason administration performed", "definition": "A code indicating why the medication was given.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.reasonCode", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1", "mad-3" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationReason" } ], "strength": "example", "description": "A set of codes indicating the reason why the MedicationAdministration was made." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "…reasonGivenCodeableConcept" }, { "identity": "v2", "map": "RXE-27 Give Indication" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "MedicationAdministration.reasonReference", "path": "MedicationAdministration.reasonReference", "short": "Condition or Observation that supports why the medication was administered", "definition": "Condition or observation that supports why the medication was administered.", "comment": "This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.reasonReference", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition" ] }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "…reasonReference" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value" }, { "identity": "w3c.prov", "map": "no mapping" }, { "identity": "w5", "map": "why" } ] }, { "id": "MedicationAdministration.prescription", "path": "MedicationAdministration.prescription", "short": "Request administration performed against", "definition": "The original request, instruction or authority to perform the administration.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.prescription", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "…basedOn" }, { "identity": "v2", "map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number" }, { "identity": "rim", "map": "InFullfillmentOf->SubstanceAdministration" } ] }, { "id": "MedicationAdministration.device", "path": "MedicationAdministration.device", "short": "Device used to administer", "definition": "The device used in administering the medication to the patient. For example, a particular infusion pump.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.device", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "PRT-10 Participation Device / RXR-3 Administrative Device" }, { "identity": "rim", "map": "device->Access OR device->AssignedDevice" } ] }, { "id": "MedicationAdministration.note", "path": "MedicationAdministration.note", "short": "Information about the administration", "definition": "Extra information about the medication administration that is not conveyed by the other attributes.", "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "workflow", "map": "…note" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value" } ] }, { "id": "MedicationAdministration.note.id", "path": "MedicationAdministration.note.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.note.extension", "path": "MedicationAdministration.note.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.note.author[x]", "path": "MedicationAdministration.note.author[x]", "short": "Individual responsible for the annotation", "definition": "The individual responsible for making the annotation.", "min": 0, "max": "1", "base": { "path": "Annotation.author[x]", "min": 0, "max": "1" }, "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.participant[typeCode=AUT].role" } ] }, { "id": "MedicationAdministration.note.time", "path": "MedicationAdministration.note.time", "short": "When the annotation was made", "definition": "Indicates when this particular annotation was made.", "min": 0, "max": "1", "base": { "path": "Annotation.time", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.effectiveTime" } ] }, { "id": "MedicationAdministration.note.text", "path": "MedicationAdministration.note.text", "short": "Comment", "definition": "Comments on administering the medication.", "comment": "Note that FHIR strings may not exceed 1MB in size", "alias": [ "Toelichting" ], "min": 1, "max": "1", "base": { "path": "Annotation.text", "min": 1, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.text" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21337", "comment": "Comment" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Comment" } ] }, { "id": "MedicationAdministration.dosage", "path": "MedicationAdministration.dosage", "short": "Details of how medication was taken", "definition": "Describes the medication dosage information details e.g. dose, rate, site, route, etc.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage", "min": 0, "max": "1" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "mad-1", "severity": "error", "human": "SHALL have at least one of dosage.dose or dosage.rate[x]", "expression": "dose.exists() or rate.exists()", "xpath": "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])", "source": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "component->SubstanceAdministrationEvent" } ] }, { "id": "MedicationAdministration.dosage.id", "path": "MedicationAdministration.dosage.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.dosage.extension", "path": "MedicationAdministration.dosage.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange", "path": "MedicationAdministration.dosage.extension", "sliceName": "administeringSpeedRange", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.AdministeringSpeedRange" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.id", "path": "MedicationAdministration.dosage.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.extension", "path": "MedicationAdministration.dosage.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.url", "path": "MedicationAdministration.dosage.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.AdministeringSpeedRange", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x]", "path": "MedicationAdministration.dosage.extension.value[x]", "short": "AdministeringSpeed", "definition": "The administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. \nFor example, with an administering speed of 10ml/hour: \r\n- amount = 10,\r\n- dose unit = ml \r\n- time unit = hour", "alias": [ "Toedieningssnelheid" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Range" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23159", "comment": "AdministeringSpeed" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministeringSpeed" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x].id", "path": "MedicationAdministration.dosage.extension.value[x].id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x].extension", "path": "MedicationAdministration.dosage.extension.value[x].extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x].low", "path": "MedicationAdministration.dosage.extension.value[x].low", "short": "minimumValue", "definition": "The minimal value of the range. The boundary is inclusive.", "comment": "If the low element is missing, the low boundary is not known.", "alias": [ "minimumWaarde" ], "min": 0, "max": "1", "base": { "path": "Range.low", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "ele-1", "rng-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "http://hl7.org/fhir/StructureDefinition/Quantity" }, { "key": "sqty-1", "severity": "error", "human": "The comparator is not used on a SimpleQuantity", "expression": "comparator.empty()", "xpath": "not(exists(f:comparator))", "source": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL, MO, CO, depending on the values" }, { "identity": "v2", "map": "NR.1" }, { "identity": "rim", "map": "./low" }, { "identity": "zib-range-v1.0.1-2020EN", "map": "NL-CM:20.1.2", "comment": "minimumValue" }, { "identity": "HdBe-Range", "map": "MinimumValue" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x].high", "path": "MedicationAdministration.dosage.extension.value[x].high", "short": "maximumValue", "definition": "The maximum value of the range. The boundary is inclusive.", "comment": "If the high element is missing, the high boundary is not known.", "alias": [ "maximumWaarde" ], "min": 0, "max": "1", "base": { "path": "Range.high", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "ele-1", "rng-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "http://hl7.org/fhir/StructureDefinition/Quantity" }, { "key": "sqty-1", "severity": "error", "human": "The comparator is not used on a SimpleQuantity", "expression": "comparator.empty()", "xpath": "not(exists(f:comparator))", "source": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL, MO, CO, depending on the values" }, { "identity": "v2", "map": "NR.2" }, { "identity": "rim", "map": "./high" }, { "identity": "zib-range-v1.0.1-2020EN", "map": "NL-CM:20.1.3", "comment": "maximumValue" }, { "identity": "HdBe-Range", "map": "MaximumValue" } ] }, { "id": "MedicationAdministration.dosage.modifierExtension", "path": "MedicationAdministration.dosage.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "MedicationAdministration.dosage.text", "path": "MedicationAdministration.dosage.text", "short": "Free text dosage instructions e.g. SIG", "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".text" } ] }, { "id": "MedicationAdministration.dosage.site", "path": "MedicationAdministration.dosage.site", "short": "Body site administered to", "definition": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".", "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.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.site", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationSite" } ], "strength": "example", "description": "A coded concept describing the site location the medicine enters into or onto the body." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "RXR-2 Administration Site / RXR-6 Administration Site Modifier" }, { "identity": "rim", "map": ".approachSiteCode" } ] }, { "id": "MedicationAdministration.dosage.route", "path": "MedicationAdministration.dosage.route", "short": "RouteOfAdministration", "definition": "The route through which the medication is administered (oral, nasal, intravenous,...).", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "alias": [ "Toedieningsweg" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.route", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RouteOfAdministration" } ], "strength": "required", "description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.", "valueSet": "https://fhir.healthdata.be/ValueSet/RouteOfMedicationAdministration" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "RXR-1-Route" }, { "identity": "rim", "map": ".routeCode" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21195", "comment": "RouteOfAdministration" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.RouteOfAdministration" } ] }, { "id": "MedicationAdministration.dosage.method", "path": "MedicationAdministration.dosage.method", "short": "How drug was administered", "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.", "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.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.method", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationMethod" } ], "strength": "example", "description": "A coded concept describing the technique by which the medicine is administered." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "RXR-4-Administration Method" }, { "identity": "rim", "map": ".methodCode" } ] }, { "id": "MedicationAdministration.dosage.dose", "path": "MedicationAdministration.dosage.dose", "short": "AdministeredAmount", "definition": "Amount of the administered product.", "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.", "alias": [ "ToegediendeHoeveelheid" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.dose", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "xpath": "not(exists(f:code)) or exists(f:system)", "source": "http://hl7.org/fhir/StructureDefinition/Quantity" }, { "key": "sqty-1", "severity": "error", "human": "The comparator is not used on a SimpleQuantity", "expression": "comparator.empty()", "xpath": "not(exists(f:comparator))", "source": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL, MO, CO, depending on the values" }, { "identity": "v2", "map": "RXA-6 Administered Amount / RXA-7 Administered Units" }, { "identity": "rim", "map": ".doseQuantity" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21194", "comment": "AdministeredAmount" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministeredAmount" } ] }, { "id": "MedicationAdministration.dosage.rate[x]", "path": "MedicationAdministration.dosage.rate[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "short": "Dose quantity per unit of time", "definition": "Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.", "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.", "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.rate[x]", "min": 0, "max": "1" }, "type": [ { "code": "Ratio" }, { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RXA-12-Administered Per (Time Unit)" }, { "identity": "rim", "map": ".rateQuantity" } ] }, { "id": "MedicationAdministration.dosage.rate[x]:rateQuantity", "path": "MedicationAdministration.dosage.rate[x]", "sliceName": "rateQuantity", "short": "AdministeringSpeed / nominalValue", "definition": "The administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. \nFor example, with an administering speed of 10ml/hour: \r\n- amount = 10,\r\n- dose unit = ml \r\n- time unit = hour", "comment": "The extension MedicationAdministration2AdministeringSpeedRange extends `.rate[x]` with the Range datatype to allow population of the minimumValue and the maximumValue of the CBB Range.", "alias": [ "Toedieningssnelheid", "nominaleWaarde" ], "min": 0, "max": "1", "base": { "path": "MedicationAdministration.dosage.rate[x]", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RXA-12-Administered Per (Time Unit)" }, { "identity": "rim", "map": ".rateQuantity" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23159", "comment": "AdministeringSpeed" }, { "identity": "zib-range-v1.0.1-2020EN", "map": "NL-CM:20.1.4", "comment": "nominalValue" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministeringSpeed" }, { "identity": "HdBe-Range", "map": "Range.NominalValue" } ] }, { "id": "MedicationAdministration.eventHistory", "path": "MedicationAdministration.eventHistory", "short": "A list of events of interest in the lifecycle", "definition": "A summary of the events of interest that have occurred, such as when the administration was verified.", "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.", "min": 0, "max": "*", "base": { "path": "MedicationAdministration.eventHistory", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ] }, { "id": "MedicationAdministration.request", "path": "MedicationAdministration.request", "short": "MedicationAgreement", "definition": "Medication agreement on which this administration is based.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias": [ "Medicatieafspraak" ], "min": 0, "max": "*", "base": { "path": "MedicationAdministration.request" }, "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-MedicationAgreement", "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23170", "comment": "MedicationAgreement" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.RelatedAgreement.MedicationAgreement" } ] } ] }, "differential": { "element": [ { "id": "MedicationAdministration", "path": "MedicationAdministration", "short": "MedicationAdministration", "alias": [ "MedicatieToediening" ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.20928", "comment": "MedicationAdministration" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2" } ] }, { "id": "MedicationAdministration.extension", "path": "MedicationAdministration.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "MedicationAdministration.extension:agreedDateTime", "path": "MedicationAdministration.extension", "sliceName": "agreedDateTime", "min": 0, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.AgreedDateTime" ] } ] }, { "id": "MedicationAdministration.extension:agreedDateTime.value[x]", "path": "MedicationAdministration.extension.value[x]", "mapping": [ { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AgreedDateTime" } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed", "path": "MedicationAdministration.extension", "sliceName": "doubleCheckPerformed", "min": 0, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.DoubleCheckPerformed" ] } ] }, { "id": "MedicationAdministration.extension:doubleCheckPerformed.value[x]", "path": "MedicationAdministration.extension.value[x]", "mapping": [ { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.DoubleCheckPerformed" } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration", "path": "MedicationAdministration.extension", "sliceName": "deviatingAdministration", "min": 0, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.DeviatingAdministration" ] } ] }, { "id": "MedicationAdministration.extension:deviatingAdministration.value[x]", "path": "MedicationAdministration.extension.value[x]", "mapping": [ { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.DeviatingAdministration" } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation", "path": "MedicationAdministration.extension", "sliceName": "medicationAdministrationReasonForDeviation", "min": 0, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.ReasonForDeviation" ] } ] }, { "id": "MedicationAdministration.extension:medicationAdministrationReasonForDeviation.value[x]", "path": "MedicationAdministration.extension.value[x]", "comment": "This MedicationAdministrationReasonForDeviation extension has overlap with `statusReason`. Both concepts allow the documentation of reasons why an administration did not take place, potentially resulting in duplicated information in both places. This extension, however, has a broader scope because it also covers the reasons why administrations are performed differently than the agreement.", "mapping": [ { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.MedicationAdministrationReasonForDeviation" } ] }, { "id": "MedicationAdministration.status", "path": "MedicationAdministration.status", "short": "MedicationAdministrationStatus", "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\n\r\n* Active: The product is administered.\r\n* Suspended: 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\n* Aborted: Administration has stopped.\r\n* Completed: Administration has been completed.\r\n* Canceled: The product was never administered.", "alias": [ "MedicatieToedieningStatus" ], "binding": { "strength": "required", "description": "Use ConceptMap 'MedicationAdministrationStatus-to-MedicationAdministrationStatus' to translate CBB terminology to profile terminology in ValueSet 'MedicationAdministrationStatus'.", "valueSet": "http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1", "_valueSet": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", "valueCanonical": "https://fhir.healthdata.be/ConceptMap/MedicationAdministrationStatus-to-MedicationAdministrationStatus" } ] } }, "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21191", "comment": "MedicationAdministrationStatus" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.MedicationAdministrationStatus" } ] }, { "id": "MedicationAdministration.category", "path": "MedicationAdministration.category", "min": 1, "patternCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "18629005" } ] } }, { "id": "MedicationAdministration.medication[x]", "path": "MedicationAdministration.medication[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" } }, { "id": "MedicationAdministration.medication[x]:medicationReference", "path": "MedicationAdministration.medication[x]", "sliceName": "medicationReference", "short": "AdministrationProduct", "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.", "alias": [ "ToedieningsProduct" ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication", "https://fhir.healthdata.be/StructureDefinition/HdBe-PharmaceuticalProduct" ] } ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.20929", "comment": "AdministrationProduct" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministrationProduct" } ] }, { "id": "MedicationAdministration.subject", "path": "MedicationAdministration.subject", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group", "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient" ] } ] }, { "id": "MedicationAdministration.supportingInformation", "path": "MedicationAdministration.supportingInformation", "slicing": { "discriminator": [ { "type": "profile", "path": "resolve()" } ], "rules": "open" } }, { "id": "MedicationAdministration.supportingInformation:administrationAgreement", "path": "MedicationAdministration.supportingInformation", "sliceName": "administrationAgreement", "short": "AdministrationAgreement", "definition": "Administration agreement on which this administration is based.", "alias": [ "Toedieningsafspraak" ], "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource", "https://fhir.healthdata.be/StructureDefinition/HdBe-AdministrationAgreement" ] } ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23237", "comment": "AdministrationAgreement" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.RelatedAgreement.AdministrationAgreement" } ] }, { "id": "MedicationAdministration.effective[x]", "path": "MedicationAdministration.effective[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" } }, { "id": "MedicationAdministration.effective[x]:effectiveDateTime", "path": "MedicationAdministration.effective[x]", "sliceName": "effectiveDateTime", "short": "AdministrationDateTime", "definition": "The date and time at which the medication was administered.", "alias": [ "ToedieningsDatumTijd" ], "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21193", "comment": "AdministrationDateTime" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministrationDateTime" } ] }, { "id": "MedicationAdministration.performer", "path": "MedicationAdministration.performer", "short": "Administrator", "definition": "The concept describes the person who administered the product. This is a professional authorised administrator, the patient themselves or the caregiver, for example.", "alias": [ "Toediener" ], "max": "1", "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21196", "comment": "Administrator" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator" } ] }, { "id": "MedicationAdministration.performer.actor", "path": "MedicationAdministration.performer.actor", "short": "Patient / HealthProfessional / Caregiver", "definition": "The concept describes the person who administered the product. This is a professional authorised administrator, the patient themselves or the caregiver, for example.", "alias": [ "Patiënt", "Zorgverlener", "Mantelzorger" ], "type": [ { "code": "Reference", "profile": [ "https://fhir.healthdata.be/StructureDefinition/pattern-HealthProfessionalReference" ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device", "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient", "https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-PractitionerRole", "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson" ] } ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23380", "comment": "Patient" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23172", "comment": "HealthProfessional" }, { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23355", "comment": "Caregiver" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator.Patient" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator.HealthProfessional" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Administrator.Caregiver" } ] }, { "id": "MedicationAdministration.request", "path": "MedicationAdministration.request", "short": "MedicationAgreement", "definition": "Medication agreement on which this administration is based.", "alias": [ "Medicatieafspraak" ], "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-MedicationAgreement", "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] } ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23170", "comment": "MedicationAgreement" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.RelatedAgreement.MedicationAgreement" } ] }, { "id": "MedicationAdministration.note", "path": "MedicationAdministration.note", "max": "1" }, { "id": "MedicationAdministration.note.text", "path": "MedicationAdministration.note.text", "short": "Comment", "definition": "Comments on administering the medication.", "alias": [ "Toelichting" ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21337", "comment": "Comment" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.Comment" } ] }, { "id": "MedicationAdministration.dosage.extension", "path": "MedicationAdministration.dosage.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange", "path": "MedicationAdministration.dosage.extension", "sliceName": "administeringSpeedRange", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-MedicationAdministration2.AdministeringSpeedRange" ] } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x]", "path": "MedicationAdministration.dosage.extension.value[x]", "mapping": [ { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministeringSpeed" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x].low", "path": "MedicationAdministration.dosage.extension.value[x].low", "mapping": [ { "identity": "HdBe-Range", "map": "MinimumValue" } ] }, { "id": "MedicationAdministration.dosage.extension:administeringSpeedRange.value[x].high", "path": "MedicationAdministration.dosage.extension.value[x].high", "mapping": [ { "identity": "HdBe-Range", "map": "MaximumValue" } ] }, { "id": "MedicationAdministration.dosage.route", "path": "MedicationAdministration.dosage.route", "short": "RouteOfAdministration", "definition": "The route through which the medication is administered (oral, nasal, intravenous,...).", "alias": [ "Toedieningsweg" ], "binding": { "strength": "required", "valueSet": "https://fhir.healthdata.be/ValueSet/RouteOfMedicationAdministration" }, "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21195", "comment": "RouteOfAdministration" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.RouteOfAdministration" } ] }, { "id": "MedicationAdministration.dosage.dose", "path": "MedicationAdministration.dosage.dose", "short": "AdministeredAmount", "definition": "Amount of the administered product.", "alias": [ "ToegediendeHoeveelheid" ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.21194", "comment": "AdministeredAmount" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministeredAmount" } ] }, { "id": "MedicationAdministration.dosage.rate[x]", "path": "MedicationAdministration.dosage.rate[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" } }, { "id": "MedicationAdministration.dosage.rate[x]:rateQuantity", "path": "MedicationAdministration.dosage.rate[x]", "sliceName": "rateQuantity", "short": "AdministeringSpeed / nominalValue", "definition": "The administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. \nFor example, with an administering speed of 10ml/hour: \r\n- amount = 10,\r\n- dose unit = ml \r\n- time unit = hour", "comment": "The extension MedicationAdministration2AdministeringSpeedRange extends `.rate[x]` with the Range datatype to allow population of the minimumValue and the maximumValue of the CBB Range.", "alias": [ "Toedieningssnelheid", "nominaleWaarde" ], "type": [ { "code": "Quantity" } ], "mapping": [ { "identity": "zib-medicationadministration2-v1.1.1-2020EN", "map": "NL-CM:9.13.23159", "comment": "AdministeringSpeed" }, { "identity": "zib-range-v1.0.1-2020EN", "map": "NL-CM:20.1.4", "comment": "nominalValue" }, { "identity": "HdBe-MedicationAdministration2", "map": "MedicationAdministration2.AdministeringSpeed" }, { "identity": "HdBe-Range", "map": "Range.NominalValue" } ] } ] } }