Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: HCIM MedicationAdministration
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration | Version: 1.3.15 | |||
| Active as of 2025-09-22 | Computable Name: Zib MedicationAdministration | |||
Copyright/Legal: CC0 |
||||
This profile is based on the Dutch Health and Care Information model (Dutch: Zorginformatiebouwsteen or ZIB) MedicationAdministration version 1.0.1, year 2017. 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.
The goal of administering the medication is to provide insight into the actual administered products.
Usages:
- Derived from this Profile: HCIM Infusion AdministeringSystem
- Refer to this Profile: HCIM FeedingTubeSystem EnteralNutrition, HCIM Infusion-LumenOrLine and HCIM MedicationAdministration
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation | extensible | MedicatieToedieningRedenVanAfwijkenCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.3--20171231000000From this IG | |
| MedicationAdministration.dosage.route | extensible | MedicatieToedieningToedieningswegCodelijst(a valid code from urn:oid:2.16.840.1.113883.2.4.4.9)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.2--20171231000000From this IG | |
| MedicationAdministration.dosage.dose | required | GstdTabel902(a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453From this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MedicationAdministration |
C | 0..* | MedicationAdministration | MedicationAdministration Constraints: mad-2, mad-3 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:agreedDateTime |
0..* | dateTime | AgreedDateTime URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime | |
| extension:doubleCheckPerformed |
0..1 | boolean | DoubleCheckPerformed URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed | |
| extension:medicationTreatment |
0..1 | Identifier | Medicational Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |
 extension:deviatingAdministration |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  extension:deviation |
0..* | Extension | Extension | |
  url |
1..1 | uri | "deviation" | |
  Slices for value[x] |
0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |
 value[x]:valueBoolean |
0..1 | boolean | Value of extension | |
| extension:reasonForDeviation |
0..* | Extension | Extension | |
| url |
1..1 | uri | "reasonForDeviation" | |
| Slices for value[x] |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Value of extension | |
 url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration" | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
0..* | Identifier | External identifier | |
| status |
?!Σ | 1..1 | code | MedicationAdministrationStatus Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration. |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:orderStatus |
0..1 | CodeableConcept | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
| category |
1..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministrationCategory (preferred): A coded concept describing where the medication administered is expected to occur | |
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:MedicationAdministrationCode |
Σ | 0..* | Coding | MedicationAdministrationCode |
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 18629005 |
| display |
Σ | 0..1 | string | Representation defined by the system |
| Slices for medication[x] |
Σ | 1..1 | Reference() | What was administered Slice: Unordered, Closed by type:$this |
| medication[x]:medicationReference |
Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AdministrationProduct |
 subject |
Σ | 1..1 | Reference(nl-core-patient | Group) | Who received medication |
| supportingInformation |
0..* | Reference(Resource | HCIM Dispense | HCIM PharmaceuticalProduct | HCIM DispenseRequest | HCIM AdministrationAgreement | HCIM MedicationAgreement | HCIM MedicationAdministration) | RelatedAgreement / MedicationAgreement / AdministrationAgreement | |
 effective[x] |
Σ | 1..1 | AdministrationDateTime | |
| effectiveDateTime |
dateTime | |||
 effectivePeriod |
Period | |||
| performer |
Σ | 0..* | BackboneElement | Administrator |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor |
Σ | 1..1 | Reference(nl-core-practitioner | nl-core-patient | nl-core-relatedperson | Device) | Individual who was performing |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| onBehalfOf |
0..1 | Reference(nl-core-organization) | Organization organization was acting for | |
| notGiven |
?!Σ | 0..1 | boolean | True if medication not administered |
| note |
0..* | Annotation | Comment | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministrationStatushttp://hl7.org/fhir/ValueSet/medication-admin-status|3.0.2From the FHIR Standard | |
| MedicationAdministration.category | preferred | MedicationAdministrationCategoryhttp://hl7.org/fhir/ValueSet/medication-admin-category|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-2 | error | MedicationAdministration | Reason not given is only permitted if NotGiven is true : reasonNotGiven.empty() or notGiven = true | |
| mad-3 | error | MedicationAdministration | Reason given is only permitted if NotGiven is false : reasonCode.empty() or notGiven.empty() or notGiven = 'false' |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
C | 0..* | MedicationAdministration | MedicationAdministration Constraints: mad-2, mad-3 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:agreedDateTime |
0..* | dateTime | AgreedDateTime URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime | |||||
| extension:doubleCheckPerformed |
0..1 | boolean | DoubleCheckPerformed URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed | |||||
| extension:medicationTreatment |
0..1 | Identifier | Medicational Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |||||
| extension:deviatingAdministration |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:deviation |
0..* | Extension | Extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "deviation" | |||||
| Slices for value[x] |
0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueBoolean |
0..1 | boolean | Value of extension | |||||
| extension:reasonForDeviation |
0..* | Extension | Extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "reasonForDeviation" | |||||
| Slices for value[x] |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Value of extension | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | External identifier | |||||
| definition |
Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | MedicationAdministrationStatus Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:orderStatus |
0..1 | CodeableConcept | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |||||
| value |
0..1 | code | Primitive value for code | |||||
| category |
1..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministrationCategory (preferred): A coded concept describing where the medication administered is expected to occur | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
| coding:MedicationAdministrationCode |
Σ | 0..* | Coding | MedicationAdministrationCode | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 18629005 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| Slices for medication[x] |
Σ | 1..1 | Reference() | What was administered Slice: Unordered, Closed by type:$this | ||||
| medication[x]:medicationReference |
Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AdministrationProduct | ||||
| subject |
Σ | 1..1 | Reference(nl-core-patient | Group) | Who received medication | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| supportingInformation |
0..* | Reference(Resource | HCIM Dispense | HCIM PharmaceuticalProduct | HCIM DispenseRequest | HCIM AdministrationAgreement | HCIM MedicationAgreement | HCIM MedicationAdministration) | RelatedAgreement / MedicationAgreement / AdministrationAgreement | |||||
| effective[x] |
Σ | 1..1 | AdministrationDateTime | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| performer |
Σ | 0..* | BackboneElement | Administrator | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| actor |
Σ | 1..1 | Reference(nl-core-practitioner | nl-core-patient | nl-core-relatedperson | Device) | Individual who was performing | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| onBehalfOf |
0..1 | Reference(nl-core-organization) | Organization organization was acting for | |||||
| notGiven |
?!Σ | 0..1 | boolean | True if medication not administered | ||||
| reasonNotGiven |
C | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMED CT Reason Medication Not Given Codes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | ||||
| reasonCode |
C | 0..* | CodeableConcept | Reason administration performed Binding: Reason Medication Given Codes (example): A set of codes indicating the reason why the MedicationAdministration was made. | ||||
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or Observation that supports why the medication was administered | |||||
| prescription |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| note |
0..* | Annotation | Comment | |||||
| dosage |
C | 0..1 | BackboneElement | Details of how medication was taken Constraints: mad-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site |
0..1 | CodeableConcept | Body site administered to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
1..1 | CodeableConcept | RouteOfAdministration Binding: MedicatieToedieningToedieningswegCodelijst (extensible): MedicatieToedieningToedieningswegCodelijst | |||||
| method |
0..1 | CodeableConcept | How drug was administered Binding: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose |
1..1 | SimpleQuantity | AdministeredAmount Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | |||||
| rate[x] |
0..1 | AdministeringSpeed | ||||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| MedicationAdministration.language | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages|3.0.2From the FHIR Standard
| ||||
| MedicationAdministration.status | required | MedicationAdministrationStatushttp://hl7.org/fhir/ValueSet/medication-admin-status|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.category | preferred | MedicationAdministrationCategoryhttp://hl7.org/fhir/ValueSet/medication-admin-category|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.reasonNotGiven | example | SNOMED CT Reason Medication Not Given Codeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.reasonCode | example | Reason Medication Given Codeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.dosage.site | example | SNOMED CT Anatomical Structure for Administration Site Codeshttp://hl7.org/fhir/ValueSet/approach-site-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.dosage.route | extensible | MedicatieToedieningToedieningswegCodelijst(a valid code from urn:oid:2.16.840.1.113883.2.4.4.9)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.2--20171231000000From this IG | ||||
| MedicationAdministration.dosage.method | example | SNOMED CT Administration Method Codeshttp://hl7.org/fhir/ValueSet/administration-method-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.dosage.dose | required | GstdTabel902(a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
| mad-2 | error | MedicationAdministration | Reason not given is only permitted if NotGiven is true : reasonNotGiven.empty() or notGiven = true | |
| mad-3 | error | MedicationAdministration | Reason given is only permitted if NotGiven is false : reasonCode.empty() or notGiven.empty() or notGiven = 'false' |
This structure is derived from MedicationAdministration
Summary
Mandatory: 1 element(2 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
- HCIM PharmaceuticalProduct (http://nictiz.nl/fhir/StructureDefinition/zib-Product)
- nl-core-patient (http://fhir.nl/fhir/StructureDefinition/nl-core-patient)
- HCIM Dispense (http://nictiz.nl/fhir/StructureDefinition/zib-Dispense)
- HCIM DispenseRequest (http://nictiz.nl/fhir/StructureDefinition/zib-DispenseRequest)
- HCIM AdministrationAgreement (http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement)
- HCIM MedicationAgreement (http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement)
- HCIM MedicationAdministration (http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration)
- nl-core-practitioner (http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner)
- nl-core-relatedperson (http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson)
- nl-core-organization (http://fhir.nl/fhir/StructureDefinition/nl-core-organization)
Extensions
This structure refers to these extensions:
- http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime
- http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed
- http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
- http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration
- http://nictiz.nl/fhir/StructureDefinition/code-specification
- http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of MedicationAdministration.category.coding
Differential View
This structure is derived from MedicationAdministration
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.extension:deviatingAdministration.extension:reasonForDeviation | extensible | MedicatieToedieningRedenVanAfwijkenCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.3--20171231000000From this IG | |
| MedicationAdministration.dosage.route | extensible | MedicatieToedieningToedieningswegCodelijst(a valid code from urn:oid:2.16.840.1.113883.2.4.4.9)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.2--20171231000000From this IG | |
| MedicationAdministration.dosage.dose | required | GstdTabel902(a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453From this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationAdministration |
C | 0..* | MedicationAdministration | MedicationAdministration Constraints: mad-2, mad-3 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:agreedDateTime |
0..* | dateTime | AgreedDateTime URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime | |
| extension:doubleCheckPerformed |
0..1 | boolean | DoubleCheckPerformed URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed | |
| extension:medicationTreatment |
0..1 | Identifier | Medicational Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |
| extension:deviatingAdministration |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:deviation |
0..* | Extension | Extension | |
| url |
1..1 | uri | "deviation" | |
| Slices for value[x] |
0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueBoolean |
0..1 | boolean | Value of extension | |
| extension:reasonForDeviation |
0..* | Extension | Extension | |
| url |
1..1 | uri | "reasonForDeviation" | |
| Slices for value[x] |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Value of extension | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
0..* | Identifier | External identifier | |
| status |
?!Σ | 1..1 | code | MedicationAdministrationStatus Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:orderStatus |
0..1 | CodeableConcept | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
| category |
1..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministrationCategory (preferred): A coded concept describing where the medication administered is expected to occur | |
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:MedicationAdministrationCode |
Σ | 0..* | Coding | MedicationAdministrationCode |
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 18629005 |
| display |
Σ | 0..1 | string | Representation defined by the system |
| Slices for medication[x] |
Σ | 1..1 | Reference() | What was administered Slice: Unordered, Closed by type:$this |
| medication[x]:medicationReference |
Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AdministrationProduct |
| subject |
Σ | 1..1 | Reference(nl-core-patient | Group) | Who received medication |
| supportingInformation |
0..* | Reference(Resource | HCIM Dispense | HCIM PharmaceuticalProduct | HCIM DispenseRequest | HCIM AdministrationAgreement | HCIM MedicationAgreement | HCIM MedicationAdministration) | RelatedAgreement / MedicationAgreement / AdministrationAgreement | |
| effective[x] |
Σ | 1..1 | AdministrationDateTime | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
Σ | 0..* | BackboneElement | Administrator |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor |
Σ | 1..1 | Reference(nl-core-practitioner | nl-core-patient | nl-core-relatedperson | Device) | Individual who was performing |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| onBehalfOf |
0..1 | Reference(nl-core-organization) | Organization organization was acting for | |
| notGiven |
?!Σ | 0..1 | boolean | True if medication not administered |
| note |
0..* | Annotation | Comment | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministrationStatushttp://hl7.org/fhir/ValueSet/medication-admin-status|3.0.2From the FHIR Standard | |
| MedicationAdministration.category | preferred | MedicationAdministrationCategoryhttp://hl7.org/fhir/ValueSet/medication-admin-category|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-2 | error | MedicationAdministration | Reason not given is only permitted if NotGiven is true : reasonNotGiven.empty() or notGiven = true | |
| mad-3 | error | MedicationAdministration | Reason given is only permitted if NotGiven is false : reasonCode.empty() or notGiven.empty() or notGiven = 'false' |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
C | 0..* | MedicationAdministration | MedicationAdministration Constraints: mad-2, mad-3 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:agreedDateTime |
0..* | dateTime | AgreedDateTime URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime | |||||
| extension:doubleCheckPerformed |
0..1 | boolean | DoubleCheckPerformed URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed | |||||
| extension:medicationTreatment |
0..1 | Identifier | Medicational Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |||||
| extension:deviatingAdministration |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:deviation |
0..* | Extension | Extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "deviation" | |||||
| Slices for value[x] |
0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueBoolean |
0..1 | boolean | Value of extension | |||||
| extension:reasonForDeviation |
0..* | Extension | Extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "reasonForDeviation" | |||||
| Slices for value[x] |
0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Value of extension | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | External identifier | |||||
| definition |
Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | MedicationAdministrationStatus Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:orderStatus |
0..1 | CodeableConcept | OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |||||
| value |
0..1 | code | Primitive value for code | |||||
| category |
1..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministrationCategory (preferred): A coded concept describing where the medication administered is expected to occur | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
| coding:MedicationAdministrationCode |
Σ | 0..* | Coding | MedicationAdministrationCode | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 18629005 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| Slices for medication[x] |
Σ | 1..1 | Reference() | What was administered Slice: Unordered, Closed by type:$this | ||||
| medication[x]:medicationReference |
Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AdministrationProduct | ||||
| subject |
Σ | 1..1 | Reference(nl-core-patient | Group) | Who received medication | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| supportingInformation |
0..* | Reference(Resource | HCIM Dispense | HCIM PharmaceuticalProduct | HCIM DispenseRequest | HCIM AdministrationAgreement | HCIM MedicationAgreement | HCIM MedicationAdministration) | RelatedAgreement / MedicationAgreement / AdministrationAgreement | |||||
| effective[x] |
Σ | 1..1 | AdministrationDateTime | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| performer |
Σ | 0..* | BackboneElement | Administrator | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| actor |
Σ | 1..1 | Reference(nl-core-practitioner | nl-core-patient | nl-core-relatedperson | Device) | Individual who was performing | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| onBehalfOf |
0..1 | Reference(nl-core-organization) | Organization organization was acting for | |||||
| notGiven |
?!Σ | 0..1 | boolean | True if medication not administered | ||||
| reasonNotGiven |
C | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMED CT Reason Medication Not Given Codes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | ||||
| reasonCode |
C | 0..* | CodeableConcept | Reason administration performed Binding: Reason Medication Given Codes (example): A set of codes indicating the reason why the MedicationAdministration was made. | ||||
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or Observation that supports why the medication was administered | |||||
| prescription |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| note |
0..* | Annotation | Comment | |||||
| dosage |
C | 0..1 | BackboneElement | Details of how medication was taken Constraints: mad-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site |
0..1 | CodeableConcept | Body site administered to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
1..1 | CodeableConcept | RouteOfAdministration Binding: MedicatieToedieningToedieningswegCodelijst (extensible): MedicatieToedieningToedieningswegCodelijst | |||||
| method |
0..1 | CodeableConcept | How drug was administered Binding: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose |
1..1 | SimpleQuantity | AdministeredAmount Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | |||||
| rate[x] |
0..1 | AdministeringSpeed | ||||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| MedicationAdministration.language | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages|3.0.2From the FHIR Standard
| ||||
| MedicationAdministration.status | required | MedicationAdministrationStatushttp://hl7.org/fhir/ValueSet/medication-admin-status|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.category | preferred | MedicationAdministrationCategoryhttp://hl7.org/fhir/ValueSet/medication-admin-category|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.reasonNotGiven | example | SNOMED CT Reason Medication Not Given Codeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.reasonCode | example | Reason Medication Given Codeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.dosage.site | example | SNOMED CT Anatomical Structure for Administration Site Codeshttp://hl7.org/fhir/ValueSet/approach-site-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.dosage.route | extensible | MedicatieToedieningToedieningswegCodelijst(a valid code from urn:oid:2.16.840.1.113883.2.4.4.9)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.13.2--20171231000000From this IG | ||||
| MedicationAdministration.dosage.method | example | SNOMED CT Administration Method Codeshttp://hl7.org/fhir/ValueSet/administration-method-codes|3.0.2From the FHIR Standard | ||||
| MedicationAdministration.dosage.dose | required | GstdTabel902(a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
| mad-2 | error | MedicationAdministration | Reason not given is only permitted if NotGiven is true : reasonNotGiven.empty() or notGiven = true | |
| mad-3 | error | MedicationAdministration | Reason given is only permitted if NotGiven is false : reasonCode.empty() or notGiven.empty() or notGiven = 'false' |
This structure is derived from MedicationAdministration
Summary
Mandatory: 1 element(2 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
- HCIM PharmaceuticalProduct (http://nictiz.nl/fhir/StructureDefinition/zib-Product)
- nl-core-patient (http://fhir.nl/fhir/StructureDefinition/nl-core-patient)
- HCIM Dispense (http://nictiz.nl/fhir/StructureDefinition/zib-Dispense)
- HCIM DispenseRequest (http://nictiz.nl/fhir/StructureDefinition/zib-DispenseRequest)
- HCIM AdministrationAgreement (http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement)
- HCIM MedicationAgreement (http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement)
- HCIM MedicationAdministration (http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration)
- nl-core-practitioner (http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner)
- nl-core-relatedperson (http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson)
- nl-core-organization (http://fhir.nl/fhir/StructureDefinition/nl-core-organization)
Extensions
This structure refers to these extensions:
- http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-AgreedDateTime
- http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DoubleCheckPerformed
- http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment
- http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAdministration-DeviatingAdministration
- http://nictiz.nl/fhir/StructureDefinition/code-specification
- http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of MedicationAdministration.category.coding
Other representations of profile: CSV, Excel, Schematron