FHIR IG Statistics: StructureDefinition/il-core-medication-administration
Resources that use this resource
Resources that this resource uses
Narrative
No narrative content found in resource
Source
{
"resourceType": "StructureDefinition",
"id": "il-core-medication-administration",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://fhir.health.gov.il/StructureDefinition/il-core-medication-administration",
"version": "0.17.0",
"name": "ILCoreMedicationAdministration",
"title": "ILCore MedicationAdministration Profile",
"status": "active",
"date": "2025-03-27",
"publisher": "Israel Core Team",
"contact": [
{
"telecom": [
{
"system": "email",
"value": "tal.primak@moh.gov.il"
}
]
}
],
"description": "Israel Core proposed constraints and extensions on the MedicationAdministration Resource",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "w3c.prov",
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV"
}
],
"kind": "resource",
"abstract": false,
"type": "MedicationAdministration",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "MedicationAdministration",
"path": "MedicationAdministration",
"short": "ILCore MedicationAdministration Profile",
"definition": "Israel Core proposed constraints and extensions on the MedicationAdministration resource profile.",
"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-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"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-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"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": "http://hl7.org/fhirpath/System.String",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
]
}
],
"isModifier": false,
"isSummary": true
},
{
"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 might 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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"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 can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.extension",
"path": "MedicationAdministration.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.extension:narcotic",
"path": "MedicationAdministration.extension",
"sliceName": "narcotic",
"short": "Ext: Narcotic Medication",
"definition": "Extension: Noting if a medication is narcotic or not",
"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": [
"http://fhir.health.gov.il/StructureDefinition/ext-narcotic-medication"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.extension:recorded",
"path": "MedicationAdministration.extension",
"sliceName": "recorded",
"short": "Ext: Recorded Time",
"definition": "Extension: The time in whitch an event was recorded",
"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": [
"http://fhir.health.gov.il/StructureDefinition/ext-medication-recorded-time"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.modifierExtension",
"path": "MedicationAdministration.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 resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.identifier",
"path": "MedicationAdministration.identifier",
"short": "External identifier",
"definition": "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment": "This is a business identifier, not a resource identifier.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "MedicationAdministration.instantiates",
"path": "MedicationAdministration.instantiates",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.instantiates",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.instantiates"
},
{
"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.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.partOf",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-medication-administration",
"http://fhir.health.gov.il/StructureDefinition/il-core-procedure"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.partOf"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]"
}
]
},
{
"id": "MedicationAdministration.status",
"path": "MedicationAdministration.status",
"short": "in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown",
"definition": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"base": {
"path": "MedicationAdministration.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationStatus"
}
],
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationAdministration.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"id": "MedicationAdministration.statusReason",
"path": "MedicationAdministration.statusReason",
"short": "Reason administration not performed",
"definition": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.statusReason",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.statusReason"
},
{
"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.category",
"path": "MedicationAdministration.category",
"short": "Type of medication usage",
"definition": "Indicates where the medication is expected to be consumed or administered.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.category",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.health.gov.il/ValueSet/il-core-medication-administration-category"
},
"mapping": [
{
"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"
}
],
"ordered": false,
"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"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADMM]"
}
]
},
{
"id": "MedicationAdministration.medication[x]:medicationCodeableConcept",
"path": "MedicationAdministration.medication[x]",
"sliceName": "medicationCodeableConcept",
"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": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.medication[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.health.gov.il/ValueSet/il-core-medication-statement-code"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADMM]"
}
]
},
{
"id": "MedicationAdministration.medication[x]:medicationReference",
"path": "MedicationAdministration.medication[x]",
"sliceName": "medicationReference",
"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": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.medication[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-medication"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADMM]"
}
]
},
{
"id": "MedicationAdministration.subject",
"path": "MedicationAdministration.subject",
"short": "Who received medication",
"definition": "The person or animal or group receiving the medication.",
"min": 1,
"max": "1",
"base": {
"path": "MedicationAdministration.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-group"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"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 during which the medication administration was performed.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "FiveWs.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\"]"
}
]
},
{
"id": "MedicationAdministration.supportingInformation",
"path": "MedicationAdministration.supportingInformation",
"short": "Additional information to support administration",
"definition": "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.supportingInformation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"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)]"
}
]
},
{
"id": "MedicationAdministration.effective[x]",
"path": "MedicationAdministration.effective[x]",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
},
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "MedicationAdministration.performer",
"path": "MedicationAdministration.performer",
"short": "Who performed the medication administration and what they did",
"definition": "Indicates who or what performed the medication administration and how they were involved.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"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]"
}
]
},
{
"id": "MedicationAdministration.performer.id",
"path": "MedicationAdministration.performer.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhirpath/System.String",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.performer.extension",
"path": "MedicationAdministration.performer.extension",
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.performer.modifierExtension",
"path": "MedicationAdministration.performer.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.performer.function",
"path": "MedicationAdministration.performer.function",
"short": "Type of performance",
"definition": "Distinguishes the type of involvement of the performer in the medication administration.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.performer.function",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationPerformerFunction"
}
],
"strength": "example",
"description": "A code describing the role an individual played in administering the medication.",
"valueSet": "http://hl7.org/fhir/ValueSet/med-admin-perform-function"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.function"
},
{
"identity": "rim",
"map": "participation[typeCode=PRF].functionCode"
}
]
},
{
"id": "MedicationAdministration.performer.actor",
"path": "MedicationAdministration.performer.actor",
"short": "Who performed the medication administration",
"definition": "Indicates who or what performed the medication administration.",
"min": 1,
"max": "1",
"base": {
"path": "MedicationAdministration.performer.actor",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner",
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner-role",
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-related-person",
"http://fhir.health.gov.il/StructureDefinition/il-core-device"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"id": "MedicationAdministration.reasonCode",
"path": "MedicationAdministration.reasonCode",
"short": "Reason administration performed",
"definition": "A code indicating why the medication was given.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"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://fhir.health.gov.il/StructureDefinition/il-core-condition",
"http://fhir.health.gov.il/StructureDefinition/il-core-observation",
"http://fhir.health.gov.il/StructureDefinition/il-core-diagnostic-report"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value"
},
{
"identity": "w3c.prov",
"map": "no mapping"
}
]
},
{
"id": "MedicationAdministration.request",
"path": "MedicationAdministration.request",
"short": "Request administration performed against",
"definition": "The original request, instruction or authority to perform the administration.",
"comment": "This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.request",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-medication-request"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.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.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.device",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-device"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"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.",
"min": 0,
"max": "*",
"base": {
"path": "MedicationAdministration.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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')])"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
},
{
"id": "MedicationAdministration.dosage.id",
"path": "MedicationAdministration.dosage.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhirpath/System.String",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.dosage.extension",
"path": "MedicationAdministration.dosage.extension",
"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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.dosage.modifierExtension",
"path": "MedicationAdministration.dosage.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (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,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.dosage.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"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 [bodySite](extension-bodysite.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationSite"
}
],
"strength": "extensible",
"description": "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSet": "http://hl7.org/fhir/ValueSet/approach-site-codes"
},
"mapping": [
{
"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": "Path of substance into body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.dosage.route",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RouteOfAdministration"
}
],
"strength": "extensible",
"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": "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationMethod"
}
],
"strength": "preferred",
"description": "A coded concept describing the technique by which the medicine is administered.",
"valueSet": "http://hl7.org/fhir/ValueSet/administration-method-codes"
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"id": "MedicationAdministration.dosage.dose",
"path": "MedicationAdministration.dosage.dose",
"short": "Amount of medication per dose",
"definition": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MedicationAdministration.dosage.dose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.health.gov.il/ValueSet/il-core-common-units-of-measure",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://fhir.health.gov.il/ValueSet/il-core-units-of-measure"
}
]
},
"mapping": [
{
"identity": "v2",
"map": "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"id": "MedicationAdministration.dosage.rate[x]",
"path": "MedicationAdministration.dosage.rate[x]",
"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"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"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 might 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"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "MedicationAdministration",
"path": "MedicationAdministration",
"short": "ILCore MedicationAdministration Profile",
"definition": "Israel Core proposed constraints and extensions on the MedicationAdministration resource profile."
},
{
"id": "MedicationAdministration.extension",
"path": "MedicationAdministration.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "MedicationAdministration.extension:narcotic",
"path": "MedicationAdministration.extension",
"sliceName": "narcotic",
"short": "Ext: Narcotic Medication",
"definition": "Extension: Noting if a medication is narcotic or not",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.health.gov.il/StructureDefinition/ext-narcotic-medication"
]
}
]
},
{
"id": "MedicationAdministration.extension:recorded",
"path": "MedicationAdministration.extension",
"sliceName": "recorded",
"short": "Ext: Recorded Time",
"definition": "Extension: The time in whitch an event was recorded",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.health.gov.il/StructureDefinition/ext-medication-recorded-time"
]
}
]
},
{
"id": "MedicationAdministration.partOf",
"path": "MedicationAdministration.partOf",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-medication-administration",
"http://fhir.health.gov.il/StructureDefinition/il-core-procedure"
]
}
]
},
{
"id": "MedicationAdministration.status",
"path": "MedicationAdministration.status",
"mustSupport": true
},
{
"id": "MedicationAdministration.category",
"path": "MedicationAdministration.category",
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.health.gov.il/ValueSet/il-core-medication-administration-category"
}
},
{
"id": "MedicationAdministration.medication[x]",
"path": "MedicationAdministration.medication[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"mustSupport": true
},
{
"id": "MedicationAdministration.medication[x]:medicationCodeableConcept",
"path": "MedicationAdministration.medication[x]",
"sliceName": "medicationCodeableConcept",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.health.gov.il/ValueSet/il-core-medication-statement-code"
}
},
{
"id": "MedicationAdministration.medication[x]:medicationReference",
"path": "MedicationAdministration.medication[x]",
"sliceName": "medicationReference",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-medication"
]
}
]
},
{
"id": "MedicationAdministration.subject",
"path": "MedicationAdministration.subject",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-group"
]
}
],
"mustSupport": true
},
{
"id": "MedicationAdministration.context",
"path": "MedicationAdministration.context",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
]
},
{
"id": "MedicationAdministration.effective[x]",
"path": "MedicationAdministration.effective[x]",
"mustSupport": true
},
{
"id": "MedicationAdministration.performer.actor",
"path": "MedicationAdministration.performer.actor",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner",
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner-role",
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-related-person",
"http://fhir.health.gov.il/StructureDefinition/il-core-device"
]
}
]
},
{
"id": "MedicationAdministration.reasonReference",
"path": "MedicationAdministration.reasonReference",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-condition",
"http://fhir.health.gov.il/StructureDefinition/il-core-observation",
"http://fhir.health.gov.il/StructureDefinition/il-core-diagnostic-report"
]
}
]
},
{
"id": "MedicationAdministration.request",
"path": "MedicationAdministration.request",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-medication-request"
]
}
]
},
{
"id": "MedicationAdministration.device",
"path": "MedicationAdministration.device",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-device"
]
}
]
},
{
"id": "MedicationAdministration.dosage.text",
"path": "MedicationAdministration.dosage.text",
"mustSupport": true
},
{
"id": "MedicationAdministration.dosage.site",
"path": "MedicationAdministration.dosage.site",
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationSite"
}
],
"strength": "extensible",
"description": "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSet": "http://hl7.org/fhir/ValueSet/approach-site-codes"
}
},
{
"id": "MedicationAdministration.dosage.route",
"path": "MedicationAdministration.dosage.route",
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RouteOfAdministration"
}
],
"strength": "extensible",
"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": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
{
"id": "MedicationAdministration.dosage.method",
"path": "MedicationAdministration.dosage.method",
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationMethod"
}
],
"strength": "preferred",
"description": "A coded concept describing the technique by which the medicine is administered.",
"valueSet": "http://hl7.org/fhir/ValueSet/administration-method-codes"
}
},
{
"id": "MedicationAdministration.dosage.dose",
"path": "MedicationAdministration.dosage.dose",
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.health.gov.il/ValueSet/il-core-common-units-of-measure",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://fhir.health.gov.il/ValueSet/il-core-units-of-measure"
}
]
}
}
]
}
}
FHIR