FHIR IG Statistics: StructureDefinition/HdBe-MedicationUse2

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "HdBe-MedicationUse2",
  "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-MedicationUse2",
  "name": "HdBeMedicationUse2",
  "title": "HdBe-MedicationUse2",
  "status": "draft",
  "date": "2022-10-17T09:09:13.9562003+00:00",
  "publisher": "Healthdata.be (Sciensano)",
  "contact": [
    {
      "name": "Service portal – healthdata.be",
      "telecom": [
        {
          "system": "url",
          "value": "https://sciensano.service-now.com/sp",
          "use": "work"
        }
      ]
    }
  ],
  "description": "MedicationUse2 is a statement on the historic, current or intended use of a certain medicine.",
  "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "zib-medicationuse2-v1.1.1-2020EN",
      "uri": "https://zibs.nl/wiki/MedicationUse2-v1.1.1(2020EN)",
      "name": "zib MedicationUse2-v1.1.1(2020EN)"
    },
    {
      "identity": "HdBe-MedicationUse2",
      "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MedicationUse2",
      "name": "HdBe logical model MedicationUse2"
    },
    {
      "identity": "HdBe-InstructionsForUse",
      "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-InstructionsForUse",
      "name": "HdBe logical model InstructionsForUse"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "MedicationStatement",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "MedicationStatement",
        "path": "MedicationStatement",
        "short": "MedicationUse",
        "comment": "When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered:\rMedicationStatement.status + MedicationStatement.wasNotTaken\r* Status=Active + NotTaken=T = Not currently taking\r* Status=Completed + NotTaken=T = Not taken in the past\r* Status=Intended + NotTaken=T = No intention of taking\r* Status=Active + NotTaken=F = Taking, but not as prescribed\r* Status=Active + NotTaken=F = Taking\r* Status=Intended +NotTaken= F = Will be taking (not started)\r* Status=Completed + NotTaken=F = Taken in past\r* Status=In Error + NotTaken=N/A = In Error.",
        "alias": [
          "MedicatieGebruik"
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.21338",
            "comment": "MedicationUse"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2"
          }
        ]
      },
      {
        "id": "MedicationStatement.extension:renderedDosageInstruction",
        "path": "MedicationStatement.extension",
        "sliceName": "renderedDosageInstruction",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction"
            ]
          }
        ]
      },
      {
        "id": "MedicationStatement.extension:renderedDosageInstruction.value[x]",
        "path": "MedicationStatement.extension.value[x]",
        "mapping": [
          {
            "identity": "HdBe-InstructionsForUse",
            "map": "InstructionsForUse.Description"
          }
        ]
      },
      {
        "id": "MedicationStatement.extension:prescriber",
        "path": "MedicationStatement.extension",
        "sliceName": "prescriber",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-MedicationUse2.Prescriber"
            ]
          }
        ]
      },
      {
        "id": "MedicationStatement.extension:prescriber.value[x]",
        "path": "MedicationStatement.extension.value[x]",
        "mapping": [
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.Prescriber"
          }
        ]
      },
      {
        "id": "MedicationStatement.extension:asAgreedIndicator",
        "path": "MedicationStatement.extension",
        "sliceName": "asAgreedIndicator",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-MedicationUse2.AsAgreedIndicator"
            ]
          }
        ]
      },
      {
        "id": "MedicationStatement.extension:asAgreedIndicator.value[x]",
        "path": "MedicationStatement.extension.value[x]",
        "mapping": [
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.AsAgreedIndicator"
          }
        ]
      },
      {
        "id": "MedicationStatement.modifierExtension:stopType",
        "path": "MedicationStatement.modifierExtension",
        "sliceName": "stopType",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-StopType"
            ]
          }
        ]
      },
      {
        "id": "MedicationStatement.modifierExtension:stopType.value[x]",
        "path": "MedicationStatement.modifierExtension.value[x]",
        "short": "MedicationUseStopType",
        "alias": [
          "MedicatieGebruikStopType"
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.23132",
            "comment": "MedicationUseStopType"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.MedicationUseStopType"
          }
        ]
      },
      {
        "id": "MedicationStatement.modifierExtension:repeatPeriodCyclicalSchedule",
        "path": "MedicationStatement.modifierExtension",
        "sliceName": "repeatPeriodCyclicalSchedule",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule"
            ]
          }
        ]
      },
      {
        "id": "MedicationStatement.modifierExtension:repeatPeriodCyclicalSchedule.value[x]",
        "path": "MedicationStatement.modifierExtension.value[x]",
        "mapping": [
          {
            "identity": "HdBe-InstructionsForUse",
            "map": "InstructionsForUse.RepeatPeriodCyclicalSchedule"
          }
        ]
      },
      {
        "id": "MedicationStatement.status",
        "path": "MedicationStatement.status",
        "short": "UseIndicator / MedicationUseStopType / PeriodOfUse",
        "definition": "Status may contain information on the stop type, the manner in which this medication is discontinued (temporary or definitive) and if the medicine is used or not.",
        "comment": "This element is mapped to the CBB concept UseIndicator and implicitly to MedicationUseStopType and PeriodOfUse. Unless a more appropriate status is recorded, the following guidance applies:\r\n\r\n* When MedicationUseStopType has no value and UseIndicator is _true_, `.status` will usually be set to _active_.\r\n* When UseIndicator is _false_, `.status` will be set to _not-taken_.\r\n* When MedicationUseStopType is _14803004_, `.status` will usually be set to _on-hold_.\r\n* When MedicationUseStopType is _255545003_, `.status` will usually be set to _stopped_.\r\n* When PeriodOfUse start date is in the past and PeriodOfUse end date is present and in the future, `.status` will usually be set to _active_.\r\n* When PeriodOfUse end date has a value and in the past, `.status` will usually be set to _completed_.\r\n* When PeriodOfUse duration and start date are known, the end date can be deducted and the previous rules apply. \r\n* When a system is unable to infer the status, `.status` will be set to _unknown_. The _unknown_ code is not to be used to convey other statuses. The _unknown_ code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the MedicationStatement.",
        "alias": [
          "MedicatieGebruikStopType",
          "GebruikIndicator",
          "Gebruiksperiode"
        ],
        "binding": {
          "strength": "required",
          "description": "Use ConceptMap 'MedicationStopType-to-MedicationStatementStatus' to translate CBB terminology to profile terminology in ValueSet 'Medication Status Codes'.",
          "valueSet": "http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1",
          "_valueSet": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueCanonical": "https://fhir.healthdata.be/ConceptMap/MedicationStopType-to-MedicationStatementStatus"
              }
            ]
          }
        },
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22399",
            "comment": "UseIndicator"
          },
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.23132",
            "comment": "MedicationUseStopType (implicit, main mapping is on the modifier extension ext-StopType)"
          },
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22663",
            "comment": "PeriodOfUse (implicit, main mapping is on `.effective[x]:effectivePeriod` and extension ext-TimeInterval.Duration)"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.UseIndicator"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.MedicationUseStopType",
            "comment": "implicit, main mapping is on the modifier extension ext-StopType"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.PeriodOfUse",
            "comment": "implicit, main mapping is on `.effective[x]:effectivePeriod` and extension ext-TimeInterval.Duration"
          }
        ]
      },
      {
        "id": "MedicationStatement.statusReason",
        "path": "MedicationStatement.statusReason",
        "short": "ReasonForChangeOrDiscontinuationOfUse",
        "definition": "Reason for changing or discontinuing use of medication.",
        "alias": [
          "RedenWijzigenOfStoppenGebruik"
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.healthdata.be/ValueSet/MedicationReason"
        },
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22493",
            "comment": "ReasonForChangeOrDiscontinuationOfUse"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.ReasonForChangeOrDiscontinuationOfUse"
          }
        ]
      },
      {
        "id": "MedicationStatement.category",
        "path": "MedicationStatement.category",
        "min": 1,
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "422979000"
            }
          ]
        }
      },
      {
        "id": "MedicationStatement.medication[x]",
        "path": "MedicationStatement.medication[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationStatement.medication[x]:medicationReference",
        "path": "MedicationStatement.medication[x]",
        "sliceName": "medicationReference",
        "short": "ProductUsed",
        "definition": "The product used. This is usually medication. Food, blood products, aids and bandages do not strictly fall under the category of medication, but can be recorded as well.\r\nIn principle, this will be the prescribed product, but the product used may differ from the prescribed product.",
        "alias": [
          "Gebruiksproduct"
        ],
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Medication",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-PharmaceuticalProduct"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.21339",
            "comment": "ProductUsed"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.ProductUsed"
          }
        ]
      },
      {
        "id": "MedicationStatement.subject",
        "path": "MedicationStatement.subject",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Group",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient"
            ]
          }
        ]
      },
      {
        "id": "MedicationStatement.effective[x]",
        "path": "MedicationStatement.effective[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationStatement.effective[x]:effectivePeriod",
        "path": "MedicationStatement.effective[x]",
        "sliceName": "effectivePeriod",
        "short": "PeriodOfUse",
        "definition": "Medication use can be recorded for a certain moment or over a certain period. Thus, medication use can be recorded multiple times during the use of medication. The usage period is the period or moment over which the data is recorded.\n**Start date:** This is the time at which the agreement was to take effect (or took effect or will take effect). \n**End date:** The time at which the period of use ends (or ended or will end). To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date.",
        "alias": [
          "Gebruiksperiode"
        ],
        "type": [
          {
            "code": "Period",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/HdBe-TimeInterval"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22663",
            "comment": "PeriodOfUse"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.PeriodOfUse"
          }
        ]
      },
      {
        "id": "MedicationStatement.dateAsserted",
        "path": "MedicationStatement.dateAsserted",
        "short": "MedicationUseDateTime",
        "definition": "Date on which this use is entered.",
        "alias": [
          "MedicatieGebruikDatumTijd"
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22398",
            "comment": "MedicationUseDateTime"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.MedicationUseDateTime"
          }
        ]
      },
      {
        "id": "MedicationStatement.reasonCode",
        "path": "MedicationStatement.reasonCode",
        "slicing": {
          "discriminator": [
            {
              "type": "exists",
              "path": "text"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationStatement.reasonCode:reasonForUse",
        "path": "MedicationStatement.reasonCode",
        "sliceName": "reasonForUse",
        "max": "1"
      },
      {
        "id": "MedicationStatement.reasonCode:reasonForUse.text",
        "path": "MedicationStatement.reasonCode.text",
        "short": "ReasonForUse",
        "definition": "The reason for using the medication, particularly in self-care medicine purchased by the patient themselves.",
        "alias": [
          "RedenGebruik"
        ],
        "min": 1,
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22491",
            "comment": "ReasonForUse"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.ReasonForUse"
          }
        ]
      },
      {
        "id": "MedicationStatement.note",
        "path": "MedicationStatement.note",
        "max": "1"
      },
      {
        "id": "MedicationStatement.note.text",
        "path": "MedicationStatement.note.text",
        "short": "Comment",
        "definition": "Comments on the medication use.",
        "alias": [
          "Toelichting"
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.21624",
            "comment": "Comment"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.Comment"
          }
        ]
      },
      {
        "id": "MedicationStatement.dosage",
        "path": "MedicationStatement.dosage",
        "short": "DosingInstructions / InstructionsForUse",
        "definition": "Instructions for the use of the medication, e.g. dose and route of administration. In the event of medication use, this is the pattern of use established by the patient or which the patient followed.",
        "alias": [
          "Gebruiksinstructie"
        ],
        "type": [
          {
            "code": "Dosage",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/HdBe-InstructionsForUse.DosageInstructions"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-medicationuse2-v1.1.1-2020EN",
            "map": "NL-CM:9.11.22504",
            "comment": "InstructionsForUse"
          },
          {
            "identity": "HdBe-MedicationUse2",
            "map": "MedicationUse2.InstructionsForUse"
          }
        ]
      }
    ]
  }
}