{
  "resourceType": "StructureDefinition",
  "id": "ext-StopType",
  "url": "https://fhir.healthdata.be/StructureDefinition/ext-StopType",
  "name": "ExtStopType",
  "title": "ext StopType",
  "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": "An extension to provide the manner in which medication is discontinued (temporary or definitive).",
  "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",
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "fhirpath",
      "expression": "MedicationRequest"
    },
    {
      "type": "fhirpath",
      "expression": "MedicationDispense"
    },
    {
      "type": "fhirpath",
      "expression": "MedicationStatement"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Optional Extensions Element",
        "definition": "This StopType ModifierExtension works differently than the `.status` element of resources because it has a different meaning. The `.status` element represents the status of the resource at the moment of exchanging the resource. This means that over the lifetime of a resource, the status may change (and is very much related to use period). That – in itself – makes mapping StopType (which may never change in an instance) to status not suitable.\r\n\r\nFor example: suppose you want the patient to stop taking medication definitively three days from today. This is a stop medication agreement with a StopType of _definitive_. However today, tomorrow and the day after tomorrow the `.status` of this medication agreement is _active_ and only after the end date of the usage period the `status` should be _stopped_. Status and StopType are simply not the same thing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This element is labeled as a modifier because the stoptype contain codes that mark the resource as no longer active.",
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "comment": "Note that FHIR strings may not exceed 1MB in size",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-StopType",
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "StopType",
        "definition": "Stop type, the manner in which this medication is discontinued (temporary or definitive).",
        "comment": "MedicationAgreementStopType, AdministrationAgreementStopType and MedicationUseStopType all have a bound ValueSet that contain the exact same StopType values. These are represented in the CBB with the same Valueset. This MedicationStopType is used to bind  to this extension and reusing this extension for all three concepts.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "binding": {
          "strength": "required",
          "description": "StopType values, based on the valueset named MedicatioStopType, which are applicable for StopType in MedicationAgreement, AdministrationAgreement and MedicationUse.",
          "valueSet": "https://fhir.healthdata.be/ValueSet/MedicationStopType"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "definition": "This StopType ModifierExtension works differently than the `.status` element of resources because it has a different meaning. The `.status` element represents the status of the resource at the moment of exchanging the resource. This means that over the lifetime of a resource, the status may change (and is very much related to use period). That – in itself – makes mapping StopType (which may never change in an instance) to status not suitable.\r\n\r\nFor example: suppose you want the patient to stop taking medication definitively three days from today. This is a stop medication agreement with a StopType of _definitive_. However today, tomorrow and the day after tomorrow the `.status` of this medication agreement is _active_ and only after the end date of the usage period the `status` should be _stopped_. Status and StopType are simply not the same thing.",
        "max": "1",
        "isModifier": true,
        "isModifierReason": "This element is labeled as a modifier because the stoptype contain codes that mark the resource as no longer active."
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-StopType"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "StopType",
        "definition": "Stop type, the manner in which this medication is discontinued (temporary or definitive).",
        "comment": "MedicationAgreementStopType, AdministrationAgreementStopType and MedicationUseStopType all have a bound ValueSet that contain the exact same StopType values. These are represented in the CBB with the same Valueset. This MedicationStopType is used to bind  to this extension and reusing this extension for all three concepts.",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "required",
          "description": "StopType values, based on the valueset named MedicatioStopType, which are applicable for StopType in MedicationAgreement, AdministrationAgreement and MedicationUse.",
          "valueSet": "https://fhir.healthdata.be/ValueSet/MedicationStopType"
        }
      }
    ]
  }
}